|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.gargoylesoftware.htmlunit.html.DomNode
public abstract class DomNode
Base class for nodes in the HTML DOM tree. This class is modeled after the W3C DOM specification, but does not implement it.
Nested Class Summary | |
---|---|
protected class |
DomNode.ChildIterator
An iterator over all children of this node. |
protected class |
DomNode.DescendantElementsIterator<T extends DomNode>
Iterates over all descendants of a specific type, in document order. |
Field Summary | |
---|---|
protected static String |
AS_TEXT_BLANK
Indicates a non blank that can't be trimmed or reduced. |
protected static String |
AS_TEXT_BLOCK_SEPARATOR
Indicates a block. |
protected static String |
AS_TEXT_NEW_LINE
Indicates a new line. |
protected static String |
AS_TEXT_TAB
Indicates a tab. |
static String |
PROPERTY_ELEMENT
The name of the "element" property. |
static String |
READY_STATE_COMPLETE
A ready state constant for IE (state 5). |
static String |
READY_STATE_INTERACTIVE
A ready state constant for IE (state 4). |
static String |
READY_STATE_LOADED
A ready state constant for IE (state 3). |
static String |
READY_STATE_LOADING
A ready state constant for IE (state 2). |
static String |
READY_STATE_UNINITIALIZED
A ready state constant for IE (state 1). |
Constructor Summary | |
---|---|
protected |
DomNode()
Deprecated. |
protected |
DomNode(SgmlPage page)
Creates a new instance. |
Method Summary | ||
---|---|---|
void |
addDomChangeListener(DomChangeListener listener)
Adds a DomChangeListener to the listener list. |
|
DomNode |
appendChild(Node node)
|
|
String |
asText()
Returns a textual representation of this element that represents what would be visible to the user if this page was shown in a web browser. |
|
String |
asXml()
Returns a string representation of the XML document from this element and all it's children (recursively). |
|
protected void |
checkChildHierarchy(Node newChild)
Check for insertion errors for a new child node. |
|
DomNode |
cloneNode(boolean deep)
|
|
short |
compareDocumentPosition(Node other)
|
|
protected void |
fireNodeAdded(DomNode parentNode,
DomNode addedNode)
Support for reporting DOM changes. |
|
protected void |
fireNodeDeleted(DomNode parentNode,
DomNode deletedNode)
Support for reporting DOM changes. |
|
protected List<Node> |
getAncestors(boolean includeSelf)
Gets the ancestors of the node. |
|
NamedNodeMap |
getAttributes()
|
|
String |
getBaseURI()
Not yet implemented. |
|
List<?> |
getByXPath(String xpathExpr)
Evaluates the specified XPath expression from this node, returning the matching elements. |
|
String |
getCanonicalXPath()
Returns the canonical XPath expression which identifies this node, for instance "/html/body/table[3]/tbody/tr[5]/td[2]/span/a[3]". |
|
DomNodeList<DomNode> |
getChildNodes()
|
|
Iterable<DomNode> |
getChildren()
|
|
Iterable<DomNode> |
getDescendants()
Returns an Iterable that will recursively iterate over all of this node's descendants,
including DomText elements, DomComment elements, etc. |
|
int |
getEndColumnNumber()
Returns the column number in the source page where the DOM node ends. |
|
int |
getEndLineNumber()
Returns the line number in the source page where the DOM node ends. |
|
Object |
getFeature(String feature,
String version)
Not yet implemented. |
|
|
getFirstByXPath(String xpathExpr)
Evaluates the specified XPath expression from this node, returning the first matching element, or null if no node matches the specified XPath expression. |
|
DomNode |
getFirstChild()
|
|
Iterable<HtmlElement> |
getHtmlElementDescendants()
Returns an Iterable that will recursively iterate over all of this node's HtmlElement
descendants. |
|
int |
getIndex()
Returns this node's index within its parent's child nodes (zero-based). |
|
DomNode |
getLastChild()
|
|
String |
getLocalName()
|
|
String |
getNamespaceURI()
|
|
DomNode |
getNextSibling()
|
|
abstract String |
getNodeName()
Returns this node's node name. |
|
abstract short |
getNodeType()
Returns this node's node type. |
|
String |
getNodeValue()
|
|
Document |
getOwnerDocument()
|
|
SgmlPage |
getPage()
Returns the page that contains this node. |
|
DomNode |
getParentNode()
|
|
String |
getPrefix()
|
|
DomNode |
getPreviousSibling()
|
|
String |
getReadyState()
Returns this node's ready state (IE only). |
|
net.sourceforge.htmlunit.corejs.javascript.ScriptableObject |
getScriptObject()
INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK. |
|
int |
getStartColumnNumber()
Returns the column number in the source page where the DOM node starts. |
|
int |
getStartLineNumber()
Returns the line number in the source page where the DOM node starts. |
|
String |
getTextContent()
|
|
Object |
getUserData(String key)
Not yet implemented. |
|
boolean |
hasAttributes()
|
|
boolean |
hasChildNodes()
|
|
void |
insertBefore(DomNode newNode)
Inserts a new child node before this node into the child relationship this node is a part of. |
|
Node |
insertBefore(Node newChild,
Node refChild)
|
|
boolean |
isAncestorOf(DomNode node)
Returns true if this node is an ancestor of the specified node. |
|
boolean |
isAncestorOfAny(DomNode... nodes)
Returns true if this node is an ancestor of any of the specified nodes. |
|
protected boolean |
isBlock()
Indicates if the text representation of this element is made as a block, ie if new lines need to be inserted before and after it. |
|
boolean |
isDefaultNamespace(String namespaceURI)
Not yet implemented. |
|
protected boolean |
isDirectlyAttachedToPage()
Indicates if this node is currently directly attached to the page. |
|
boolean |
isDisplayed()
Returns true if this node is displayed and can be visible to the user (ignoring screen size, scrolling limitations, color, font-size, or overlapping nodes). |
|
boolean |
isEqualNode(Node arg)
Not yet implemented. |
|
boolean |
isSameNode(Node other)
|
|
boolean |
isSupported(String namespace,
String featureName)
Not yet implemented. |
|
protected boolean |
isTrimmedText()
Returns a flag indicating whether or not this node should have any leading and trailing whitespace removed when asText() is called. |
|
String |
lookupNamespaceURI(String prefix)
Not yet implemented. |
|
String |
lookupPrefix(String namespaceURI)
Not yet implemented. |
|
boolean |
mayBeDisplayed()
Returns true if nodes of this type can ever be displayed, false otherwise. |
|
void |
normalize()
|
|
protected void |
notifyIncorrectness(String message)
Notifies the registered IncorrectnessListener of something that is not fully correct. |
|
protected void |
onAddedToPage()
Lifecycle method invoked whenever a node is added to a page. |
|
protected void |
onAllChildrenAddedToPage(boolean postponed)
Lifecycle method invoked after a node and all its children have been added to a page, during parsing of the HTML. |
|
protected void |
printChildrenAsXml(String indent,
PrintWriter printWriter)
Recursively writes the XML data for the node tree starting at node . |
|
protected void |
printXml(String indent,
PrintWriter printWriter)
Recursively writes the XML data for the node tree starting at node . |
|
protected DomNode |
querySelector(String selectors)
Returns the first element within the document that matches the specified group of selectors. |
|
protected DomNodeList<DomNode> |
querySelectorAll(String selectors)
Retrieves all element nodes from descendants of the starting element node that match any selector within the supplied selector strings. |
|
void |
remove()
Removes this node from all relationships with other nodes. |
|
void |
removeAllChildren()
Removes all of this node's children. |
|
Node |
removeChild(Node child)
|
|
void |
removeDomChangeListener(DomChangeListener listener)
Removes a DomChangeListener from the listener list. |
|
void |
replace(DomNode newNode)
Replaces this node with another node. |
|
Node |
replaceChild(Node newChild,
Node oldChild)
|
|
protected void |
setNextSibling(DomNode next)
|
|
void |
setNodeValue(String value)
|
|
protected void |
setParentNode(DomNode parent)
Sets the parent node. |
|
void |
setPrefix(String prefix)
|
|
protected void |
setPreviousSibling(DomNode previous)
|
|
void |
setReadyState(String state)
Sets this node's ready state (IE only). |
|
void |
setScriptObject(net.sourceforge.htmlunit.corejs.javascript.ScriptableObject scriptObject)
INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK. |
|
void |
setTextContent(String textContent)
|
|
Object |
setUserData(String key,
Object data,
UserDataHandler handler)
Not yet implemented. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected static final String AS_TEXT_BLOCK_SEPARATOR
protected static final String AS_TEXT_NEW_LINE
protected static final String AS_TEXT_BLANK
protected static final String AS_TEXT_TAB
public static final String READY_STATE_UNINITIALIZED
public static final String READY_STATE_LOADING
public static final String READY_STATE_LOADED
public static final String READY_STATE_INTERACTIVE
public static final String READY_STATE_COMPLETE
public static final String PROPERTY_ELEMENT
Constructor Detail |
---|
@Deprecated protected DomNode()
protected DomNode(SgmlPage page)
page
- the page which contains this nodeMethod Detail |
---|
public int getStartLineNumber()
public int getStartColumnNumber()
public int getEndLineNumber()
public int getEndColumnNumber()
public SgmlPage getPage()
public Document getOwnerDocument()
getOwnerDocument
in interface Node
public void setScriptObject(net.sourceforge.htmlunit.corejs.javascript.ScriptableObject scriptObject)
scriptObject
- the JavaScript objectpublic DomNode getLastChild()
getLastChild
in interface Node
public DomNode getParentNode()
getParentNode
in interface Node
protected void setParentNode(DomNode parent)
parent
- the parent nodepublic int getIndex()
public DomNode getPreviousSibling()
getPreviousSibling
in interface Node
public DomNode getNextSibling()
getNextSibling
in interface Node
public DomNode getFirstChild()
getFirstChild
in interface Node
public boolean isAncestorOf(DomNode node)
node
- the node to check
public boolean isAncestorOfAny(DomNode... nodes)
nodes
- the nodes to check
protected void setPreviousSibling(DomNode previous)
previous
- set the previousSibling field valueprotected void setNextSibling(DomNode next)
next
- set the nextSibling field valuepublic abstract short getNodeType()
getNodeType
in interface Node
public abstract String getNodeName()
getNodeName
in interface Node
public String getNamespaceURI()
getNamespaceURI
in interface Node
public String getLocalName()
getLocalName
in interface Node
public String getPrefix()
getPrefix
in interface Node
public void setPrefix(String prefix)
setPrefix
in interface Node
public boolean hasChildNodes()
hasChildNodes
in interface Node
public DomNodeList<DomNode> getChildNodes()
getChildNodes
in interface Node
public boolean isSupported(String namespace, String featureName)
isSupported
in interface Node
public void normalize()
normalize
in interface Node
public String getBaseURI()
getBaseURI
in interface Node
public short compareDocumentPosition(Node other)
compareDocumentPosition
in interface Node
protected List<Node> getAncestors(boolean includeSelf)
includeSelf
- should this node be returned too
public String getTextContent()
getTextContent
in interface Node
public void setTextContent(String textContent)
setTextContent
in interface Node
public boolean isSameNode(Node other)
isSameNode
in interface Node
public String lookupPrefix(String namespaceURI)
lookupPrefix
in interface Node
public boolean isDefaultNamespace(String namespaceURI)
isDefaultNamespace
in interface Node
public String lookupNamespaceURI(String prefix)
lookupNamespaceURI
in interface Node
public boolean isEqualNode(Node arg)
isEqualNode
in interface Node
public Object getFeature(String feature, String version)
getFeature
in interface Node
public Object getUserData(String key)
getUserData
in interface Node
public Object setUserData(String key, Object data, UserDataHandler handler)
setUserData
in interface Node
public boolean hasAttributes()
hasAttributes
in interface Node
protected boolean isTrimmedText()
asText()
is called. This method should usually return
true, but must return false for such things as text formatting tags.
asText()
is calledpublic boolean isDisplayed()
Returns true if this node is displayed and can be visible to the user (ignoring screen size, scrolling limitations, color, font-size, or overlapping nodes).
NOTE: If CSS is disabled
, this method
does not take this element's style into consideration!
mayBeDisplayed()
public boolean mayBeDisplayed()
isDisplayed()
public String asText()
protected boolean isBlock()
true
if this element represents a blockpublic String asXml()
protected void printXml(String indent, PrintWriter printWriter)
node
.
indent
- white space to indent child nodesprintWriter
- writer where child nodes are writtenprotected void printChildrenAsXml(String indent, PrintWriter printWriter)
node
.
indent
- white space to indent child nodesprintWriter
- writer where child nodes are writtenpublic String getNodeValue()
getNodeValue
in interface Node
public void setNodeValue(String value)
setNodeValue
in interface Node
public DomNode cloneNode(boolean deep)
cloneNode
in interface Node
public net.sourceforge.htmlunit.corejs.javascript.ScriptableObject getScriptObject()
public DomNode appendChild(Node node)
appendChild
in interface Node
protected void checkChildHierarchy(Node newChild) throws DOMException
newChild
- the new child node that is being inserted below this node
DOMException
- HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does
not allow children of the type of the newChild node, or if the node to insert is one of
this node's ancestors or this node itself, or if this node is of type Document and the
DOM application attempts to insert a second DocumentType or Element node.
WRONG_DOCUMENT_ERR: Raised if newChild was created from a different document than the
one that created this node.public Node insertBefore(Node newChild, Node refChild)
insertBefore
in interface Node
public void insertBefore(DomNode newNode) throws IllegalStateException
newNode
- the new node to insert
IllegalStateException
- if this node is not a child of any other nodepublic NamedNodeMap getAttributes()
getAttributes
in interface Node
public Node removeChild(Node child)
removeChild
in interface Node
public void remove()
public Node replaceChild(Node newChild, Node oldChild)
replaceChild
in interface Node
public void replace(DomNode newNode) throws IllegalStateException
newNode
- the node to replace this one
IllegalStateException
- if this node is not a child of any other nodeprotected void onAddedToPage()
protected void onAllChildrenAddedToPage(boolean postponed)
postponed
- whether to use PostponedAction
or nopublic final Iterable<DomNode> getChildren()
public final Iterable<DomNode> getDescendants()
Iterable
that will recursively iterate over all of this node's descendants,
including DomText
elements, DomComment
elements, etc. If you want to iterate
only over HtmlElement
descendants, please use getHtmlElementDescendants()
.
Iterable
that will recursively iterate over all of this node's descendantspublic final Iterable<HtmlElement> getHtmlElementDescendants()
Iterable
that will recursively iterate over all of this node's HtmlElement
descendants. If you want to iterate over all descendants (including DomText
elements,
DomComment
elements, etc.), please use getDescendants()
.
Iterable
that will recursively iterate over all of this node's HtmlElement
descendantspublic String getReadyState()
public void setReadyState(String state)
state
- this node's ready statepublic void removeAllChildren()
public List<?> getByXPath(String xpathExpr)
xpathExpr
- the XPath expression to evaluate
getFirstByXPath(String)
,
getCanonicalXPath()
public <X> X getFirstByXPath(String xpathExpr)
X
- the expression typexpathExpr
- the XPath expression
getByXPath(String)
,
getCanonicalXPath()
public String getCanonicalXPath()
Returns the canonical XPath expression which identifies this node, for instance "/html/body/table[3]/tbody/tr[5]/td[2]/span/a[3]".
WARNING: This sort of automated XPath expression is often quite bad at identifying a node, as it is highly sensitive to changes in the DOM tree.
getByXPath(String)
protected void notifyIncorrectness(String message)
IncorrectnessListener
of something that is not fully correct.
message
- the notification to send to the registered IncorrectnessListener
public void addDomChangeListener(DomChangeListener listener)
DomChangeListener
to the listener list. The listener is registered for
all descendants of this node.
listener
- the DOM structure change listener to be addedremoveDomChangeListener(DomChangeListener)
public void removeDomChangeListener(DomChangeListener listener)
DomChangeListener
from the listener list. The listener is deregistered for
all descendants of this node.
listener
- the DOM structure change listener to be removedaddDomChangeListener(DomChangeListener)
protected void fireNodeAdded(DomNode parentNode, DomNode addedNode)
DomChangeEvent
to any registered DomChangeListener
s.
Note that this method recursively calls this node's parent's fireNodeAdded(DomNode, DomNode)
.
parentNode
- the parent of the node that was addedaddedNode
- the node that was addedprotected void fireNodeDeleted(DomNode parentNode, DomNode deletedNode)
DomChangeEvent
to any registered DomChangeListener
s.
Note that this method recursively calls this node's parent's fireNodeDeleted(DomNode, DomNode)
.
parentNode
- the parent of the node that was deleteddeletedNode
- the node that was deletedprotected DomNodeList<DomNode> querySelectorAll(String selectors)
selectors
- one or more CSS selectors separated by commas
protected DomNode querySelector(String selectors)
selectors
- one or more CSS selectors separated by commas
protected boolean isDirectlyAttachedToPage()
true
if the page is one ancestor of the node.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |