Package io.wcm.handler.commons.dom
Class Source
- java.lang.Object
-
- org.jdom2.Content
-
- org.jdom2.Element
-
- io.wcm.handler.commons.dom.AbstractElement
-
- io.wcm.handler.commons.dom.AbstractHtmlElementFactory
-
- io.wcm.handler.commons.dom.HtmlElement
-
- io.wcm.handler.commons.dom.Source
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Cloneable
,org.jdom2.NamespaceAware
,org.jdom2.Parent
@ProviderType public class Source extends HtmlElement
Html source (source) element.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description Source()
Initializes html element.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Source
addCssClass(java.lang.String value)
Html "class" attribute.java.lang.String
getMedia()
Html "media" attribute.java.lang.String
getSizes()
Html "sizes" attribute.java.lang.String
getSrc()
Html "src" attribute.java.lang.String
getSrcSet()
Html "srcset" attribute.java.lang.String
getType()
Html "type" attribute.Source
setAttributeValueAsLong(java.lang.String name, long value)
Sets attribute value as long.Source
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.Source
setData(java.lang.String attributeName, java.lang.String value)
Custom Html5 "data-*" attribute.protected Source
setEmptyAttributeValueAsBoolean(java.lang.String attributeName, boolean value)
Sets "empty" attribute value as boolean (i.e.Source
setId(java.lang.String value)
Html "id" attribute.Source
setMedia(java.lang.String value)
Html "media" attribute.Source
setSizes(java.lang.String value)
Html "sizes" attribute.Source
setSrc(java.lang.String value)
Html "src" attribute.Source
setSrcSet(java.lang.String value)
Html "srcset" attribute.Source
setStyle(java.lang.String styleAttribute, java.lang.String styleValue)
Html "style" attribute.Source
setStyleString(java.lang.String value)
Html "style" attribute.Source
setText(java.lang.String text)
Sets the content of the element to be the text given.Source
setTitle(java.lang.String value)
Html "title" attribute.Source
setType(java.lang.String value)
Html "type" 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
-
getMedia
public java.lang.String getMedia()
Html "media" attribute.- Returns:
- Value of attribute
-
setMedia
public Source setMedia(java.lang.String value)
Html "media" attribute.- Parameters:
value
- Value of attribute- Returns:
- Self reference
-
getSrc
public java.lang.String getSrc()
Html "src" attribute.- Returns:
- Value of attribute
-
setSrc
public Source setSrc(java.lang.String value)
Html "src" attribute.- Parameters:
value
- Value of attribute- Returns:
- Self reference
-
getSrcSet
public java.lang.String getSrcSet()
Html "srcset" attribute.- Returns:
- Value of attribute
-
setSrcSet
public Source setSrcSet(java.lang.String value)
Html "srcset" attribute.- Parameters:
value
- Value of attribute- Returns:
- Self reference
-
getSizes
public java.lang.String getSizes()
Html "sizes" attribute.- Returns:
- Value of attribute
-
setSizes
public Source setSizes(java.lang.String value)
Html "sizes" attribute.- Parameters:
value
- Value of attribute- Returns:
- Self reference
-
getType
public java.lang.String getType()
Html "type" attribute.- Returns:
- Value of attribute
-
setType
public Source setType(java.lang.String value)
Html "type" attribute.- Parameters:
value
- Value of attribute- Returns:
- Self reference
-
setEmptyAttributeValueAsBoolean
protected Source 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 Source 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 Source 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 Source 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 Source 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 Source 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 Source 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 Source 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 Source 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 Source 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
-
-