org.kde.koala

Class Element

public class Element extends Node

By far the vast majority of objects (apart from text) that authors encounter when traversing a document are Element nodes. Assume the following XML document: <elementExample id="demo"> <subelement1/> <subelement2><subsubelement/></subelement2> </elementExample> When represented using DOM, the top node is an Element node for "elementExample", which contains two child Element nodes, one for "subelement1" and one for "subelement2". "subelement1" contains no child nodes. Elements may have attributes associated with them; since the Element interface inherits from Node , the generic Node interface method getAttributes may be used to retrieve the set of all attributes for an element. There are methods on the Element interface to retrieve either an Attr object by name or an attribute value by name. In XML, where an attribute value may contain entity references, an Attr object should be retrieved to examine the possibly fairly complex sub-tree representing the attribute value. On the other hand, in HTML, where all attributes have simple string values, methods to directly access an attribute value can safely be used as a convenience.

UNKNOWN: By far the vast majority of objects (apart from text) that authors encounter when traversing a document are Element nodes.

Constructor Summary
protected Element(Class dummy)
Element()
Element(Node other)
Element(Element other)
Method Summary
booleancontentEditable()
not part of the official DOM This method will always reflect the editability setting of this element as specified by a direct or indirect (that means, inherited) assignment to contentEditable or the respective CSS rule, even if design mode is active.
Elementform()
KHTML extension to DOM This method returns the associated form element. returns null if this element is not a form-like element or if this elment is not in the scope of a form element.
StringgetAttribute(String name)
Retrieves an attribute value by name.
AttrgetAttributeNode(String name)
Retrieves an Attr node by name.
AttrgetAttributeNodeNS(String namespaceURI, String localName)
Introduced in DOM Level 2 Retrieves an Attr node by local name and namespace URI.
StringgetAttributeNS(String namespaceURI, String localName)
Introduced in DOM Level 2.
ArrayListgetElementsByTagName(String name)
Returns a ArrayList of all descendant elements with a given tag name, in the order in which they would be encountered in a preorder traversal of the Element tree.
ArrayListgetElementsByTagNameNS(String namespaceURI, String localName)
Introduced in DOM Level 2 Returns an ArrayList of all the descendant Elements with a given local name and namespace URI in the order in which they are encountered in a preorder traversal of this Element tree.
booleanhasAttribute(String name)
Returns true when an attribute with a given name is specified on this element or has a default value, false otherwise.
booleanhasAttributeNS(String namespaceURI, String localName)
Introduced in DOM Level 2 Returns true when an attribute with a given local name and namespace URI is specified on this element or has a default value, false otherwise.
booleanisHTMLElement()
not part of the DOM
static booleankhtmlMalformedPrefix(String name)
static booleankhtmlMalformedQualifiedName(String name)
static booleankhtmlValidAttrName(String name)
static booleankhtmlValidPrefix(String name)
static booleankhtmlValidQualifiedName(String name)
voidremoveAttribute(String name)
Removes an attribute by name.
AttrremoveAttributeNode(Attr oldAttr)
Removes the specified attribute.
voidremoveAttributeNS(String namespaceURI, String localName)
Introduced in DOM Level 2 Removes an attribute by local name and namespace URI.
voidsetAttribute(String name, String value)
Adds a new attribute.
AttrsetAttributeNode(Attr newAttr)
Adds a new attribute.
AttrsetAttributeNodeNS(Attr newAttr)
Introduced in DOM Level 2 Adds a new attribute.
voidsetAttributeNS(String namespaceURI, String qualifiedName, String value)
Introduced in DOM Level 2 Adds a new attribute.
voidsetContentEditable(boolean enabled)
not part of the official DOM This element can be made editable by setting its contentEditable property to true. The setting will be inherited to its children as well.
CSSStyleDeclarationstyle()
Introduced in DOM Level 2 This method is from the CSSStyleDeclaration interface The style attribute
StringtagName()
The name of the element.

Constructor Detail

Element

protected Element(Class dummy)

Element

public Element()

Element

public Element(Node other)

Element

public Element(Element other)

Method Detail

contentEditable

public boolean contentEditable()
not part of the official DOM This method will always reflect the editability setting of this element as specified by a direct or indirect (that means, inherited) assignment to contentEditable or the respective CSS rule, even if design mode is active.

Returns: whether this element is editable.

See Also: Element

UNKNOWN: not part of the official DOM

form

public Element form()
KHTML extension to DOM This method returns the associated form element. returns null if this element is not a form-like element or if this elment is not in the scope of a form element.

UNKNOWN: KHTML extension to DOM This method returns the associated form element.

getAttribute

public String getAttribute(String name)
Retrieves an attribute value by name.

Parameters: name The name of the attribute to retrieve.

Returns: The Attr value as a string, or the empty string if that attribute does not have a specified or default value.

UNKNOWN: Retrieves an attribute value by name.

getAttributeNode

public Attr getAttributeNode(String name)
Retrieves an Attr node by name.

Parameters: name The name of the attribute to retrieve.

Returns: The Attr node with the specified attribute name or null if there is no such attribute.

UNKNOWN: Retrieves an Attr node by name.

getAttributeNodeNS

public Attr getAttributeNodeNS(String namespaceURI, String localName)
Introduced in DOM Level 2 Retrieves an Attr node by local name and namespace URI. HTML-only DOM implementations do not need to implement this method.

Parameters: namespaceURI The namespace URI of the attribute to retrieve. localName The local name of the attribute to retrieve.

Returns: The Attr node with the specified attribute local name and namespace URI or null if there is no such attribute.

UNKNOWN: Introduced in DOM Level 2

getAttributeNS

public String getAttributeNS(String namespaceURI, String localName)
Introduced in DOM Level 2. No Exceptions. Retrieves an attribute value by local name and namespace URI. HTML-only DOM implementations do not need to implement this method.

Parameters: namespaceURI The namespace URI of the attribute to retrieve. localName The local name of the attribute to retrieve.

Returns: The Attr value as a string, or the empty string if that attribute does not have a specified or default value.

UNKNOWN: Introduced in DOM Level 2.

getElementsByTagName

public ArrayList getElementsByTagName(String name)
Returns a ArrayList of all descendant elements with a given tag name, in the order in which they would be encountered in a preorder traversal of the Element tree.

Parameters: name The name of the tag to match on. The special value "*" matches all tags.

Returns: A list of matching Element nodes.

UNKNOWN: Returns a NodeList of all descendant elements with a given tag name, in the order in which they would be encountered in a preorder traversal of the Element tree.

getElementsByTagNameNS

public ArrayList getElementsByTagNameNS(String namespaceURI, String localName)
Introduced in DOM Level 2 Returns an ArrayList of all the descendant Elements with a given local name and namespace URI in the order in which they are encountered in a preorder traversal of this Element tree.

Parameters: namespaceURI The namespace URI of the elements to match on. The special value "*" matches all namespaces. localName The local name of the elements to match on. The special value "*" matches all local names.

Returns: A new NodeList object containing all the matched Elements.

UNKNOWN: Introduced in DOM Level 2 Returns a NodeList of all the descendant Elements with a given local name and namespace URI in the order in which they are encountered in a preorder traversal of this Element tree.

hasAttribute

public boolean hasAttribute(String name)
Returns true when an attribute with a given name is specified on this element or has a default value, false otherwise. Introduced in DOM Level 2.

Parameters: name The name of the attribute to look for.

Returns: true if an attribute with the given name is specified on this element or has a default value, false otherwise.

UNKNOWN: Returns true when an attribute with a given name is specified on this element or has a default value, false otherwise.

hasAttributeNS

public boolean hasAttributeNS(String namespaceURI, String localName)
Introduced in DOM Level 2 Returns true when an attribute with a given local name and namespace URI is specified on this element or has a default value, false otherwise. HTML-only DOM implementations do not need to implement this method.

Parameters: namespaceURI The namespace URI of the attribute to look for. localName The local name of the attribute to look for.

Returns: true if an attribute with the given local name and namespace URI is specified or has a default value on this element, false otherwise.

UNKNOWN: Introduced in DOM Level 2

isHTMLElement

public boolean isHTMLElement()
not part of the DOM

UNKNOWN:

khtmlMalformedPrefix

public static boolean khtmlMalformedPrefix(String name)

khtmlMalformedQualifiedName

public static boolean khtmlMalformedQualifiedName(String name)

khtmlValidAttrName

public static boolean khtmlValidAttrName(String name)

khtmlValidPrefix

public static boolean khtmlValidPrefix(String name)

khtmlValidQualifiedName

public static boolean khtmlValidQualifiedName(String name)

removeAttribute

public void removeAttribute(String name)
Removes an attribute by name. If the removed attribute has a default value it is immediately replaced.

Parameters: name The name of the attribute to remove.

UNKNOWN: Removes an attribute by name.

removeAttributeNode

public Attr removeAttributeNode(Attr oldAttr)
Removes the specified attribute.

Parameters: oldAttr The Attr node to remove from the attribute list. If the removed Attr has a default value it is immediately replaced. NOT_FOUND_ERR: Raised if oldAttr is not an attribute of the element.

Returns: The Attr node that was removed.

UNKNOWN: Removes the specified attribute.

removeAttributeNS

public void removeAttributeNS(String namespaceURI, String localName)
Introduced in DOM Level 2 Removes an attribute by local name and namespace URI. If the removed attribute has a default value it is immediately replaced. The replacing attribute has the same namespace URI and local name, as well as the original prefix. HTML-only DOM implementations do not need to implement this method.

Parameters: namespaceURI The namespace URI of the attribute to remove. localName The local name of the attribute to remove.

UNKNOWN: Introduced in DOM Level 2

setAttribute

public void setAttribute(String name, String value)
Adds a new attribute. If an attribute with that name is already present in the element, its value is changed to be that of the value parameter. This value is a simple string, it is not parsed as it is being set. So any markup (such as syntax to be recognized as an entity reference) is treated as literal text, and needs to be appropriately escaped by the implementation when it is written out. In order to assign an attribute value that contains entity references, the user must create an Attr node plus any Text and EntityReference nodes, build the appropriate subtree, and use setAttributeNode to assign it as the value of an attribute.

Parameters: name The name of the attribute to create or alter. value Value to set in string form. NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

UNKNOWN: Adds a new attribute.

setAttributeNode

public Attr setAttributeNode(Attr newAttr)
Adds a new attribute. If an attribute with that name is already present in the element, it is replaced by the new one.

Parameters: newAttr The Attr node to add to the attribute list. NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. INUSE_ATTRIBUTE_ERR: Raised if newAttr is already an attribute of another Element object. The DOM user must explicitly clone Attr nodes to re-use them in other elements.

Returns: If the newAttr attribute replaces an existing attribute with the same name, the previously existing Attr node is returned, otherwise null is returned.

UNKNOWN: Adds a new attribute.

setAttributeNodeNS

public Attr setAttributeNodeNS(Attr newAttr)
Introduced in DOM Level 2 Adds a new attribute. If an attribute with that local name and that namespace URI is already present in the element, it is replaced by the new one. HTML-only DOM implementations do not need to implement this method.

Parameters: newAttr The Attr node to add to the attribute list. NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. INUSE_ATTRIBUTE_ERR: Raised if newAttr is already an attribute of another Element object. The DOM user must explicitly clone Attr nodes to re-use them in other elements.

Returns: If the newAttr attribute replaces an existing attribute with the same local name and namespace URI, the replaced Attr node is returned, otherwise null is returned.

UNKNOWN: Introduced in DOM Level 2

setAttributeNS

public void setAttributeNS(String namespaceURI, String qualifiedName, String value)
Introduced in DOM Level 2 Adds a new attribute. If an attribute with the same local name and namespace URI is already present on the element, its prefix is changed to be the prefix part of the qualifiedName, and its value is changed to be the value parameter. This value is a simple string; it is not parsed as it is being set. So any markup (such as syntax to be recognized as an entity reference) is treated as literal text, and needs to be appropriately escaped by the implementation when it is written out. In order to assign an attribute value that contains entity references, the user must create an Attr node plus any Text and EntityReference nodes, build the appropriate subtree, and use setAttributeNodeNS or setAttributeNode to assign it as the value of an attribute. HTML-only DOM implementations do not need to implement this method.

Parameters: namespaceURI The namespace URI of the attribute to create or alter. qualifiedName The qualified name of the attribute to create or alter. value The value to set in string form. NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. NAMESPACE_ERR: Raised if the qualifiedName is malformed, if the qualifiedName has a prefix and the namespaceURI is null, if the qualifiedName has a prefix that is "xml" and the namespaceURI is different from "http://www.w3.org/XML/1998/namespace", or if the qualifiedName is "xmlns" and the namespaceURI is different from "http://www.w3.org/2000/xmlns/".

UNKNOWN: Introduced in DOM Level 2

setContentEditable

public void setContentEditable(boolean enabled)
not part of the official DOM This element can be made editable by setting its contentEditable property to true. The setting will be inherited to its children as well. Setting or clearing contentEditable when design mode is active will take no effect. However, its status will still be propagated to all child elements.

Parameters: enabled true to make this element editable, false otherwise.

See Also: Document

UNKNOWN: not part of the official DOM

style

public CSSStyleDeclaration style()
Introduced in DOM Level 2 This method is from the CSSStyleDeclaration interface The style attribute

UNKNOWN: Introduced in DOM Level 2 This method is from the CSSStyleDeclaration interface

tagName

public String tagName()
The name of the element. For example, in: <elementExample id="demo"> ... </elementExample> , tagName has the value "elementExample" . Note that this is case-preserving in XML, as are all of the operations of the DOM. The HTML DOM returns the tagName of an HTML element in the canonical uppercase form, regardless of the case in the source HTML document.

UNKNOWN: The name of the element.