org.apache.batik.dom

Class AbstractNode

public abstract class AbstractNode extends Object implements ExtendedNode, NodeXBL, XBLManagerData, Serializable

This class implements the org.w3c.dom.Node interface.

Field Summary
static short	DOCUMENT_POSITION_CONTAINED_BY
static short	DOCUMENT_POSITION_CONTAINS
static short	DOCUMENT_POSITION_DISCONNECTED
static short	DOCUMENT_POSITION_FOLLOWING
static short	DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC
static short	DOCUMENT_POSITION_PRECEDING
protected EventSupport	eventSupport The event support.
static NodeList	EMPTY_NODE_LIST An empty instance of NodeList.
protected Object	managerData The XBL manager data.
protected AbstractDocument	ownerDocument The owner document.
protected HashMap	userData User data.
protected HashMap	userDataHandlers User data handlers.

Method Summary
void	addEventListener(String type, EventListener listener, boolean useCapture) DOM: Implements EventTarget.
void	addEventListenerNS(String namespaceURI, String type, EventListener listener, boolean useCapture, Object evtGroup) DOM: Implements NodeEventTarget.
Node	appendChild(Node newChild) DOM: Implements org.w3c.dom.Node#appendChild(Node).
protected void	checkChildType(Node n, boolean replace) Checks the validity of a node to be inserted.
Node	cloneNode(boolean deep) DOM: Implements org.w3c.dom.Node#cloneNode(boolean).
short	compareDocumentPosition(Node other) DOM: Implements org.w3c.dom.Node#compareDocumentPosition(Node).
protected boolean	compareNamedNodeMaps(NamedNodeMap nnm1, NamedNodeMap nnm2) Compare two NamedNodeMaps for equality.
protected boolean	compareStrings(String s1, String s2) Compare two strings for equality.
protected Node	copyInto(Node n) Copy the fields of the current node into the given node.
DOMException	createDOMException(short type, String key, Object[] args) Creates an exception with the appropriate error message.
protected Node	deepCopyInto(Node n) Deeply copy the fields of the current node into the given node.
protected Node	deepExport(Node n, AbstractDocument d) Deeply exports this node to the given document.
boolean	dispatchEvent(Event evt) DOM: Implements dispatchEvent.
protected Node	export(Node n, AbstractDocument d) Exports this node to the given document.
protected void	fireDOMCharacterDataModifiedEvent(String oldv, String newv) Fires a DOMCharacterDataModified event.
void	fireDOMNodeInsertedIntoDocumentEvent() Recursively fires a DOMNodeInsertedIntoDocument event.
void	fireDOMNodeRemovedFromDocumentEvent() Recursively fires a DOMNodeRemovedFromDocument event.
protected void	fireUserDataHandlers(short type, Node oldNode, Node newNode) Fire any UserDataHandlers on the given oldNode.
NamedNodeMap	getAttributes() DOM: Implements org.w3c.dom.Node#getAttributes().
String	getBaseURI() DOM: Implements org.w3c.dom.Node#getBaseURI().
static String	getBaseURI(Node n)
protected String	getCascadedXMLBase(Node node) Returns the xml:base attribute value of the given element, resolving any dependency on parent bases if needed.
NodeList	getChildNodes() DOM: Implements org.w3c.dom.Node#getChildNodes().
protected AbstractDocument	getCurrentDocument() Returns the current document.
EventSupport	getEventSupport() Returns the event support instance for this node, or null if any.
Object	getFeature(String feature, String version) DOM: Implements org.w3c.dom.Node#getFeature(String,String).
Node	getFirstChild() DOM: Implements org.w3c.dom.Node#getFirstChild().
Node	getLastChild() DOM: Implements org.w3c.dom.Node#getLastChild().
String	getLocalName() DOM: Implements org.w3c.dom.Node#getLocalName().
Object	getManagerData() Returns the XBL manager associated data for this node.
String	getNamespaceURI() DOM: Implements org.w3c.dom.Node#getNamespaceURI().
Node	getNextSibling() DOM: Implements org.w3c.dom.Node#getNextSibling().
String	getNodeValue() DOM: Implements org.w3c.dom.Node#getNodeValue().
Document	getOwnerDocument() DOM: Implements org.w3c.dom.Node#getOwnerDocument().
Node	getParentNode() DOM: Implements org.w3c.dom.Node#getParentNode().
NodeEventTarget	getParentNodeEventTarget() Implements getParentNodeEventTarget.
String	getPrefix() DOM: Implements org.w3c.dom.Node#getPrefix().
Node	getPreviousSibling() DOM: Implements org.w3c.dom.Node#getPreviousSibling().
String	getTextContent() DOM: Implements org.w3c.dom.Node#getTextContent().
Object	getUserData(String key) DOM: Implements org.w3c.dom.Node#getUserData(String).
Element	getXblBoundElement() Get the bound element whose shadow tree this current node resides in.
NodeList	getXblChildNodes() Get the list of child nodes of this node in the fully flattened tree.
NodeList	getXblDefinitions() Get the xbl:definition elements currently binding this element.
Node	getXblFirstChild() Get the first child node of this node in the fully flattened tree.
Element	getXblFirstElementChild() Get the first element child of this node in the fully flattened tree.
Node	getXblLastChild() Get the last child node of this node in the fully flattened tree.
Element	getXblLastElementChild() Get the last element child of this node in the fully flattened tree.
Element	getXblNextElementSibling() Get the first element that follows the current node in the xblParentNode's xblChildNodes list.
Node	getXblNextSibling() Get the node which directly follows the current node in the xblParentNode's xblChildNodes list.
Node	getXblParentNode() Get the parent of this node in the fully flattened tree.
Element	getXblPreviousElementSibling() Get the first element that precedes the current node in the xblParentNode's xblChildNodes list.
Node	getXblPreviousSibling() Get the node which directly precedes the current node in the xblParentNode's xblChildNodes list.
NodeList	getXblScopedChildNodes() Get the list of child nodes of this node in the fully flattened tree that are within the same shadow scope.
Element	getXblShadowTree() Get the shadow tree of this node.
boolean	hasAttributes() DOM: Implements org.w3c.dom.Node#hasAttributes().
boolean	hasChildNodes() DOM: Implements org.w3c.dom.Node#hasChildNodes().
boolean	hasEventListenerNS(String namespaceURI, String type) DOM: Implements `EventTarget.hasEventListenerNS(String,String)` from an old draft of DOM Level 3 Events.
EventSupport	initializeEventSupport() Initializes the event support instance for this node if it has not been already, and returns it.
Node	insertBefore(Node newChild, Node refChild) DOM: Implements org.w3c.dom.Node#insertBefore(Node, Node).
boolean	isDefaultNamespace(String namespaceURI) DOM: Implements org.w3c.dom.Node#isDefaultNamespace(String).
boolean	isEqualNode(Node other) DOM: Implements org.w3c.dom.Node#isEqualNode(Node).
boolean	isSameNode(Node other) DOM: Implements org.w3c.dom.Node#isSameNode(Node).
boolean	isSupported(String feature, String version) DOM: Implements org.w3c.dom.Node#isSupported(String,String).
protected String	lookupNamespacePrefix(String namespaceURI, Element originalElement) Helper function for AbstractNode.
String	lookupNamespaceURI(String prefix) DOM: Implements org.w3c.dom.Node#lookupNamespaceURI(String).
String	lookupPrefix(String namespaceURI) DOM: Implements org.w3c.dom.Node#lookupPrefix(String).
protected abstract Node	newNode() Returns a new uninitialized instance of this object's class.
void	normalize() DOM: Implements org.w3c.dom.Node#normalize().
Node	removeChild(Node oldChild) DOM: Implements org.w3c.dom.Node#removeChild(Node).
void	removeEventListener(String type, EventListener listener, boolean useCapture) DOM: Implements EventTarget.
void	removeEventListenerNS(String namespaceURI, String type, EventListener listener, boolean useCapture) DOM: Implements NodeEventTarget.
Node	replaceChild(Node newChild, Node oldChild) DOM: Implements org.w3c.dom.Node#replaceChild(Node, Node).
void	setManagerData(Object data) Sets the XBL manager associated data for this node.
void	setNextSibling(Node n) Sets the node immediately following this node.
void	setNodeName(String v) Sets the name of this node.
void	setNodeValue(String nodeValue) DOM: Implements org.w3c.dom.Node#setNodeValue(String).
void	setOwnerDocument(Document doc) Sets the owner document of this node.
void	setParentNode(Node v) Sets the parent node.
void	setPrefix(String prefix) DOM: Implements org.w3c.dom.Node#setPrefix(String).
void	setPreviousSibling(Node n) Sets the node immediately preceding this node.
void	setSpecified(boolean v) Sets the value of the specified attribute.
void	setTextContent(String s) DOM: Implements org.w3c.dom.Node#setTextContent(String).
Object	setUserData(String key, Object data, UserDataHandler handler) DOM: Implements org.w3c.dom.Node#setUserData(String,Object,UserDataHandler).
boolean	willTriggerNS(String namespaceURI, String type) DOM: Implements `EventTarget#willTriggerNS(String,String)` from an old draft of DOM Level 3 Events.

Field Detail

DOCUMENT_POSITION_CONTAINED_BY

public static final short DOCUMENT_POSITION_CONTAINED_BY

DOCUMENT_POSITION_CONTAINS

public static final short DOCUMENT_POSITION_CONTAINS

DOCUMENT_POSITION_DISCONNECTED

public static final short DOCUMENT_POSITION_DISCONNECTED

DOCUMENT_POSITION_FOLLOWING

public static final short DOCUMENT_POSITION_FOLLOWING

DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

public static final short DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

DOCUMENT_POSITION_PRECEDING

public static final short DOCUMENT_POSITION_PRECEDING

eventSupport

protected transient EventSupport eventSupport

The event support.

EMPTY_NODE_LIST

public static final NodeList EMPTY_NODE_LIST

An empty instance of NodeList.

managerData

protected Object managerData

The XBL manager data.

ownerDocument

protected AbstractDocument ownerDocument

The owner document.

userData

protected HashMap userData

User data.

userDataHandlers

protected HashMap userDataHandlers

User data handlers.

Method Detail

addEventListener

public void addEventListener(String type, EventListener listener, boolean useCapture)

DOM: Implements EventTarget.

addEventListenerNS

public void addEventListenerNS(String namespaceURI, String type, EventListener listener, boolean useCapture, Object evtGroup)

DOM: Implements NodeEventTarget.

appendChild

public Node appendChild(Node newChild)

DOM: Implements org.w3c.dom.Node#appendChild(Node). Throws a HIERARCHY_REQUEST_ERR org.w3c.dom.DOMException.

checkChildType

protected void checkChildType(Node n, boolean replace)

Checks the validity of a node to be inserted.

cloneNode

public Node cloneNode(boolean deep)

DOM: Implements org.w3c.dom.Node#cloneNode(boolean).

compareDocumentPosition

public short compareDocumentPosition(Node other)

DOM: Implements org.w3c.dom.Node#compareDocumentPosition(Node). XXX Doesn't handle notation or entity nodes.

compareNamedNodeMaps

protected boolean compareNamedNodeMaps(NamedNodeMap nnm1, NamedNodeMap nnm2)

Compare two NamedNodeMaps for equality.

compareStrings

protected boolean compareStrings(String s1, String s2)

Compare two strings for equality.

copyInto

protected Node copyInto(Node n)

Copy the fields of the current node into the given node.

Parameters: n a node of the type of this.

createDOMException

public DOMException createDOMException(short type, String key, Object[] args)

Creates an exception with the appropriate error message.

deepCopyInto

protected Node deepCopyInto(Node n)

Deeply copy the fields of the current node into the given node.

Parameters: n a node of the type of this.

deepExport

protected Node deepExport(Node n, AbstractDocument d)

Deeply exports this node to the given document.

dispatchEvent

public boolean dispatchEvent(Event evt)

DOM: Implements dispatchEvent.

export

protected Node export(Node n, AbstractDocument d)

Exports this node to the given document.

fireDOMCharacterDataModifiedEvent

protected void fireDOMCharacterDataModifiedEvent(String oldv, String newv)

Fires a DOMCharacterDataModified event.

fireDOMNodeInsertedIntoDocumentEvent

public void fireDOMNodeInsertedIntoDocumentEvent()

Recursively fires a DOMNodeInsertedIntoDocument event.

fireDOMNodeRemovedFromDocumentEvent

public void fireDOMNodeRemovedFromDocumentEvent()

Recursively fires a DOMNodeRemovedFromDocument event.

fireUserDataHandlers

protected void fireUserDataHandlers(short type, Node oldNode, Node newNode)

Fire any UserDataHandlers on the given oldNode.

getAttributes

public NamedNodeMap getAttributes()

DOM: Implements org.w3c.dom.Node#getAttributes().

Returns: null.

getBaseURI

public String getBaseURI()

DOM: Implements org.w3c.dom.Node#getBaseURI().

getBaseURI

public static String getBaseURI(Node n)

getCascadedXMLBase

protected String getCascadedXMLBase(Node node)

Returns the xml:base attribute value of the given element, resolving any dependency on parent bases if needed.

getChildNodes

public NodeList getChildNodes()

DOM: Implements org.w3c.dom.Node#getChildNodes().

Returns: EMPTY_NODE_LIST.

getCurrentDocument

protected AbstractDocument getCurrentDocument()

Returns the current document.

getEventSupport

public EventSupport getEventSupport()

Returns the event support instance for this node, or null if any.

getFeature

public Object getFeature(String feature, String version)

DOM: Implements org.w3c.dom.Node#getFeature(String,String).

getFirstChild

public Node getFirstChild()

DOM: Implements org.w3c.dom.Node#getFirstChild().

Returns: null.

getLastChild

public Node getLastChild()

DOM: Implements org.w3c.dom.Node#getLastChild().

Returns: null.

getLocalName

public String getLocalName()

DOM: Implements org.w3c.dom.Node#getLocalName().

getManagerData

public Object getManagerData()

Returns the XBL manager associated data for this node.

getNamespaceURI

public String getNamespaceURI()

DOM: Implements org.w3c.dom.Node#getNamespaceURI().

Returns: null.

getNextSibling

public Node getNextSibling()

DOM: Implements org.w3c.dom.Node#getNextSibling().

Returns: null.

getNodeValue

public String getNodeValue()

DOM: Implements org.w3c.dom.Node#getNodeValue().

Returns: null.

getOwnerDocument

public Document getOwnerDocument()

DOM: Implements org.w3c.dom.Node#getOwnerDocument().

Returns: ownerDocument.

getParentNode

public Node getParentNode()

DOM: Implements org.w3c.dom.Node#getParentNode().

Returns: null.

getParentNodeEventTarget

public NodeEventTarget getParentNodeEventTarget()

Implements getParentNodeEventTarget.

getPrefix

public String getPrefix()

DOM: Implements org.w3c.dom.Node#getPrefix().

getPreviousSibling

public Node getPreviousSibling()

DOM: Implements org.w3c.dom.Node#getPreviousSibling().

Returns: null.

getTextContent

public String getTextContent()

DOM: Implements org.w3c.dom.Node#getTextContent().

getUserData

public Object getUserData(String key)

DOM: Implements org.w3c.dom.Node#getUserData(String).

getXblBoundElement

public Element getXblBoundElement()

Get the bound element whose shadow tree this current node resides in.

getXblChildNodes

public NodeList getXblChildNodes()

Get the list of child nodes of this node in the fully flattened tree.

getXblDefinitions

public NodeList getXblDefinitions()

Get the xbl:definition elements currently binding this element.

getXblFirstChild

public Node getXblFirstChild()

Get the first child node of this node in the fully flattened tree.

getXblFirstElementChild

public Element getXblFirstElementChild()

Get the first element child of this node in the fully flattened tree.

getXblLastChild

public Node getXblLastChild()

Get the last child node of this node in the fully flattened tree.

getXblLastElementChild

public Element getXblLastElementChild()

Get the last element child of this node in the fully flattened tree.

getXblNextElementSibling

public Element getXblNextElementSibling()

Get the first element that follows the current node in the xblParentNode's xblChildNodes list.

getXblNextSibling

public Node getXblNextSibling()

Get the node which directly follows the current node in the xblParentNode's xblChildNodes list.

getXblParentNode

public Node getXblParentNode()

Get the parent of this node in the fully flattened tree.

getXblPreviousElementSibling

public Element getXblPreviousElementSibling()

Get the first element that precedes the current node in the xblParentNode's xblChildNodes list.

getXblPreviousSibling

public Node getXblPreviousSibling()

Get the node which directly precedes the current node in the xblParentNode's xblChildNodes list.

getXblScopedChildNodes

public NodeList getXblScopedChildNodes()

Get the list of child nodes of this node in the fully flattened tree that are within the same shadow scope.

getXblShadowTree

public Element getXblShadowTree()

Get the shadow tree of this node.

hasAttributes

public boolean hasAttributes()

DOM: Implements org.w3c.dom.Node#hasAttributes().

Returns: false.

hasChildNodes

public boolean hasChildNodes()

DOM: Implements org.w3c.dom.Node#hasChildNodes().

Returns: false.