gnu.xml.dom
public abstract class DomNode extends Object implements Node, NodeList, EventTarget, DocumentEvent, Cloneable
"Node", "EventTarget", and "DocumentEvent" implementation. This provides most of the core DOM functionality; only more specialized features are provided by subclasses. Those subclasses may have some particular constraints they must implement, by overriding methods defined here. Such constraints are noted here in the method documentation.
Note that you can create events with type names prefixed with "USER-", and pass them through this DOM. This lets you use the DOM event scheme for application specific purposes, although you must use a predefined event structure (such as MutationEvent) to pass data along with those events. Test for existence of this feature with the "USER-Events" DOM feature name.
Other kinds of events you can send include the "html" events, like "load", "unload", "abort", "error", and "blur"; and the mutation events. If this DOM has been compiled with mutation event support enabled, it will send mutation events when you change parts of the tree; otherwise you may create and send such events yourself, but they won't be generated by the DOM itself.
Note that there is a namespace-aware name comparison method, nameAndTypeEquals, which compares the names (and types) of two nodes in conformance with the "Namespaces in XML" specification. While mostly intended for use with elements and attributes, this should also be helpful for ProcessingInstruction nodes and some others which do not have namespace URIs.
Version: $Date: 2001/11/21 01:53:41 $
Constructor Summary | |
---|---|
protected | DomNode(Document owner)
Constructs a node and associates it with its owner. |
Method Summary | |
---|---|
void | addEventListener(String type, EventListener listener, boolean useCapture)
DOM L2 (Events)
Registers an event listener's interest in a class of events. |
Node | appendChild(Node newChild)
DOM L1
Appends the specified node to this node's list of children.
|
Object | clone()
Clones this node; roughly equivalent to cloneNode(false).
|
Node | cloneNode(boolean deep)
DOM L1
Returns a clone of this node which optionally includes cloned
versions of child nodes. |
void | compact()
Reduces space utilization for this node. |
Event | createEvent(String eventType)
DOM L2 (Events)
Returns an instance of the specified type of event object.
|
boolean | dispatchEvent(Event event)
DOM L2 (Events)
Delivers an event to all relevant listeners, returning true if the
caller should perform their default action. |
NamedNodeMap | getAttributes()
DOM L1
Returns null; Element subclasses must override this method. |
NodeList | getChildNodes()
DOM L1
Returns a list, possibly empty, of the children of this node.
|
NodeList | getElementsByTagName(String tag)
DOM L1
Creates a NodeList giving array-style access to elements with
the specified name. |
NodeList | getElementsByTagNameNS(String namespace, String local)
DOM L2
Creates a NodeList giving array-style access to elements with
the specified namespace and local name. |
Node | getFirstChild()
DOM L1
Returns the first child of this node, or null if there are none. |
Node | getLastChild()
DOM L1
Returns the last child of this node, or null if there are none. |
int | getLength()
DOM L1 (NodeList)
Returns the number of elements in this NodeList.
|
String | getLocalName()
DOM L2
Returns the node name; this must be overridden for element and
attribute nodes. |
String | getNamespaceURI()
DOM L2
Returns null; this must be overridden for element and
attribute nodes. |
Node | getNextSibling()
DOM L1
Returns the previous sibling, if one is known. |
String | getNodeValue()
DOM L1
Returns null; this must be overridden for nodes types with
a defined value, along with the setNodeValue method. |
Document | getOwnerDocument()
DOM L1 (modified in L2)
Returns the owner document. |
Node | getParentNode()
DOM L1
Returns the parent node, if one is known. |
String | getPrefix()
DOM L2
Returns null; this must be overridden for element and
attribute nodes. |
Node | getPreviousSibling()
DOM L1
Returns the previous sibling, if one is known. |
boolean | hasAttributes()
DOM L2>
Returns true iff this is an element node with attributes. |
boolean | hasChildNodes()
DOM L1
Returns true if this node has children. |
Node | insertBefore(Node newChild, Node refChild)
DOM L1
Inserts the specified node in this node's list of children.
|
boolean | isReadonly()
Exposes the internal "readonly" flag. |
boolean | isSupported(String feature, String version)
DOM L2
Consults the DOM implementation to determine if the requested
feature is supported. |
Node | item(int index)
DOM L1 (NodeList)
Returns the item with the specified index in this NodeList,
else null. |
void | makeReadonly()
Sets the internal "readonly" flag so this subtree can't be changed.
|
boolean | nameAndTypeEquals(Node other)
Returns true iff node types match, and either (a) both nodes have no
namespace and their getNodeName() values are the same, or (b) both
nodes have the same getNamespaceURI() and same getLocalName() values.
|
void | normalize()
DOM L1 (relocated in DOM L2)
In this node and all contained nodes (including attributes if
relevant) merge adjacent text nodes. |
Node | removeChild(Node refChild)
DOM L1
Removes the specified child from this node's list of children,
or else reports an exception.
|
void | removeEventListener(String type, EventListener listener, boolean useCapture)
DOM L2 (Events)
Unregisters an event listener. |
Node | replaceChild(Node newChild, Node refChild)
DOM L1
Replaces the specified node in this node's list of children.
|
void | setNodeValue(String value)
DOM L1
Does nothing; this must be overridden (along with the
getNodeValue method) for nodes with a non-null defined value. |
void | setPrefix(String prefix)
DOM L2
Does nothing; this must be overridden (along with the
getPrefix method) for element and attribute nodes. |
void | trimToSize()
Minimize extra space consumed by this node to hold children and event
listeners. |
Causes a DOMNodeInserted mutation event to be reported. Will first cause a DOMNodeRemoved event to be reported if the parameter already has a parent. If the new child is a document fragment node, both events will be reported for each child of the fragment; the order in which children are removed and inserted is implementation-specific.
If this DOM has been compiled without mutation event support, these events will not be reported.
If the name of the event type begins with "USER-", then an object implementing the "Event" class will be returned; this provides a limited facility for application-defined events to use the DOM event infrastructure. Alternatively, use one of the standard DOM event classes and initialize it using use such a "USER-" event type name; or defin, instantiate, and initialize an application-specific subclass of DomEvent and pass that to dispatchEvent().
Parameters: eventType Identifies the particular DOM feature module defining the type of event, such as "MutationEvents". The event "name" is a different kind of "type".
Throws: NullPointerException When a null event is passed. ClassCastException When the event wasn't provided by the createEvent method, or otherwise isn't a DomEvent. EventException If the event type wasn't specified
See Also: DomNode
Causes a DOMNodeInserted mutation event to be reported. Will first cause a DOMNodeRemoved event to be reported if the newChild parameter already has a parent. If the new child is a document fragment node, both events will be reported for each child of the fragment; the order in which children are removed and inserted is implementation-specific.
If this DOM has been compiled without mutation event support, these events will not be reported.
Note that notion of a "Per-Element-Type" attribute name scope, as found in a non-normative appendix of the XML Namespaces specification, is not supported here. Your application must implement that notion, typically by not bothering to check nameAndTypeEquals for attributes without namespace URIs unless you already know their elements are nameAndTypeEquals.
Causes a DOMNodeRemoved mutation event to be reported.
If this DOM has been compiled without mutation event support, these events will not be reported.
Causes DOMNodeRemoved and DOMNodeInserted mutation event to be reported. Will cause another DOMNodeRemoved event to be reported if the newChild parameter already has a parent. These events may be delivered in any order, except that the event reporting removal from such an existing parent will always be delivered before the event reporting its re-insertion as a child of some other node. The order in which children are removed and inserted is implementation specific.
If your application needs to depend on the in which those removal and insertion events are delivered, don't use this API. Instead, invoke the removeChild and insertBefore methods directly, to guarantee a specific delivery order. Similarly, don't use document fragments, Otherwise your application code may not work on a DOM which implements this method differently.
If this DOM has been compiled without mutation event support, these events will not be reported.
Source code is under GPL (with library exception) in the JAXP project at http://www.gnu.org/software/classpathx/jaxp
This documentation was derived from that source code on 2011-08-26.