Package io.wcm.handler.commons.dom
Class Audio
- java.lang.Object
-
- org.jdom2.Content
-
- org.jdom2.Element
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Cloneable
,org.jdom2.NamespaceAware
,org.jdom2.Parent
@ProviderType public final class Audio extends AbstractNonSelfClosingHtmlElement
Html audio (audio) element.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description Audio()
Initializes html element.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Audio
addCssClass(java.lang.String value)
Html "class" attribute.java.lang.String
getPreload()
Html "preload" attribute.java.lang.String
getSrc()
Html "src" attribute.boolean
isAutoPlay()
Html "autoplay" attribute.boolean
isControls()
Html "controls" attribute.boolean
isLoop()
Html "loop" attribute.Audio
setAttributeValueAsLong(java.lang.String name, long value)
Sets attribute value as long.Audio
setAutoPlay(boolean value)
Html "autoplay" attribute.Audio
setControls(boolean value)
Html "controls" attribute.Audio
setCssClass(java.lang.String value)
Sets Html "class" attribute - unless you're really sure that you want to replace existing classes, you probably should callHtmlElement.addCssClass(String)
instead.Audio
setData(java.lang.String attributeName, java.lang.String value)
Custom Html5 "data-*" attribute.protected Audio
setEmptyAttributeValueAsBoolean(java.lang.String attributeName, boolean value)
Sets "empty" attribute value as boolean (i.e.Audio
setId(java.lang.String value)
Html "id" attribute.Audio
setLoop(boolean value)
Html "loop" attribute.Audio
setPreload(java.lang.String value)
Html "preload" attribute.Audio
setSrc(java.lang.String value)
Html "src" attribute.Audio
setStyle(java.lang.String styleAttribute, java.lang.String styleValue)
Html "style" attribute.Audio
setStyleString(java.lang.String value)
Html "style" attribute.Audio
setText(java.lang.String text)
Sets the content of the element to be the text given.Audio
setTitle(java.lang.String value)
Html "title" attribute.-
Methods inherited from class io.wcm.handler.commons.dom.HtmlElement
add, getCssClass, getData, getEmptyAttributeValueAsBoolean, getId, getStyle, getStyles, getStyleString, getTitle
-
Methods inherited from class io.wcm.handler.commons.dom.AbstractHtmlElementFactory
create, createAnchor, createAnchor, createAnchor, createAudio, createComment, createDiv, createFigCaption, createFigure, createImage, createImage, createImage, createImage, createImage, createNoScript, createScript, createScript, createSource, createSpan, createSpan, createVideo
-
Methods inherited from class io.wcm.handler.commons.dom.AbstractElement
add, addContent, addContent, addContent, addContent, addContent, getAttributeValueAsInteger, getAttributeValueAsLong, setAttribute, setAttribute, setAttributeValueAsInteger, toString, toStringContentOnly
-
Methods inherited from class org.jdom2.Element
addNamespaceDeclaration, canContainContent, clone, cloneContent, coalesceText, detach, getAdditionalNamespaces, getAttribute, getAttribute, getAttributes, getAttributesSize, getAttributeValue, getAttributeValue, getAttributeValue, getAttributeValue, getChild, getChild, getChildren, getChildren, getChildren, getChildText, getChildText, getChildTextNormalize, getChildTextNormalize, getChildTextTrim, getChildTextTrim, getContent, getContent, getContent, getContentSize, getDescendants, getDescendants, getName, getNamespace, getNamespace, getNamespacePrefix, getNamespacesInherited, getNamespacesInScope, getNamespacesIntroduced, getNamespaceURI, getQualifiedName, getText, getTextNormalize, getTextTrim, getValue, getXMLBaseURI, hasAdditionalNamespaces, hasAttributes, indexOf, isAncestor, isRootElement, removeAttribute, removeAttribute, removeAttribute, removeChild, removeChild, removeChildren, removeChildren, removeContent, removeContent, removeContent, removeContent, removeNamespaceDeclaration, setAttribute, setAttributes, setContent, setContent, setContent, setContent, setName, setNamespace, sortAttributes, sortChildren, sortContent, sortContent
-
Methods inherited from class org.jdom2.Content
equals, getCType, getDocument, getParent, getParentElement, hashCode, setParent
-
-
-
-
Method Detail
-
isAutoPlay
public boolean isAutoPlay()
Html "autoplay" attribute.- Returns:
- Value of attribute
-
setAutoPlay
public Audio setAutoPlay(boolean value)
Html "autoplay" attribute.- Parameters:
value
- Value of attribute- Returns:
- Self reference
-
isControls
public boolean isControls()
Html "controls" attribute.- Returns:
- Value of attribute
-
setControls
public Audio setControls(boolean value)
Html "controls" attribute.- Parameters:
value
- Value of attribute- Returns:
- Self reference
-
isLoop
public boolean isLoop()
Html "loop" attribute.- Returns:
- Value of attribute
-
setLoop
public Audio setLoop(boolean value)
Html "loop" attribute.- Parameters:
value
- Value of attribute- Returns:
- Self reference
-
getPreload
public java.lang.String getPreload()
Html "preload" attribute.- Returns:
- Value of attribute
-
setPreload
public Audio setPreload(java.lang.String value)
Html "preload" attribute.- Parameters:
value
- Value of attribute- Returns:
- Self reference
-
getSrc
public java.lang.String getSrc()
Html "src" attribute.- Returns:
- Value of attribute
-
setSrc
public Audio setSrc(java.lang.String value)
Html "src" attribute.- Parameters:
value
- Value of attribute- Returns:
- Self reference
-
setEmptyAttributeValueAsBoolean
protected Audio setEmptyAttributeValueAsBoolean(java.lang.String attributeName, boolean value)
Description copied from class:HtmlElement
Sets "empty" attribute value as boolean (i.e. for "checked" attribute).- Overrides:
setEmptyAttributeValueAsBoolean
in classHtmlElement
- Parameters:
attributeName
- Attribute namevalue
- Attribute value as boolean- Returns:
- Self reference
-
setId
public Audio setId(java.lang.String value)
Description copied from class:HtmlElement
Html "id" attribute.- Overrides:
setId
in classHtmlElement
- Parameters:
value
- Value of attribute- Returns:
- Self reference
-
setCssClass
public Audio setCssClass(java.lang.String value)
Description copied from class:HtmlElement
Sets Html "class" attribute - unless you're really sure that you want to replace existing classes, you probably should callHtmlElement.addCssClass(String)
instead.- Overrides:
setCssClass
in classHtmlElement
- Parameters:
value
- Value of attribute- Returns:
- Self reference
-
addCssClass
public Audio addCssClass(java.lang.String value)
Description copied from class:HtmlElement
Html "class" attribute. Adds a single, space-separated value while preserving existing ones.- Overrides:
addCssClass
in classHtmlElement
- Parameters:
value
- Value of attribute- Returns:
- Self reference
-
setStyleString
public Audio setStyleString(java.lang.String value)
Description copied from class:HtmlElement
Html "style" attribute.- Overrides:
setStyleString
in classHtmlElement
- Parameters:
value
- Value of attribute with style key/value pairs- Returns:
- Self reference
-
setStyle
public Audio setStyle(java.lang.String styleAttribute, java.lang.String styleValue)
Description copied from class:HtmlElement
Html "style" attribute. Sets single style attribute value.- Overrides:
setStyle
in classHtmlElement
- Parameters:
styleAttribute
- Style attribute namestyleValue
- Style attribute value- Returns:
- Self reference
-
setTitle
public Audio setTitle(java.lang.String value)
Description copied from class:HtmlElement
Html "title" attribute.- Overrides:
setTitle
in classHtmlElement
- Parameters:
value
- Value of attribute- Returns:
- Self reference
-
setData
public Audio setData(java.lang.String attributeName, java.lang.String value)
Description copied from class:HtmlElement
Custom Html5 "data-*" attribute.- Overrides:
setData
in classHtmlElement
- Parameters:
attributeName
- Name of HTML5 data attribute (without the 'data-' prefix).value
- Value of attribute- Returns:
- Self reference
-
setAttributeValueAsLong
public Audio setAttributeValueAsLong(java.lang.String name, long value)
Description copied from class:AbstractElement
Sets attribute value as long.- Overrides:
setAttributeValueAsLong
in classAbstractElement
- Parameters:
name
- Attribute namevalue
- Attribute value as long- Returns:
- Self reference
-
setText
public Audio setText(java.lang.String text)
Description copied from class:AbstractElement
Sets the content of the element to be the text given. All existing text content and non-text context is removed. If this element should have both textual content and nested elements, use
instead. Setting a null text value is equivalent to setting an empty string value.Element.setContent(java.util.Collection<? extends org.jdom2.Content>)
- Overrides:
setText
in classAbstractElement
- Parameters:
text
- new text content for the element- Returns:
- the target element
-
-