java.lang.ObjectNode
com.aspose.words.CompositeNode
public abstract class CompositeNode
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 | ||
---|---|---|
NodeCollection | getChildNodes() | |
Gets all immediate child nodes of this node. | ||
int | getCount() | |
Gets the number of immediate children of this node. | ||
DocumentBase | getDocument() | → inherited from Node |
Gets the document to which this node belongs. | ||
Node | getFirstChild() | |
Gets the first child of the node. | ||
boolean | hasChildNodes() | |
Returns true if this node has any child nodes. | ||
boolean | isComposite() | |
Returns true as this node can have child nodes. | ||
Node | getLastChild() | |
Gets the last child of the node. | ||
Node | getNextSibling() | → inherited from Node |
Gets the node immediately following this node. | ||
abstract int | getNodeType() | → inherited from Node |
Gets the type of this node. The value of the property is NodeType integer constant. | ||
CompositeNode | getParentNode() | → inherited from Node |
Gets the immediate parent of this node. | ||
Node | getPreviousSibling() | → inherited from Node |
Gets the node immediately preceding this node. | ||
Range | getRange() | → inherited from Node |
Returns a Range object that represents the portion of a document that is contained in this node. |
Method Summary | ||
---|---|---|
abstract boolean | accept(DocumentVisitor visitor) | → inherited from Node |
Accepts a visitor. | ||
Node | appendChild(Node newChild) | |
Adds the specified node to the end of the list of child nodes for this node. | ||
Node | deepClone(boolean isCloneChildren) | → inherited from Node |
Creates a duplicate of the node. | ||
CompositeNode | getAncestor(int ancestorType) | → inherited from Node |
Gets the first ancestor of the specified |
||
CompositeNode | getAncestor(java.lang.Class ancestorType) | → inherited from Node |
Gets the first ancestor of the specified object type. | ||
Node | getChild(int nodeType, int index, boolean isDeep) | |
Returns an Nth child node that matches the specified type. | ||
NodeCollection | getChildNodes(int nodeType, boolean isDeep) | |
Returns a live collection of child nodes that match the specified type. | ||
CompositeNode | getContainer() | |
Reserved for internal use. | ||
Node | getNextMatchingNode(aspose.obfuscated.type curNode) | |
Reserved for internal use. | ||
java.lang.String | getText() | |
Gets the text of this node and of all its children. | ||
int | indexOf(Node child) | |
Returns the index of the specified child node in the child node array. | ||
Node | insertAfter(Node newChild, Node refChild) | |
Inserts the specified node immediately after the specified reference node. | ||
Node | insertBefore(Node newChild, Node refChild) | |
Inserts the specified node immediately before the specified reference node. | ||
java.util.Iterator | iterator() | |
Provides support for the for each style iteration over the child nodes of this node. | ||
Node | nextPreOrder(Node rootNode) | → inherited from Node |
Gets next node according to the pre-order tree traversal algorithm. | ||
Node | prependChild(Node newChild) | |
Adds the specified node to the beginning of the list of child nodes for this node. | ||
Node | previousPreOrder(Node rootNode) | → inherited from Node |
Gets the previous node according to the pre-order tree traversal algorithm. | ||
void | remove() | → inherited from Node |
Removes itself from the parent. | ||
void | removeAllChildren() | |
Removes all the child nodes of the current node. | ||
Node | removeChild(Node oldChild) | |
Removes the specified child node. | ||
void | removeSmartTags() | |
Removes all |
||
NodeList | selectNodes(java.lang.String xpath) | |
Selects a list of nodes matching the XPath expression. | ||
Node | selectSingleNode(java.lang.String xpath) | |
Selects the first Node that matches the XPath expression. | ||
java.lang.String | toString(int saveFormat) | → inherited from Node |
Exports the content of the node into a string in the specified format. | ||
java.lang.String | toTxt() | → inherited from Node |
Exports the content of the node into a string in plain text format. |
Property Getters/Setters Detail |
---|
getChildNodes | |
public NodeCollection getChildNodes() |
Note, GetChildNodes(NodeType.Any, false)
and creates and returns a new collection every time it is accessed.
If there are no child nodes, this property returns an empty collection.
getCount | |
public int getCount() |
getDocument | → inherited from Node |
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.
getFirstChild | |
public Node getFirstChild() |
hasChildNodes | |
public boolean hasChildNodes() |
isComposite | |
public boolean isComposite() |
getLastChild | |
public Node getLastChild() |
getNextSibling | → inherited from Node |
public Node getNextSibling() |
getNodeType | → inherited from Node |
public abstract int getNodeType() |
getParentNode | → inherited from Node |
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 | → inherited from Node |
public Node getPreviousSibling() |
getRange | → inherited from Node |
public Range getRange() |
Method Detail |
---|
accept | → inherited from Node |
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.appendChild | |
public Node appendChild(Node newChild) |
If the newChild is already in the tree, it is first removed.
If the node being inserted was created from another document, you should use
newChild
- The node to add.deepClone | → inherited from Node |
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 | → inherited from Node |
public CompositeNode getAncestor(int ancestorType) |
ancestorType
- A getAncestor | → inherited from Node |
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.getChild | |
public Node getChild(int nodeType, int index, boolean isDeep) |
If index is out of range, a null is returned.
nodeType
- A index
- Zero based index of the child node to select.
Negative indexes are also allowed and indicate access from the end,
that is -1 means the last node.isDeep
- True to select from all child nodes recursively.
False to select only among immediate children. See remarks for more info.getChildNodes | |
public NodeCollection getChildNodes(int nodeType, boolean isDeep) |
The collection of nodes returned by this method is always live.
A live collection is always in sync with the document. For example, if you selected all sections in a document and enumerate through the collection deleting the sections, the section is removed from the collection immediately when it is removed from the document.
nodeType
- A isDeep
- True to select from all child nodes recursively.
False to select only among immediate children. getContainer | |
public CompositeNode getContainer() |
getNextMatchingNode | |
public Node getNextMatchingNode(aspose.obfuscated.type curNode) |
getText | |
public java.lang.String getText() |
The returned string includes all control and special characters as described in
indexOf | |
public int indexOf(Node child) |
insertAfter | |
public Node insertAfter(Node newChild, Node refChild) |
If refChild is null, inserts newChild at the beginning of the list of child nodes.
If the newChild is already in the tree, it is first removed.
If the node being inserted was created from another document, you should use
newChild
- The Node to insert.refChild
- The Node that is the reference node. The newNode is placed after the refNode. insertBefore | |
public Node insertBefore(Node newChild, Node refChild) |
If refChild is null, inserts newChild at the end of the list of child nodes.
If the newChild is already in the tree, it is first removed.
If the node being inserted was created from another document, you should use
newChild
- The Node to insert.refChild
- The Node that is the reference node. The newChild is placed before this node.iterator | |
public java.util.Iterator iterator() |
nextPreOrder | → inherited from Node |
public Node nextPreOrder(Node rootNode) |
rootNode
- The top node (limit) of traversal.prependChild | |
public Node prependChild(Node newChild) |
If the newChild is already in the tree, it is first removed.
If the node being inserted was created from another document, you should use
newChild
- The node to add.previousPreOrder | → inherited from Node |
public Node previousPreOrder(Node rootNode) |
rootNode
- The top node (limit) of traversal.remove | → inherited from Node |
public void remove() |
removeAllChildren | |
public void removeAllChildren() |
removeChild | |
public Node removeChild(Node oldChild) |
The parent of oldChild is set to null after the node is removed.
oldChild
- The node to remove.removeSmartTags | |
public void removeSmartTags() |
selectNodes | |
public NodeList selectNodes(java.lang.String xpath) |
Only expressions with element names are supported at the moment. Expressions that use attribute names are not supported.
xpath
- The XPath expression.selectSingleNode | |
public Node selectSingleNode(java.lang.String xpath) |
Only expressions with element names are supported at the moment. Expressions that use attribute names are not supported.
xpath
- The XPath expression.toString | → inherited from Node |
public java.lang.String toString(int saveFormat) throws java.lang.Exception |
saveFormat
- A SaveFormat value.toTxt | → inherited from Node |
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