Package io.wcm.handler.commons.dom

Class Anchor

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.AbstractNonSelfClosingHtmlElement

io.wcm.handler.commons.dom.Anchor

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, org.jdom2.NamespaceAware, org.jdom2.Parent

@ProviderType
public final class Anchor
extends AbstractNonSelfClosingHtmlElement

Html anchor (a) element.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.jdom2.Content

org.jdom2.Content.CType

Field Summary

Fields inherited from class org.jdom2.Element

name, namespace

Fields inherited from class org.jdom2.Content

ctype, parent

Constructor Summary

Constructors

Constructor	Description
Anchor()	Initializes html element.
Anchor(java.lang.String href)	Initializes html element.
Anchor(java.lang.String href, java.lang.String target)	Initializes html element.

Method Summary

Modifier and Type	Method	Description
Anchor	addCssClass(java.lang.String value)	Html "class" attribute.
java.lang.String	getAccessKey()	Html "accesskey" attribute.
java.lang.String	getHRef()	Html "href" attribute.
java.lang.String	getRel()	Html "rel" attribute.
int	getTabIndex()	Html "tabindex" attribute.
java.lang.String	getTarget()	Html "target" attribute.
Anchor	setAccessKey(java.lang.String value)	Html "accesskey" attribute.
Anchor	setAttributeValueAsLong(java.lang.String name, long value)	Sets attribute value as long.
Anchor	setCssClass(java.lang.String value)	Sets Html "class" attribute - unless you're really sure that you want to replace existing classes, you probably should call HtmlElement.addCssClass(String) instead.
Anchor	setData(java.lang.String attributeName, java.lang.String value)	Custom Html5 "data-*" attribute.
protected Anchor	setEmptyAttributeValueAsBoolean(java.lang.String attributeName, boolean value)	Sets "empty" attribute value as boolean (i.e.
Anchor	setHRef(java.lang.String value)	Html "href" attribute.
Anchor	setId(java.lang.String value)	Html "id" attribute.
Anchor	setRel(java.lang.String value)	Html "rel" attribute.
Anchor	setStyle(java.lang.String styleAttribute, java.lang.String styleValue)	Html "style" attribute.
Anchor	setStyleString(java.lang.String value)	Html "style" attribute.
Anchor	setTabIndex(int value)	Html "tabindex" attribute.
Anchor	setTarget(java.lang.String value)	Html "target" attribute.
Anchor	setText(java.lang.String text)	Sets the content of the element to be the text given.
Anchor	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

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jdom2.Parent

getDocument, getParent

Constructor Detail

Anchor

public Anchor()

Initializes html element.

Anchor

public Anchor(java.lang.String href)

Initializes html element.

Parameters:

href - Html "href" attribute.

Anchor

public Anchor(java.lang.String href,
              java.lang.String target)

Initializes html element.

Parameters:

href - Html "href" attribute.

target - Html "target" attribute.

Method Detail

getRel

public java.lang.String getRel()

Html "rel" attribute.

Returns:

Value of attribute

setRel

public Anchor setRel(java.lang.String value)

Html "rel" attribute.

Parameters:

value - Value of attribute

Returns:

Self reference

getHRef

public java.lang.String getHRef()

Html "href" attribute.

Returns:

Value of attribute

setHRef

public Anchor setHRef(java.lang.String value)

Html "href" attribute.

Parameters:

value - Value of attribute

Returns:

Self reference

getTarget

public java.lang.String getTarget()

Html "target" attribute.

Returns:

Value of attribute

setTarget

public Anchor setTarget(java.lang.String value)

Html "target" attribute.

Parameters:

value - Value of attribute

Returns:

Self reference

getTabIndex

public int getTabIndex()

Html "tabindex" attribute.

Returns:

Value of attribute

setTabIndex

public Anchor setTabIndex(int value)

Html "tabindex" attribute.

Parameters:

value - Value of attribute

Returns:

Self reference

getAccessKey

public java.lang.String getAccessKey()

Html "accesskey" attribute.

Returns:

Value of attribute

setAccessKey

public Anchor setAccessKey(java.lang.String value)

Html "accesskey" attribute.

Parameters:

value - Value of attribute

Returns:

Self reference

setEmptyAttributeValueAsBoolean

protected Anchor 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 class HtmlElement

Parameters:

attributeName - Attribute name

value - Attribute value as boolean

Returns:

Self reference

setId

public Anchor setId(java.lang.String value)

Description copied from class: HtmlElement

Html "id" attribute.

Overrides:

setId in class HtmlElement

Parameters:

value - Value of attribute

Returns:

Self reference

setCssClass

public Anchor 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 call HtmlElement.addCssClass(String) instead.

Overrides:

setCssClass in class HtmlElement

Parameters:

value - Value of attribute

Returns:

Self reference

addCssClass

public Anchor 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 class HtmlElement

Parameters:

value - Value of attribute

Returns:

Self reference

setStyleString

public Anchor setStyleString(java.lang.String value)

Description copied from class: HtmlElement

Html "style" attribute.

Overrides:

setStyleString in class HtmlElement

Parameters:

value - Value of attribute with style key/value pairs

Returns:

Self reference

setStyle

public Anchor 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 class HtmlElement

Parameters:

styleAttribute - Style attribute name

styleValue - Style attribute value

Returns:

Self reference

setTitle

public Anchor setTitle(java.lang.String value)

Description copied from class: HtmlElement

Html "title" attribute.

Overrides:

setTitle in class HtmlElement

Parameters:

value - Value of attribute

Returns:

Self reference

setData

public Anchor setData(java.lang.String attributeName,
                      java.lang.String value)

Description copied from class: HtmlElement

Custom Html5 "data-*" attribute.

Overrides:

setData in class HtmlElement

Parameters:

attributeName - Name of HTML5 data attribute (without the 'data-' prefix).

value - Value of attribute

Returns:

Self reference

setAttributeValueAsLong

public Anchor setAttributeValueAsLong(java.lang.String name,
                                      long value)

Description copied from class: AbstractElement

Sets attribute value as long.

Overrides:

setAttributeValueAsLong in class AbstractElement

Parameters:

name - Attribute name

value - Attribute value as long

Returns:

Self reference

setText

public Anchor 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 Element.setContent(java.util.Collection<? extends org.jdom2.Content>) instead. Setting a null text value is equivalent to setting an empty string value.

Overrides:

setText in class AbstractElement

Parameters:

text - new text content for the element

Returns:

the target element