Package org.apache.tapestry5.dom
Class Element
java.lang.Object
org.apache.tapestry5.dom.Node
org.apache.tapestry5.dom.Element
An element that will render with a begin tag and attributes, a body, and an end tag. Also acts as a factory for
enclosed Element, Text and Comment nodes.
TODO: Support for CDATA nodes. Do we need Entity nodes?
-
Method Summary
Modifier and TypeMethodDescriptionaddClassName
(String... classNames) Deprecated.Deprecated in 5.4, as this is now special behavior for the "class" attribute.Adds an attribute to the element, but only if the attribute name does not already exist.Adds a namespaced attribute to the element, but only if the attribute name does not already exist.attributes
(String... namesAndValues) Convenience for invokingattribute(String, String)
multiple times.Adds and returns a new CDATA node.Adds the comment and returns this element for further construction.defineNamespace
(String namespace, String namespacePrefix) Defines a namespace for this element, mapping a URI to a prefix.Creates and returns a new Element node as a child of this node.Creates a new element, as a child of the current index, at the indicated index.elementBefore
(String name, String... namesAndValues) Inserts a new element before this element.Creates and returns a new Element within a namespace as a child of this node.Searchs for a child element with a particular name below this element.forceAttributes
(String... namesAndValues) Forces changes to a number of attributes.forceAttributesNS
(String namespace, String... namesAndValues) Forces changes to a number of attributes in the global namespace.getAttribute
(String attributeName) Returns the attributes for this Element as a (often empty) collection ofAttribute
s.final String
Returns an unmodifiable list of children for this element.getElement
(Predicate<Element> predicate) Tries to find an element under this element (including itself) accepted by the given predicate.getElementByAttributeValue
(String attributeName, String attributeValue) Tries to find an element under this element (including itself) whose given attribute has a given value.getElementById
(String id) Tries to find an element under this element (including itself) whose id is specified.getName()
Returns the namespace for this element (which is typically a URL).boolean
isEmpty()
Returns true if the element has no children, or has only text children that contain only whitespace.void
pop()
Removes an element; the element's children take the place of the node within its container.Adds the raw text and returns this element for further construction.Removes all children from this element.Adds and returns a new text node (the text node is returned so thatText.write(String)
or [@linkText.writef(String, Object[])
may be invoked .void
Depth-first visitor traversal of this Element and its Element children.Methods inherited from class org.apache.tapestry5.dom.Node
getContainer, moveAfter, moveBefore, moveToBottom, moveToTop, remove, toMarkup, toString, wrap
-
Method Details
-
getDocument
- Overrides:
getDocument
in classNode
-
attribute
Adds an attribute to the element, but only if the attribute name does not already exist. The "class" attribute is treated specially: the new value is appended, after a space, to the existing value.- Parameters:
name
- the name of the attribute to addvalue
- the value for the attribute. A value of null is allowed, and no attribute will be added to the element.
-
attribute
Adds a namespaced attribute to the element, but only if the attribute name does not already exist. The "class" attribute of the default namespace is treated specially: the new value is appended, after a space, to the existing value.- Parameters:
namespace
- the namespace to contain the attribute, or null for the default namespacename
- the name of the attribute to addvalue
- the value for the attribute. A value of null is allowed, and no attribute will be added to the element.
-
attributes
Convenience for invokingattribute(String, String)
multiple times.- Parameters:
namesAndValues
- alternating attribute names and attribute values
-
forceAttributes
Forces changes to a number of attributes. The new attributes overwrite previous values. Overriding an attribute's value to null will remove the attribute entirely.- Parameters:
namesAndValues
- alternating attribute names and attribute values- Returns:
- this element
-
forceAttributesNS
Forces changes to a number of attributes in the global namespace. The new attributes overwrite previous values (event for the "class" attribute). Overriding attribute's value to null will remove the attribute entirely. TAP5-708: don't use element namespace for attributes- Parameters:
namespace
- the namespace or nullnamesAndValues
- alternating attribute name and value- Returns:
- this element
-
element
Creates and returns a new Element node as a child of this node.- Parameters:
name
- the name of the element to createnamesAndValues
- alternating attribute names and attribute values
-
elementBefore
Inserts a new element before this element.- Parameters:
name
- element namenamesAndValues
- attribute names and values- Returns:
- the new element
- Since:
- 5.3
-
elementNS
Creates and returns a new Element within a namespace as a child of this node.- Parameters:
namespace
- namespace to contain the element, or nullname
- element name to create within the namespace- Returns:
- the newly created element
-
elementAt
Creates a new element, as a child of the current index, at the indicated index.- Parameters:
index
- to insert atname
- element namenamesAndValues
- attribute name / attribute value pairs- Returns:
- the new element
-
comment
Adds the comment and returns this element for further construction. -
raw
Adds the raw text and returns this element for further construction. -
text
Adds and returns a new text node (the text node is returned so thatText.write(String)
or [@linkText.writef(String, Object[])
may be invoked .- Parameters:
text
- initial text for the node- Returns:
- the new Text node
-
cdata
Adds and returns a new CDATA node.- Parameters:
content
- the content to be rendered by the node- Returns:
- the newly created node
-
getElementById
Tries to find an element under this element (including itself) whose id is specified. Performs a width-first search of the document tree.- Parameters:
id
- the value of the id attribute of the element being looked for- Returns:
- the element if found. null if not found.
-
getElementByAttributeValue
Tries to find an element under this element (including itself) whose given attribute has a given value.- Parameters:
attributeName
- the name of the attribute of the element being looked forattributeValue
- the value of the attribute of the element being looked for- Returns:
- the element if found. null if not found.
- Since:
- 5.2.3
-
getElement
Tries to find an element under this element (including itself) accepted by the given predicate.- Parameters:
predicate
- Predicate to accept the element- Returns:
- the element if found. null if not found.
- Since:
- 5.2.3
-
find
Searchs for a child element with a particular name below this element. The path parameter is a slash separated series of element names. -
getAttribute
-
getName
-
addClassName
Deprecated.Deprecated in 5.4, as this is now special behavior for the "class" attribute.Adds one or more CSS class names to the "class" attribute.- Parameters:
classNames
- one or more CSS class names- Returns:
- the element for further configuration
-
defineNamespace
Defines a namespace for this element, mapping a URI to a prefix. This will affect how namespaced elements and attributes nested within the element are rendered, and will also causexmlns:
attributes (to define the namespace and prefix) to be rendered.- Parameters:
namespace
- URI of the namespacenamespacePrefix
- prefix- Returns:
- this element
-
getNamespace
Returns the namespace for this element (which is typically a URL). The namespace may be null. -
pop
Removes an element; the element's children take the place of the node within its container. -
removeChildren
Removes all children from this element.- Returns:
- the element, for method chaining
-
getNamespaceURIToPrefix
- Overrides:
getNamespaceURIToPrefix
in classNode
-
isEmpty
Returns true if the element has no children, or has only text children that contain only whitespace.- Since:
- 5.1.0.0
-
visit
Depth-first visitor traversal of this Element and its Element children. The traversal order is the same as render order.- Parameters:
visitor
- callback- Since:
- 5.1.0.0
-
getChildMarkup
- Returns:
- the concatenation of the String representations
Node.toString()
of its children.
-
getChildren
Returns an unmodifiable list of children for this element. OnlyElement
s will have children. Also, note that unlike W3C DOM, attributes are not represented asNode
s.- Returns:
- unmodifiable list of children nodes
-
getAttributes
Returns the attributes for this Element as a (often empty) collection ofAttribute
s. The order of the attributes within the collection is not specified. Modifying the collection will not affect the attributes (useforceAttributes(String[])
to change existing attribute values, andattribute(String, String, String)
to add new attribute values.- Returns:
- attribute collection
-