java.lang.Objectcom.aspose.words.Node
public abstract class Node
A document is represented as a tree of nodes, similar to DOM or XmlDocument. For more info see the Composite design pattern. The
Property Getters/Setters Summary | ||
---|---|---|
DocumentBase | getDocument() | |
Gets the document to which this node belongs. | ||
boolean | isComposite() | |
Returns true if this node can contain other nodes. | ||
Node | getNextSibling() | |
Gets the node immediately following this node. | ||
abstract int | getNodeType() | |
Gets the type of this node. The value of the property is NodeType integer constant. | ||
CompositeNode | getParentNode() | |
Gets the immediate parent of this node. | ||
Node | getPreviousSibling() | |
Gets the node immediately preceding this node. | ||
Range | getRange() | |
Returns a Range object that represents the portion of a document that is contained in this node. |
Method Summary | ||
---|---|---|
abstract boolean | accept(DocumentVisitor visitor) | |
Accepts a visitor. | ||
Node | deepClone(boolean isCloneChildren) | |
Creates a duplicate of the node. | ||
CompositeNode | getAncestor(int ancestorType) | |
Gets the first ancestor of the specified |
||
CompositeNode | getAncestor(java.lang.Class ancestorType) | |
Gets the first ancestor of the specified object type. | ||
java.lang.String | getText() | |
Gets the text of this node and of all its children. | ||
Node | nextPreOrder(Node rootNode) | |
Gets next node according to the pre-order tree traversal algorithm. | ||
static java.lang.String | nodeTypeToString(int nodeType) | |
A utility method that converts a node type enum value into a user friendly string. | ||
Node | previousPreOrder(Node rootNode) | |
Gets the previous node according to the pre-order tree traversal algorithm. | ||
void | remove() | |
Removes itself from the parent. | ||
java.lang.String | toString(int saveFormat) | |
Exports the content of the node into a string in the specified format. | ||
java.lang.String | toTxt() | |
Exports the content of the node into a string in plain text format. |
Property Getters/Setters Detail |
---|
getDocument | |
public DocumentBase getDocument() |
The node always belongs to a document even if it has just been created and not yet added to the tree, or if it has been removed from the tree.
isComposite | |
public boolean isComposite() |
getNextSibling | |
public Node getNextSibling() |
getNodeType | |
public abstract int getNodeType() |
getParentNode | |
public CompositeNode getParentNode() |
If a node has just been created and not yet added to the tree, or if it has been removed from the tree, the parent is null.
getPreviousSibling | |
public Node getPreviousSibling() |
getRange | |
public Range getRange() |
Method Detail |
---|
accept | |
public abstract boolean accept(DocumentVisitor visitor) throws java.lang.Exception |
Enumerates over this node and all of its children. Each node calls a corresponding method on DocumentVisitor.
For more info see the Visitor design pattern.
visitor
- The visitor that will visit the nodes.deepClone | |
public Node deepClone(boolean isCloneChildren) |
This method serves as a copy constructor for nodes. The cloned node has no parent, but belongs to the same document as the original node.
This method always performs a deep copy of the node. The isCloneChildren parameter specifies whether to perform copy all child nodes as well.
isCloneChildren
- True to recursively clone the subtree under the specified node;
false to clone only the node itself.getAncestor | |
public CompositeNode getAncestor(int ancestorType) |
ancestorType
- A getAncestor | |
public CompositeNode getAncestor(java.lang.Class ancestorType) |
The ancestor type matches if it is equal to ancestorType or derived from ancestorType.
ancestorType
- The object type of the ancestor to retrieve.getText | |
public java.lang.String getText() |
The returned string includes all control and special characters as described in
nextPreOrder | |
public Node nextPreOrder(Node rootNode) |
rootNode
- The top node (limit) of traversal.nodeTypeToString | |
public static java.lang.String nodeTypeToString(int nodeType) |
nodeType
- A NodeType value.previousPreOrder | |
public Node previousPreOrder(Node rootNode) |
rootNode
- The top node (limit) of traversal.remove | |
public void remove() |
toString | |
public java.lang.String toString(int saveFormat) throws java.lang.Exception |
saveFormat
- A SaveFormat value.toTxt | |
public java.lang.String toTxt() throws java.lang.Exception |
This method removes field codes and Microsoft Word control characters, uses CrLf
(or any other) combination of characters to mark ends of paragraphs in the resulting string.
It produces a different result from