Node (JxBrowser 7.0 API)

All Superinterfaces:

EventTarget, SearchContext

All Known Subinterfaces:

Document, Element, FormControlElement, FormElement, FrameElement, InputElement, OptionElement, SelectElement, TextAreaElement
```
public interface Node
extends EventTarget, SearchContext
```
A base DOM object providing access to the common DOM object properties and methods to manage the DOM node structure.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`appendChild(Node childNode)` Adds the given `node` as a child of the current node to the end of its children list.
`java.util.List<Node>`	`children()` Returns an immutable list of all children of this node.
`void`	`click()` Simulates a click on the node.
`XPathResult`	`evaluate(java.lang.String expression)` Evaluates the given XPath `expression` for the node and returns the `XPathResult` of the `XPathResultType.ANY` type.
`XPathResult`	`evaluate(java.lang.String expression, XPathResultType type)` Evaluates the given XPath `expression` for the node and returns the `XPathResult` object of the given `type`.
`boolean`	`insertChild(Node node, Node beforeNode)` Inserts the given `node` before the given `beforeNode` as a child of the current node.
`java.util.Optional<Node>`	`nextSibling()` Returns an `Optional` that contains the next node in the document tree if such a node exists, otherwise returns an empty `Optional`.
`java.lang.String`	`nodeName()` Returns a string that represents the node name in the UTF8 format.
`java.lang.String`	`nodeValue()` Returns a string that represents the node value.
`void`	`nodeValue(java.lang.String value)` Updates the node value with the given new `value`.
`java.util.Optional<Node>`	`parent()` Returns an `Optional` that contains the parent of this node.
`java.util.Optional<Node>`	`previousSibling()` Returns an `Optional` that contains the previous node in the document tree if such a node exists, otherwise returns an empty `Optional`.
`boolean`	`removeChild(Node childNode)` Removes the given `childNode` of the current node from the DOM.
`boolean`	`replaceChild(Node newNode, Node oldNode)` Replaces the given child `oldNode` of the current node with the given `newNode`.
`java.lang.String`	`textContent()` Returns the text content of the current node and its descendants.
`void`	`textContent(java.lang.String textContent)` Removes all the current node children and replaces them with a single text node with the given `textContent`.
`NodeType`	`type()` Returns the node type.

Methods inherited from interface com.teamdev.jxbrowser.dom.event.EventTarget
addEventListener, dispatch, eventListeners, removeEventListener

Methods inherited from interface com.teamdev.jxbrowser.dom.SearchContext
findElementByClassName, findElementByCssSelector, findElementById, findElementByName, findElementByTagName, findElementsByClassName, findElementsByCssSelector, findElementsById, findElementsByName, findElementsByTagName

Method Detail

nodeName

java.lang.String nodeName()

Returns a string that represents the node name in the UTF8 format.

The returned values for different types of nodes are:

Node type		Returned value
`NodeType.ELEMENT_NODE`		The element tag name. For DOM trees which represent HTML documents, the returned value is always capitalized. The tag names of elements in an XML DOM tree are returned in the same case in which they're written in the original XML file.
`NodeType.ATTRIBUTE_NODE`		The attribute name
`NodeType.TEXT_NODE`		"#text"
`NodeType.C_DATA_SECTION_NODE`		"#cdata-section"
`NodeType.ENTITY_REFERENCE_NODE`		The name of entity reference
`NodeType.ENTITY_NODE`		The entity name
`NodeType.PROCESSING_INSTRUCTIONS_NODE`		The value of the `target` attribute
`NodeType.COMMENT_NODE`		"#comment"
`NodeType.DOCUMENT_NODE`		"#document"
`NodeType.DOCUMENT_TYPE_NODE`		The document type name, for example "html" for `<!DOCTYPE HTML>`
`NodeType.DOCUMENT_FRAGMENT_NODE`		"#document-fragment"
`NodeType.NOTATION_NODE`		The notation name

Throws:: java.lang.IllegalStateException - when the document this instance belongs to is closed

nodeValue

java.lang.String nodeValue()

Returns a string that represents the node value.

The returned values for different types of nodes are:

Node type		Returned value
`NodeType.ELEMENT_NODE`		null
`NodeType.ATTRIBUTE_NODE`		The attribute value
`NodeType.TEXT_NODE`		The content of the text node
`NodeType.C_DATA_SECTION_NODE`		The content of the CDATA Section
`NodeType.ENTITY_REFERENCE_NODE`		null
`NodeType.ENTITY_NODE`		null
`NodeType.PROCESSING_INSTRUCTIONS_NODE`		The entire node content excluding the target
`NodeType.COMMENT_NODE`		The content of the comment
`NodeType.DOCUMENT_NODE`		null
`NodeType.DOCUMENT_TYPE_NODE`		null
`NodeType.DOCUMENT_FRAGMENT_NODE`		null
`NodeType.NOTATION_NODE`		null

Throws:: java.lang.IllegalStateException - when the document this instance belongs to is closed

nodeValue
```
void nodeValue(java.lang.String value)
```
Updates the node value with the given new value.
This method does nothing, if it is invoked for the node of one of the following types: NodeType.ELEMENT_NODE, NodeType.ENTITY_REFERENCE_NODE, NodeType.ENTITY_NODE, NodeType.DOCUMENT_NODE, NodeType.DOCUMENT_TYPE_NODE, NodeType.DOCUMENT_FRAGMENT_NODE, NodeType.NOTATION_NODE.

Parameters:

value - a new node value

Throws:

java.lang.IllegalStateException - when the document this instance belongs to is closed

See Also:

nodeValue()

type
```
NodeType type()
```
Returns the node type.

Throws:

java.lang.IllegalStateException - when the document this instance belongs to is closed

parent
```
java.util.Optional<Node> parent()
```
Returns an Optional that contains the parent of this node. If there is no such node, for example when this node is the document or it does not belong to the DOM tree, returns an empty Optional.

Throws:

java.lang.IllegalStateException - when the document this instance belongs to is closed

children
```
java.util.List<Node> children()
```
Returns an immutable list of all children of this node.
Please note, that this method should be invoked every time in case of need to retrieve an actual children list.

Throws:

java.lang.IllegalStateException - when the document this instance belongs to is closed

nextSibling
```
java.util.Optional<Node> nextSibling()
```
Returns an Optional that contains the next node in the document tree if such a node exists, otherwise returns an empty Optional.

Throws:

java.lang.IllegalStateException - when the document this instance belongs to is closed

previousSibling
```
java.util.Optional<Node> previousSibling()
```
Returns an Optional that contains the previous node in the document tree if such a node exists, otherwise returns an empty Optional.

Throws:

java.lang.IllegalStateException - when the document this instance belongs to is closed

click
```
void click()
```
Simulates a click on the node.

Throws:

java.lang.IllegalStateException - when the document this instance belongs to is closed

insertChild
```
boolean insertChild(Node node,
                    Node beforeNode)
```
Inserts the given node before the given beforeNode as a child of the current node. The new node can be an existing node in the document, or you can create and insert a new node. If the node is existing node, it will be moved to a new location in the document.

Parameters:

node - the node to insert

beforeNode - the node before which the node will be inserted

Returns:

true if the given node was successfully inserted

Throws:

java.lang.IllegalStateException - when the document this instance belongs to is closed

replaceChild
```
boolean replaceChild(Node newNode,
                     Node oldNode)
```
Replaces the given child oldNode of the current node with the given newNode. The new node can be an existing node in the document, or you can create and insert a new node. If the newNode is existing node, it will be moved to a new location in the document.

Parameters:

newNode - the new node to replace the oldNode

oldNode - the existing node to be replaced

Returns:

true if the given oldNode was successfully replaced

Throws:

java.lang.IllegalStateException - when the document this instance belongs to is closed

removeChild
```
boolean removeChild(Node childNode)
```
Removes the given childNode of the current node from the DOM. The removed childNode still exists, but is no longer part of the DOM. You can reuse the removed node later in your code via the childNode object reference.

Parameters:

childNode - the existing node to be removed

Returns:

true if the given node was successfully removed

Throws:

java.lang.IllegalStateException - when the document this instance belongs to is closed

appendChild
```
boolean appendChild(Node childNode)
```
Adds the given node as a child of the current node to the end of its children list. The new node could be an existing node in the document, or you can create and add a new node. If the node is existing node, it will be moved to a new location in the document.

Parameters:

childNode - the node to append

Returns:

true if the given node was successfully inserted

Throws:

java.lang.IllegalStateException - when the document this instance belongs to is closed

textContent
```
java.lang.String textContent()
```
Returns the text content of the current node and its descendants.
- Returns an empty string if the node is one of the following types: NodeType.DOCUMENT_NODE, NodeType.DOCUMENT_TYPE_NODE, or NodeType.NOTATION_NODE.
- Returns the node value if the node is a NodeType.C_DATA_SECTION_NODE, NodeType.COMMENT_NODE, NodeType.PROCESSING_INSTRUCTIONS_NODE, or NodeType.TEXT_NODE.
- For other node types returns the concatenated text content of every child node, excluding comments and processing instructions. Returns an empty string if the current node has no children.
Throws:

java.lang.IllegalStateException - when the document this instance belongs to is closed

textContent
```
void textContent(java.lang.String textContent)
```
Removes all the current node children and replaces them with a single text node with the given textContent.

Parameters:

textContent - the new text content of the current node

Throws:

java.lang.IllegalStateException - when the document this instance belongs to is closed

evaluate
```
XPathResult evaluate(java.lang.String expression)
```
Evaluates the given XPath expression for the node and returns the XPathResult of the XPathResultType.ANY type.

Parameters:

expression - a string representing the XPath to be evaluated

Throws:

java.lang.IllegalArgumentException - when expression is empty

XPathException - when this method failed to evaluate the given expression

java.lang.IllegalStateException - when the document this instance belongs to is closed

See Also:

evaluate(String, XPathResultType)

evaluate
```
XPathResult evaluate(java.lang.String expression,
                     XPathResultType type)
```
Evaluates the given XPath expression for the node and returns the XPathResult object of the given type.

Parameters:

expression - a string representing the XPath to be evaluated

type - type of XPathResult to return

Throws:

java.lang.IllegalArgumentException - when expression is empty or blank

XPathException - when this method failed to evaluate the given expression and return a result of the given type

java.lang.IllegalStateException - when the document this instance belongs to is closed

See Also:

XPathResultType

Interface Node

Method Summary

Methods inherited from interface com.teamdev.jxbrowser.dom.event.EventTarget

Methods inherited from interface com.teamdev.jxbrowser.dom.SearchContext

Method Detail

nodeName

nodeValue

nodeValue

type

parent

children

nextSibling

previousSibling

click

insertChild

replaceChild

removeChild

appendChild

textContent

textContent

evaluate

evaluate