com.aspose.note

Class CompositeNode<T extends INode>

java.lang.Object

com.aspose.note.Node

com.aspose.note.CompositeNodeBase

com.aspose.note.CompositeNode<T>

All Implemented Interfaces:

com.aspose.ms.System.Collections.Generic.IGenericEnumerable<T>, com.aspose.ms.System.Collections.IEnumerable<T>, ICompositeNode, INode, Iterable<T>

Direct Known Subclasses:

Document, Outline, OutlineElement, OutlineGroup, Page, Table, TableCell, TableRow, Title

public abstract class CompositeNode<T extends INode>
extends CompositeNodeBase
implements com.aspose.ms.System.Collections.Generic.IGenericEnumerable<T>

The base generic class for nodes that can contain other nodes.

T: The type of elements in the composite node.

Method Summary

Modifier and Type	Method and Description
void	accept(DocumentVisitor visitor) Accepts the visitor of the node.
<T1 extends T> T1	appendChildFirst(T1 newChild) Adds the node to the front of the list of child nodes for this node.
<T1 extends T> T1	appendChildLast(T1 newChild) Adds the node to the end of the list of child nodes for this node.
<T1 extends INode> List<T1>	getChildNodes(Class<T1> typeParameterClass) Get all child nodes by the node type.
List<T>	getChildren() Gets all child nodes of this node as an enumerable collection.
T	getFirstChild() Gets the first child node of this node.
T	getLastChild() Gets the last child node of this node.
<T1 extends T> T1	insertChild(int i, T1 newChild) Inserts the node to the specified position in the list of child nodes for this node.
void	insertChildrenRange(int i, Iterable<T> newChildren) Inserts the node's sequence starting from specified position in the list of child nodes for this node.
void	insertChildrenRange(int i, T... newChildren) Inserts the node's sequence starting from specified position in the list of child nodes for this node.
boolean	isComposite() Checks whether the node is composite.
com.aspose.ms.System.Collections.Generic.IGenericEnumerator<T>	iterator() Returns an enumerator that iterates through child nodes of the CompositeNode{T}.
<T1 extends T> T1	removeChild(T1 oldChild) Removes the child node.

Methods inherited from class com.aspose.note.Node

getDocument, getNextSibling, getNodeType, getParentNode, getPreviousSibling

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

isComposite

public final boolean isComposite()

Checks whether the node is composite. If true then the node can have child nodes.

Overrides:

isComposite in class Node

getFirstChild

public T getFirstChild()

Gets the first child node of this node.

getLastChild

public T getLastChild()

Gets the last child node of this node.

getChildren

public List<T> getChildren()

Gets all child nodes of this node as an enumerable collection.

iterator

public com.aspose.ms.System.Collections.Generic.IGenericEnumerator<T> iterator()

Returns an enumerator that iterates through child nodes of the CompositeNode{T}.

Specified by:

iterator in interface com.aspose.ms.System.Collections.Generic.IGenericEnumerable<T extends INode>

Specified by:

iterator in interface com.aspose.ms.System.Collections.IEnumerable<T extends INode>

Specified by:

iterator in interface Iterable<T extends INode>

Returns:

A T:IEnumerator`1 for the CompositeNode{T}.

insertChild

public <T1 extends T> T1 insertChild(int i,
                                     T1 newChild)

Inserts the node to the specified position in the list of child nodes for this node.

Parameters:

i - Position to insert

newChild - The node to insert.

Returns:

The added node.

insertChildrenRange

public final void insertChildrenRange(int i,
                                      Iterable<T> newChildren)

Inserts the node's sequence starting from specified position in the list of child nodes for this node.

Parameters:

i - Position to insert

newChildren - The sequence of nodes to be inserted.

insertChildrenRange

public final void insertChildrenRange(int i,
                                      T... newChildren)

Inserts the node's sequence starting from specified position in the list of child nodes for this node.

Parameters:

i - Position to insert

newChildren - The sequence of nodes to be inserted.

appendChildFirst

public <T1 extends T> T1 appendChildFirst(T1 newChild)

Adds the node to the front of the list of child nodes for this node.

Parameters:

newChild - The node to add.

Returns:

The added node.

appendChildLast

public <T1 extends T> T1 appendChildLast(T1 newChild)

Adds the node to the end of the list of child nodes for this node.

Parameters:

newChild - The node to add.

Returns:

The added node.

removeChild

public <T1 extends T> T1 removeChild(T1 oldChild)

Removes the child node.

Parameters:

oldChild - The node to remove.

Returns:

The removed node.

accept

public void accept(DocumentVisitor visitor)

Accepts the visitor of the node.

Specified by:

accept in interface INode

Specified by:

accept in class Node

Parameters:

visitor - The object of a class derived from the DocumentVisitor.

getChildNodes

public <T1 extends INode> List<T1> getChildNodes(Class<T1> typeParameterClass)

Get all child nodes by the node type.

Specified by:

getChildNodes in interface ICompositeNode

Returns:

A list of child nodes.

T1: The type of elements in the returned list.