|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.zkoss.zk.ui.AbstractComponent
org.zkoss.zk.ui.HtmlBasedComponent
org.zkoss.zul.impl.XulElement
org.zkoss.zul.Audio
public class Audio
An audio clip.
An extension to XUL.
Nested Class Summary | |
---|---|
protected class |
Audio.ExtraCtrl
A utility class to implement AbstractComponent.getExtraCtrl() . |
Nested classes/interfaces inherited from class org.zkoss.zk.ui.AbstractComponent |
---|
AbstractComponent.Children |
Field Summary | |
---|---|
protected java.lang.String |
_src
|
Fields inherited from class org.zkoss.zk.ui.HtmlBasedComponent |
---|
_height, _left, _top, _width, _zclass |
Fields inherited from class org.zkoss.zk.ui.AbstractComponent |
---|
_visible |
Fields inherited from interface org.zkoss.zk.ui.Component |
---|
APPLICATION_SCOPE, COMPONENT_SCOPE, DESKTOP_SCOPE, PAGE_SCOPE, REQUEST_SCOPE, SESSION_SCOPE, SPACE_SCOPE |
Fields inherited from interface org.zkoss.zk.ui.sys.ComponentCtrl |
---|
CE_BUSY_IGNORE, CE_DUPLICATE_IGNORE, CE_IMPORTANT, CE_NON_DEFERRABLE, CE_REPEAT_IGNORE |
Constructor Summary | |
---|---|
Audio()
|
|
Audio(java.lang.String src)
|
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. |
boolean |
isAutostart()
Returns whether to auto start playing the audio. |
protected boolean |
isChildable()
Default: not childable. |
boolean |
isLoop()
Returns whether to play the audio repeatedly. |
protected java.lang.Object |
newExtraCtrl()
Used by AbstractComponent.getExtraCtrl() to create a client control. |
void |
pause()
Pauses the audio at the cient. |
void |
play()
Plays the audio at the client. |
protected void |
renderProperties(ContentRenderer renderer)
Renders the content of this component, excluding the enclosing tags and children. |
void |
setAlign(java.lang.String align)
Sets the alignment: one of top, texttop, middle, absmiddle, bottom, absbottom, baseline, left, right and center. |
void |
setAutostart(boolean autostart)
Sets whether to auto start playing the audio. |
void |
setBorder(java.lang.String border)
Sets the width of the border. |
void |
setContent(Audio audio)
Sets the content directly. |
void |
setLoop(boolean loop)
Sets whether to play the audio repeatedly. |
void |
setSrc(java.lang.String src)
Sets the src. |
void |
stop()
Stops the audio at the cient. |
Methods inherited from class org.zkoss.zul.impl.XulElement |
---|
getAction, getContext, getCtrlKeys, getPopup, getTooltip, setAction, setContext, setContext, setCtrlKeys, setPopup, setPopup, setTooltip, setTooltip |
Methods inherited from class org.zkoss.zk.ui.HtmlBasedComponent |
---|
focus, getDraggable, getDroppable, getHeight, getHflex, getLeft, getSclass, getStyle, getTooltiptext, getTop, getVflex, getWidth, getZclass, getZindex, getZIndex, service, setClass, setDraggable, setDroppable, setFocus, setHeight, setHflex, setLeft, setSclass, setStyle, setTooltiptext, setTop, setVflex, setWidth, setZclass, setZindex, setZIndex |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
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.ext.Scope |
---|
addScopeListener, getAttribute, hasAttribute, removeAttribute, removeScopeListener, setAttribute |
Field Detail |
---|
protected java.lang.String _src
Constructor Detail |
---|
public Audio()
public Audio(java.lang.String src)
Method Detail |
---|
public void play()
play
in interface Audio
public void stop()
stop
in interface Audio
public void pause()
pause
in interface Audio
public java.lang.String getAlign()
Default: null (use browser default).
getAlign
in interface Audio
public void setAlign(java.lang.String align) throws WrongValueException
setAlign
in interface Audio
WrongValueException
public java.lang.String getBorder()
Default: null (use browser default).
getBorder
in interface Audio
public void setBorder(java.lang.String border) throws WrongValueException
setBorder
in interface Audio
WrongValueException
public java.lang.String getSrc()
Default: null.
getSrc
in interface Audio
public void setSrc(java.lang.String 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.
setSrc
in interface Audio
setContent(org.zkoss.sound.Audio)
public boolean isAutostart()
Default: false;
public void setAutostart(boolean autostart)
public boolean isLoop()
Default: false;
public void setLoop(boolean loop)
public void setContent(Audio audio)
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.
setContent
in interface Audio
audio
- the audio to display.setSrc(java.lang.String)
public Audio getContent()
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)
.
getContent
in interface Audio
protected void renderProperties(ContentRenderer renderer) throws java.io.IOException
HtmlBasedComponent
See also Render Special Properties
renderProperties
in class XulElement
java.io.IOException
protected boolean isChildable()
isChildable
in class AbstractComponent
protected java.lang.Object newExtraCtrl()
HtmlBasedComponent
AbstractComponent.getExtraCtrl()
to create a client control.
It is used only by component developers.
Defaut: creates an instance of HtmlBasedComponent.ExtraCtrl
.
newExtraCtrl
in class HtmlBasedComponent
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |