org.zkoss.zul.api
Interface Audio

All Superinterfaces:
java.lang.Cloneable, Component, HtmlBasedComponent, Scope, java.io.Serializable, XulElement
All Known Implementing Classes:
Audio

public interface Audio
extends XulElement

An audio clip.

An extension to XUL.

Since:
3.5.2
Author:
tomyeh

Field Summary
 
Fields inherited from interface org.zkoss.zk.ui.Component
APPLICATION_SCOPE, COMPONENT_SCOPE, DESKTOP_SCOPE, PAGE_SCOPE, REQUEST_SCOPE, SESSION_SCOPE, SPACE_SCOPE
 
Method Summary
 java.lang.String getAlign()
          Returns the alignment.
 java.lang.String getBorder()
          Returns the width of the border.
 Audio getContent()
          Returns the content set by setContent(org.zkoss.sound.Audio).
 java.lang.String getSrc()
          Returns the src.
 void pause()
          Pauses the audio at the cient.
 void play()
          Plays the audio at the client.
 void setAlign(java.lang.String align)
          Sets the alignment: one of top, texttop, middle, absmiddle, bottom, absbottom, baseline, left, right and center.
 void setBorder(java.lang.String border)
          Sets the width of the border.
 void setContent(Audio audio)
          Sets the content directly.
 void setSrc(java.lang.String src)
          Sets the src.
 void stop()
          Stops the audio at the cient.
 
Methods inherited from interface org.zkoss.zul.impl.api.XulElement
getAction, getContext, getCtrlKeys, getPopup, getTooltip, setAction, setContext, setContext, setCtrlKeys, setPopup, setPopup, setTooltip, setTooltip
 
Methods inherited from interface org.zkoss.zk.ui.api.HtmlBasedComponent
focus, getHeight, getLeft, getSclass, getStyle, getTooltiptext, getTop, getWidth, getZclass, getZindex, getZIndex, setDraggable, setDroppable, setFocus, setHeight, setLeft, setSclass, setStyle, setTooltiptext, setTop, setWidth, setZclass, setZindex, setZIndex
 
Methods inherited from interface org.zkoss.zk.ui.Component
addEventListener, addForward, addForward, addForward, addForward, appendChild, applyProperties, clone, containsVariable, detach, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getChildren, getDefinition, getDesktop, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNamespace, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getSpaceOwner, getUuid, getVariable, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttributeOrFellow, hasFellow, hasFellow, insertBefore, invalidate, isInvalidated, isListenerAvailable, isVisible, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, setAttribute, setAttribute, setAuService, setId, setMold, setPage, setPageBefore, setParent, setVariable, setVisible, setWidgetListener, setWidgetOverride, unsetVariable
 
Methods inherited from interface org.zkoss.zk.ui.ext.Scope
addScopeListener, getAttribute, hasAttribute, removeAttribute, removeScopeListener, setAttribute
 

Method Detail

play

void play()
Plays the audio at the client.


stop

void stop()
Stops the audio at the cient.


pause

void pause()
Pauses the audio at the cient.


getAlign

java.lang.String getAlign()
Returns the alignment.

Default: null (use browser default).


setAlign

void setAlign(java.lang.String align)
              throws WrongValueException
Sets the alignment: one of top, texttop, middle, absmiddle, bottom, absbottom, baseline, left, right and center.

Throws:
WrongValueException

getBorder

java.lang.String getBorder()
Returns the width of the border.

Default: null (use browser default).


setBorder

void setBorder(java.lang.String border)
               throws WrongValueException
Sets the width of the border.

Throws:
WrongValueException

getSrc

java.lang.String getSrc()
Returns the src.

Default: null.


setSrc

void setSrc(java.lang.String src)
Sets the src.

Calling this method implies setContent(null). In other words, the last invocation of setSrc(java.lang.String) overrides the previous setContent(org.zkoss.sound.Audio), if any.

See Also:
setContent(org.zkoss.sound.Audio)

setContent

void setContent(Audio audio)
Sets the content directly.

Default: null.

Calling this method implies setSrc(null). In other words, the last invocation of setContent(org.zkoss.sound.Audio) overrides the previous setSrc(java.lang.String), if any.

Parameters:
audio - the audio to display.
See Also:
setSrc(java.lang.String)

getContent

Audio getContent()
Returns the content set by setContent(org.zkoss.sound.Audio).

Note: it won't fetch what is set thru by setSrc(java.lang.String). It simply returns what is passed to setContent(org.zkoss.sound.Audio).



Copyright © 2005-2009 Potix Corporation. All Rights Reserved. SourceForge.net Logo