|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.kde.koala.Node
org.kde.koala.Element
public class Element
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.
Constructor Summary | |
---|---|
|
Element()
|
protected |
Element(java.lang.Class dummy)
|
|
Element(Element other)
|
|
Element(Node other)
|
Method Summary | |
---|---|
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. |
Element |
form()
KHTML extension to DOM This method returns the associated form element. |
java.lang.String |
getAttribute(java.lang.String name)
Retrieves an attribute value by name. |
Attr |
getAttributeNode(java.lang.String name)
Retrieves an Attr node by name. |
Attr |
getAttributeNodeNS(java.lang.String namespaceURI,
java.lang.String localName)
Introduced in DOM Level 2 Retrieves an Attr node by local name and namespace URI. |
java.lang.String |
getAttributeNS(java.lang.String namespaceURI,
java.lang.String localName)
Introduced in DOM Level 2. |
java.util.ArrayList |
getElementsByTagName(java.lang.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. |
java.util.ArrayList |
getElementsByTagNameNS(java.lang.String namespaceURI,
java.lang.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. |
boolean |
hasAttribute(java.lang.String name)
Returns true when an attribute with a given name is specified on this element or has a default value, false otherwise. |
boolean |
hasAttributeNS(java.lang.String namespaceURI,
java.lang.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. |
boolean |
isHTMLElement()
not part of the DOM |
static boolean |
khtmlMalformedPrefix(java.lang.String name)
|
static boolean |
khtmlMalformedQualifiedName(java.lang.String name)
|
static boolean |
khtmlValidAttrName(java.lang.String name)
|
static boolean |
khtmlValidPrefix(java.lang.String name)
|
static boolean |
khtmlValidQualifiedName(java.lang.String name)
|
void |
removeAttribute(java.lang.String name)
Removes an attribute by name. |
Attr |
removeAttributeNode(Attr oldAttr)
Removes the specified attribute. |
void |
removeAttributeNS(java.lang.String namespaceURI,
java.lang.String localName)
Introduced in DOM Level 2 Removes an attribute by local name and namespace URI. |
void |
setAttribute(java.lang.String name,
java.lang.String value)
Adds a new attribute. |
Attr |
setAttributeNode(Attr newAttr)
Adds a new attribute. |
Attr |
setAttributeNodeNS(Attr newAttr)
Introduced in DOM Level 2 Adds a new attribute. |
void |
setAttributeNS(java.lang.String namespaceURI,
java.lang.String qualifiedName,
java.lang.String value)
Introduced in DOM Level 2 Adds a new attribute. |
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. |
CSSStyleDeclaration |
style()
Introduced in DOM Level 2 This method is from the CSSStyleDeclaration interface The style attribute |
java.lang.String |
tagName()
The name of the element. |
Methods inherited from class org.kde.koala.Node |
---|
addEventListener, appendChild, applyChanges, attributes, childNodes, cloneNode, dispatchEvent, elementId, firstChild, getRect, hasAttributes, hasChildNodes, index, insertBefore, isNull, isSupported, lastChild, localName, namespaceURI, nextSibling, nodeName, nodeType, nodeValue, normalize, op_equals, op_not_equals, ownerDocument, parentNode, prefix, previousSibling, removeChild, removeEventListener, replaceChild, setNodeValue, setPrefix |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
protected Element(java.lang.Class dummy)
public Element()
public Element(Node other)
public Element(Element other)
Method Detail |
---|
public java.lang.String tagName()
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.
public java.lang.String getAttribute(java.lang.String name)
name
- The name of the attribute to retrieve.
Attr
value as a string, or the empty
string if that attribute does not have a specified or default
value.public void setAttribute(java.lang.String name, java.lang.String value)
Attr
node plus any Text
and
EntityReference
nodes, build the appropriate subtree,
and use setAttributeNode
to assign it as the
value of an attribute.
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.public void removeAttribute(java.lang.String name)
name
- The name of the attribute to remove.public Attr getAttributeNode(java.lang.String name)
Attr
node by name.
name
- The name of the attribute to retrieve.
Attr
node with the specified
attribute name or null
if there is no such
attribute.public Attr setAttributeNode(Attr newAttr)
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.
newAttr
attribute replaces an
existing attribute with the same name, the previously existing
Attr
node is returned, otherwise null
is returned.public Attr removeAttributeNode(Attr oldAttr)
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.
Attr
node that was removed.public java.util.ArrayList getElementsByTagName(java.lang.String name)
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.
name
- The name of the tag to match on. The special value
"*" matches all tags.
Element
nodes.public java.util.ArrayList getElementsByTagNameNS(java.lang.String namespaceURI, java.lang.String localName)
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.
public java.lang.String getAttributeNS(java.lang.String namespaceURI, java.lang.String localName)
namespaceURI
- The namespace URI of the attribute to retrieve.localName
- The local name of the attribute to retrieve.
public void setAttributeNS(java.lang.String namespaceURI, java.lang.String qualifiedName, java.lang.String value)
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/".public void removeAttributeNS(java.lang.String namespaceURI, java.lang.String localName)
namespaceURI
- The namespace URI of the attribute to remove.localName
- The local name of the attribute to remove.public Attr getAttributeNodeNS(java.lang.String namespaceURI, java.lang.String localName)
namespaceURI
- The namespace URI of the attribute to retrieve.localName
- The local name of the attribute to retrieve.
public Attr setAttributeNodeNS(Attr newAttr)
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.
public boolean hasAttribute(java.lang.String name)
name
- The name of the attribute to look for.
public boolean hasAttributeNS(java.lang.String namespaceURI, java.lang.String localName)
namespaceURI
- The namespace URI of the attribute to look for.localName
- The local name of the attribute to look for.
public CSSStyleDeclaration style()
public boolean contentEditable()
setContentEditable(boolean)
public void setContentEditable(boolean enabled)
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.
enabled
- true
to make this element editable, false
otherwise.Document.designMode()
public boolean isHTMLElement()
public Element form()
public static boolean khtmlValidAttrName(java.lang.String name)
public static boolean khtmlValidPrefix(java.lang.String name)
public static boolean khtmlValidQualifiedName(java.lang.String name)
public static boolean khtmlMalformedQualifiedName(java.lang.String name)
public static boolean khtmlMalformedPrefix(java.lang.String name)
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |