Audio (zk 9.6.4 API)

java.lang.Object
- org.zkoss.zk.ui.AbstractComponent
- - org.zkoss.zk.ui.HtmlBasedComponent
  - - org.zkoss.zul.impl.XulElement
    - - org.zkoss.zul.Audio

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, Component, Scope, ComponentCtrl, MediaElement
```
public class Audio
extends XulElement
implements MediaElement
```
An audio clip.
An extension to XUL. Only works for browsers supporting HTML5 audio tag (since ZK 7.0.0).

Author:

tomyeh

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected class Audio.ExtraCtrl
A utility class to implement HtmlBasedComponent.getExtraCtrl().
- Nested classes/interfaces inherited from class org.zkoss.zk.ui.AbstractComponent
  AbstractComponent.Children

Nested Classes
Modifier and Type	Class and Description
`protected class`	`Audio.ExtraCtrl` A utility class to implement `HtmlBasedComponent.getExtraCtrl()`.

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.util.List<java.lang.String>`	`_src`
`static int`	`END` Represent the end state
`static int`	`PAUSE` Represent the pause state
`static int`	`PLAY` Represent the play state
`static int`	`STOP` Represent the stop state

Fields inherited from class org.zkoss.zk.ui.HtmlBasedComponent
_zclass

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
AFTER_CHILD_ADDED, AFTER_CHILD_REMOVED, AFTER_PAGE_ATTACHED, AFTER_PAGE_DETACHED, CE_BUSY_IGNORE, CE_DUPLICATE_IGNORE, CE_IMPORTANT, CE_NON_DEFERRABLE, CE_REPEAT_IGNORE

Constructor Summary

Constructors
Constructor and Description

Audio()

Audio(java.lang.String src)

Constructors
Constructor and Description
`Audio()`
`Audio(java.lang.String src)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`beforeChildAdded(Component child, Component insertBefore)` Default: does nothing.
`Audio`	`getContent()` Returns the content set by `setContent(org.zkoss.sound.Audio)`.
`java.lang.Object`	`getExtraCtrl()` Returns the client control for this component.
`java.lang.String`	`getPreload()` Returns whether and how the audio should be loaded.
`java.util.List<java.lang.String>`	`getSrc()` Returns the src.
`boolean`	`isAutoplay()` Returns whether to auto start playing the audio.
`boolean`	`isAutostart()` Deprecated. As of release 7.0.0, use `isAutoplay()` instead.
`boolean`	`isControls()` Returns whether to display the audio controls.
`boolean`	`isEnded()` Return whether the audio is ended.
`boolean`	`isLoop()` Returns whether to play the audio repeatedly.
`boolean`	`isMuted()` Returns whether to mute the audio.
`boolean`	`isPaused()` Return whether the audio is paused.
`boolean`	`isPlaying()` Return whether the audio is playing.
`boolean`	`isStopped()` Return whether the audio is stopped.
`void`	`pause()` Pauses the audio at the client.
`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`	`service(AuRequest request, boolean everError)` Processes an AU request.
`void`	`setAutoplay(boolean autoplay)` Sets whether to auto start playing the audio.
`void`	`setAutostart(boolean autostart)` Deprecated. As of release 7.0.0, use `setAutoplay(boolean)` instead.
`void`	`setContent(Audio audio)` Sets the content directly.
`void`	`setControls(boolean controls)` Sets whether to display the audio controls.
`void`	`setLoop(boolean loop)` Sets whether to play the audio repeatedly.
`void`	`setMuted(boolean muted)` Sets whether to mute the audio.
`void`	`setPreload(java.lang.String preload)` Sets whether and how the audio should be loaded.
`void`	`setSrc(java.util.List<java.lang.String> src)` Sets the source list.
`void`	`setSrc(java.lang.String src)` Sets the src.
`void`	`stop()` Stops the audio at the client.

Methods inherited from class org.zkoss.zul.impl.XulElement
clone, getContext, getCtrlKeys, getPopup, getPropertyAccess, getTooltip, setContext, setContext, setContextAttributes, setCtrlKeys, setPopup, setPopup, setPopupAttributes, setTooltip, setTooltip, setTooltipAttributes

Methods inherited from class org.zkoss.zk.ui.HtmlBasedComponent
addSclass, evalCSSFlex, focus, getAction, getDraggable, getDroppable, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getStyle, getTabindex, getTabindexInteger, getTooltiptext, getTop, getVflex, getWidth, getZclass, getZindex, getZIndex, removeSclass, removeSclass, setAction, setClass, setDraggable, setDroppable, setFocus, setHeight, setHeight0, setHeightDirectly, setHflex, setHflex0, setHflexDirectly, setLeft, setLeftDirectly, setRenderdefer, setSclass, setStyle, setTabindex, setTabindex, setTooltiptext, setTop, setTopDirectly, setVflex, setVflex0, setVflexDirectly, setWidth, setWidth0, setWidthDirectly, setZclass, setZindex, setZIndex, setZIndexDirectly

Methods inherited from class org.zkoss.zk.ui.AbstractComponent
addAnnotation, addAnnotation, addCallback, addClientEvent, addEventHandler, addEventListener, addEventListener, addForward, addForward, addForward, addForward, addMoved, addRedrawCallback, addScopeListener, addShadowRoot, addShadowRootBefore, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildRemoved, beforeParentChanged, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableBindingAnnotation, disableClientUpdate, enableBindingAnnotation, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAnnotations, getAttribute, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getAutag, getCallback, getChildren, getClientAttribute, getClientDataAttribute, getClientEvents, getDefaultMold, getDefinition, getDesktop, getEventHandler, getEventHandlerNames, getEventListenerMap, getEventListeners, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNextSibling, getPage, getParent, getPreviousSibling, getRedrawCallback, getRoot, getShadowFellowIfAny, getShadowRoots, getShadowVariable, getShadowVariable, getShadowVariable0, getSpaceOwner, getSpecialRendererOutput, getStubonly, getSubBindingAnnotationCount, getTemplate, getTemplateNames, getUuid, getWidgetAttribute, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttribute, hasAttributeOrFellow, hasBindingAnnotation, hasFellow, hasFellow, hasSubBindingAnnotation, insertBefore, invalidate, invalidatePartial, isChildable, isInitialized, isInvalidated, isListenerAvailable, isVisible, onChildAdded, onChildRemoved, onPageAttached, onPageDetached, onWrongValue, query, queryAll, redraw, redrawChildren, removeAttribute, removeAttribute, removeAttribute, removeCallback, removeChild, removeEventListener, removeForward, removeForward, removeRedrawCallback, removeScopeListener, removeShadowRoot, render, render, render, replace, response, response, response, service, sessionDidActivate, sessionWillPassivate, setAttribute, setAttribute, setAttribute, setAuService, setAutag, setClientAttribute, setClientDataAttribute, setDefinition, setDefinition, setId, setMold, setPage, setPageBefore, setParent, setStubonly, setStubonly, setSubBindingAnnotationCount, setTemplate, setVisible, setVisibleDirectly, setWidgetAttribute, setWidgetClass, setWidgetListener, setWidgetOverride, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdateWidgetListener, smartUpdateWidgetOverride, toString, updateByClient, updateSubBindingAnnotationCount, willPassivate, willPassivate, willSerialize, willSerialize

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.zkoss.zk.ui.sys.ComponentCtrl
invalidatePartial

- Field Detail
  - STOP
```
public static final int STOP
```
    Represent the stop state
    
    Since:
    
    9.6.0
    
    See Also:
    
    Constant Field Values
  - PLAY
```
public static final int PLAY
```
    Represent the play state
    
    Since:
    
    9.6.0
    
    See Also:
    
    Constant Field Values
  - PAUSE
```
public static final int PAUSE
```
    Represent the pause state
    
    Since:
    
    9.6.0
    
    See Also:
    
    Constant Field Values
  - END
```
public static final int END
```
    Represent the end state
    
    Since:
    
    9.6.0
    
    See Also:
    
    Constant Field Values
  - _src
```
protected java.util.List<java.lang.String> _src
```
- Constructor Detail
  - Audio
```
public Audio()
```
  - Audio
```
public Audio(java.lang.String src)
```
- Method Detail
  - service
```
public void service(AuRequest request,
                    boolean everError)
```
    Description copied from class: HtmlBasedComponent
    
    Processes an AU request.
    Default: it handles onClick, onDoubleClick, onRightClick onMove, onSize, onZIndex.
    
    Specified by:
    
    service in interface ComponentCtrl
    
    Overrides:
    
    service in class HtmlBasedComponent
    
    everError - whether any error ever occurred before processing this request.
    
    See Also:
    
    AbstractComponent.setAuService(org.zkoss.zk.au.AuService)
  - play
```
public void play()
```
    Plays the audio at the client.
  - stop
```
public void stop()
```
    Stops the audio at the client.
  - pause
```
public void pause()
```
    Pauses the audio at the client.
  - getSrc
```
public java.util.List<java.lang.String> getSrc()
```
    Returns the src.
    Default: [].
  - setSrc
```
public 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)
  - setSrc
```
public void setSrc(java.util.List<java.lang.String> src)
```
    Sets the source list.
    
    Since:
    
    7.0.0
  - isAutostart
```
public boolean isAutostart()
```
    Deprecated. As of release 7.0.0, use isAutoplay() instead.
    
    Returns whether to auto start playing the audio.
    Default: false;
  - setAutostart
```
public void setAutostart(boolean autostart)
```
    Deprecated. As of release 7.0.0, use setAutoplay(boolean) instead.
    
    Sets whether to auto start playing the audio.
  - isAutoplay
```
public boolean isAutoplay()
```
    Returns whether to auto start playing the audio.
    Default: false.
    
    Since:
    
    7.0.0
  - setAutoplay
```
public void setAutoplay(boolean autoplay)
```
    Sets whether to auto start playing the audio.
    
    Since:
    
    7.0.0
  - getPreload
```
public java.lang.String getPreload()
```
    Returns whether and how the audio should be loaded. "none" or "metadata" or "auto" or null
    Default: null.
    
    Since:
    
    7.0.0
  - setPreload
```
public void setPreload(java.lang.String preload)
```
    Sets whether and how the audio should be loaded. Refer to Preload Attribute Description for details.
    
    Parameters:
    
    preload - which could be one of "none", "metadata", "auto".
    
    Since:
    
    7.0.0
  - isControls
```
public boolean isControls()
```
    Returns whether to display the audio controls.
    Default: false.
    
    Since:
    
    7.0.0
  - setControls
```
public void setControls(boolean controls)
```
    Sets whether to display the audio controls.
    
    Since:
    
    7.0.0
  - isLoop
```
public boolean isLoop()
```
    Returns whether to play the audio repeatedly.
    Default: false.
    
    Since:
    
    3.6.1
  - setLoop
```
public void setLoop(boolean loop)
```
    Sets whether to play the audio repeatedly.
    
    Since:
    
    3.6.1
  - isMuted
```
public boolean isMuted()
```
    Returns whether to mute the audio.
    Default: false.
    
    Since:
    
    7.0.0
  - setMuted
```
public void setMuted(boolean muted)
```
    Sets whether to mute the audio.
    
    Since:
    
    7.0.0
  - isPlaying
```
public boolean isPlaying()
```
    Return whether the audio is playing.
    
    Returns:
    
    true if audio is playing;
    
    Since:
    
    9.6.0
  - isPaused
```
public boolean isPaused()
```
    Return whether the audio is paused.
    
    Returns:
    
    true if audio is paused;
    
    Since:
    
    9.6.0
  - isStopped
```
public boolean isStopped()
```
    Return whether the audio is stopped. While the audio is ended, also means it is stopped.
    
    Returns:
    
    true if audio is stopped or ended;
    
    Since:
    
    9.6.0
  - isEnded
```
public boolean isEnded()
```
    Return whether the audio is ended.
    
    Returns:
    
    true if audio is ended;
    
    Since:
    
    9.6.0
  - setContent
```
public 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
```
public 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).
  - renderProperties
```
protected void renderProperties(ContentRenderer renderer)
                         throws java.io.IOException
```
    Description copied from class: HtmlBasedComponent
    
    Renders the content of this component, excluding the enclosing tags and children.
    See also ZK Client-side Reference: Property Rendering
    
    Overrides:
    
    renderProperties in class XulElement
    
    Throws:
    
    java.io.IOException
  - beforeChildAdded
```
public void beforeChildAdded(Component child,
                             Component insertBefore)
```
    Description copied from class: AbstractComponent
    
    Default: does nothing.
    
    Specified by:
    
    beforeChildAdded in interface ComponentCtrl
    
    Overrides:
    
    beforeChildAdded in class AbstractComponent
    
    Parameters:
    
    child - the child to be added (never null).
    
    insertBefore - another child component that the new child will be inserted before it. If null, the new child will be the last child.
    
    See Also:
    
    ComponentCtrl.beforeChildAdded(org.zkoss.zk.ui.Component, org.zkoss.zk.ui.Component)
  - getExtraCtrl
```
public java.lang.Object getExtraCtrl()
```
    Description copied from class: HtmlBasedComponent
    
    Returns the client control for this component. It is used only by component developers.
    Default: creates an instance of HtmlBasedComponent.ExtraCtrl.
    
    Specified by:
    
    getExtraCtrl in interface ComponentCtrl
    
    Overrides:
    
    getExtraCtrl in class HtmlBasedComponent
    
    Returns:
    
    null if no special handling required. If the component requires some special controls, it could return an object that implements one or several interfaces in the org.zkoss.zk.ui.ext.render package. For example, Cropper.
    
    See Also:
    
    ComponentCtrl.getExtraCtrl()

Class Audio

Nested Class Summary

Nested classes/interfaces inherited from class org.zkoss.zk.ui.AbstractComponent

Field Summary

Fields inherited from class org.zkoss.zk.ui.HtmlBasedComponent

Fields inherited from interface org.zkoss.zk.ui.Component

Fields inherited from interface org.zkoss.zk.ui.sys.ComponentCtrl

Constructor Summary

Method Summary

Methods inherited from class org.zkoss.zul.impl.XulElement

Methods inherited from class org.zkoss.zk.ui.HtmlBasedComponent

Methods inherited from class org.zkoss.zk.ui.AbstractComponent

Methods inherited from class java.lang.Object

Methods inherited from interface org.zkoss.zk.ui.sys.ComponentCtrl

Field Detail

STOP

PLAY

PAUSE

END

_src

Constructor Detail

Audio

Audio

Method Detail

service

play

stop

pause

getSrc

setSrc

setSrc

isAutostart

setAutostart

isAutoplay

setAutoplay

getPreload

setPreload

isControls

setControls

isLoop

setLoop

isMuted

setMuted

isPlaying

isPaused

isStopped

isEnded

setContent

getContent

renderProperties

beforeChildAdded

getExtraCtrl