org.itsnat.core.domutil

Interface ElementTreeNodeList

All Superinterfaces:

ElementGroup, ItsNatUserData

public interface ElementTreeNodeList
extends ElementGroup

Represents a pattern based DOM tree node list.

The starting point may be a tree node list with almost a child tree node, this first child element is saved as the pattern (really a deep clone). If the list is initially empty the pattern used is the pattern of the parent tree node. New child tree nodes in the list are created using this pattern. The initial tree node list (including the pattern) may be initially cleared or kept as is when this object is created and attached to the underlying DOM list.

Author:

Jose Maria Arranz Santamaria

See Also:

ElementGroupManager.createElementTreeNodeList(boolean,Element,boolean,ElementTreeNodeStructure,ElementTreeNodeRenderer), ElementTreeNode.getChildTreeNodeList()

Method Summary

Methods

Modifier and Type	Method and Description
ElementTreeNode	addTreeNode() Adds a new child tree node at the end of the list using the pattern (the new tree node markup is a clone).
ElementTreeNode	addTreeNode(Object value) Adds a new child tree node at the end of the list and renders the specified value using the current structure and renderer.
Element	getChildPatternElement() Returns the element used as a pattern.
ElementTreeNode	getElementTreeNodeFromNode(Node node) Returns the tree node containing the specified node.
ElementTreeNodeRenderer	getElementTreeNodeRenderer() Returns the current renderer defined in this tree node list.
ElementTreeNodeStructure	getElementTreeNodeStructure() Returns the current structure defined in this tree node list.
ElementTreeNode	getFirstTreeNode() Returns the first child tree node (position 0).
ElementTreeNode	getLastTreeNode() Returns the last child tree node (position getLength() - 1).
int	getLength() Returns the number of child tree nodes in the list.
int	getRowCount() Returns the number of rows in the list.
ElementTreeNode	getTreeNodeAt(int index) Returns the tree node at the specified index.
ElementTreeNode[]	getTreeNodes() Returns the tree node list as an array.
ElementTreeNode	insertTreeNodeAt(int index) Inserts a new child tree node at the specified position using the pattern (the new tree node markup is a clone).
ElementTreeNode	insertTreeNodeAt(int index, Object value) Inserts a new child tree node at the specified position and renders the specified value using the current structure and renderer.
boolean	isEmpty() Informs whether the tree node list is empty.
boolean	isUsePatternMarkupToRender() Informs whether the original (saved as pattern) markup is used to render.
void	removeAllTreeNodes() Removes all tree nodes.
ElementTreeNode	removeTreeNodeAt(int index) Removes the specified tree node.
void	removeTreeNodeRange(int fromIndex, int toIndex) Removes the tree nodes between the specified indexes.
void	setElementTreeNodeRenderer(ElementTreeNodeRenderer renderer) Sets the renderer defined in this tree node list.
void	setElementTreeNodeStructure(ElementTreeNodeStructure structure) Sets the structure defined in this tree node list.
void	setLength(int len) Increases or shrinks the list to fit the new size.
void	setUsePatternMarkupToRender(boolean value) Sets whether the original (saved as pattern) markup is used to render.

Methods inherited from interface org.itsnat.core.domutil.ElementGroup

getItsNatDocument, getParentElement

Methods inherited from interface org.itsnat.core.ItsNatUserData

containsUserValueName, getUserValue, getUserValueNames, removeUserValue, setUserValue

Method Detail

getElementTreeNodeStructure

ElementTreeNodeStructure getElementTreeNodeStructure()

Returns the current structure defined in this tree node list.

Returns:

the current structure.

See Also:

setElementTreeNodeStructure(ElementTreeNodeStructure)

setElementTreeNodeStructure

void setElementTreeNodeStructure(ElementTreeNodeStructure structure)

Sets the structure defined in this tree node list.

Parameters:

structure - the new structure.

See Also:

getElementTreeNodeStructure()

getElementTreeNodeRenderer

ElementTreeNodeRenderer getElementTreeNodeRenderer()

Returns the current renderer defined in this tree node list.

Returns:

the current renderer.

See Also:

setElementTreeNodeRenderer(ElementTreeNodeRenderer)

setElementTreeNodeRenderer

void setElementTreeNodeRenderer(ElementTreeNodeRenderer renderer)

Sets the renderer defined in this tree node list.

Parameters:

renderer - the new renderer.

See Also:

getElementTreeNodeRenderer()

getChildPatternElement

Element getChildPatternElement()

Returns the element used as a pattern. This element is a clone of the original first child tree node (if the pattern was obtained with).

Returns:

the pattern element.

isEmpty

boolean isEmpty()

Informs whether the tree node list is empty.

Returns:

true if the tree node list is empty.

removeTreeNodeAt

ElementTreeNode removeTreeNodeAt(int index)

Removes the specified tree node.

Parameters:

index - index of the child tree node to remove.

Returns:

the removed tree node or null if index is out of bounds.

removeTreeNodeRange

void removeTreeNodeRange(int fromIndex,
                       int toIndex)

Removes the tree nodes between the specified indexes.

Parameters:

fromIndex - low index (inclusive).

toIndex - high index (inclusive).

removeAllTreeNodes

void removeAllTreeNodes()

Removes all tree nodes. The tree node list is now empty.

getTreeNodes

ElementTreeNode[] getTreeNodes()

Returns the tree node list as an array.

Returns:

the tree node array.

getTreeNodeAt

ElementTreeNode getTreeNodeAt(int index)

Returns the tree node at the specified index.

Parameters:

index - index of the tree node to search.

Returns:

the tree node in this position or null if index is out of range.

getFirstTreeNode

ElementTreeNode getFirstTreeNode()

Returns the first child tree node (position 0).

Returns:

the first child tree node or null is the list is empty.

getLastTreeNode

ElementTreeNode getLastTreeNode()

Returns the last child tree node (position getLength() - 1).

Returns:

the last child tree node or null is the list is empty.

getElementTreeNodeFromNode

ElementTreeNode getElementTreeNodeFromNode(Node node)

Returns the tree node containing the specified node. The search is performed in the full subtree, so the returned tree node may not be a direct child node (may be a tree node child of a tree node list child and so on).

Parameters:

node - the node to search for.

Returns:

the tree node containing the specified node. Null if this node is not contained by the list.

getLength

int getLength()

Returns the number of child tree nodes in the list.

Returns:

the list size.

See Also:

setLength(int)

getRowCount

int getRowCount()

Returns the number of rows in the list.

Returns:

the number of rows.

setLength

void setLength(int len)

Increases or shrinks the list to fit the new size.

If the new size is bigger new tree nodes are added at the end, if the size is lower tail tree nodes are removed.

Parameters:

len - the new length.

See Also:

getLength(), addTreeNode(), removeTreeNodeAt(int)

addTreeNode

ElementTreeNode addTreeNode()

Adds a new child tree node at the end of the list using the pattern (the new tree node markup is a clone).

The new tree node uses the current structure and renderer of the list.

Returns:

the new tree node.

See Also:

addTreeNode(Object)

addTreeNode

ElementTreeNode addTreeNode(Object value)

Adds a new child tree node at the end of the list and renders the specified value using the current structure and renderer.

Parameters:

value - the value to render.

Returns:

the new tree node.

See Also:

addTreeNode(), getElementTreeNodeStructure(), getElementTreeNodeRenderer()

insertTreeNodeAt

ElementTreeNode insertTreeNodeAt(int index)

Inserts a new child tree node at the specified position using the pattern (the new tree node markup is a clone).

The new tree node uses the current structure and renderer of the list.

Parameters:

index - index of the new tree node.

Returns:

the new tree node.

See Also:

insertTreeNodeAt(int,Object)

insertTreeNodeAt

ElementTreeNode insertTreeNodeAt(int index,
                               Object value)

Inserts a new child tree node at the specified position and renders the specified value using the current structure and renderer.

Parameters:

index - index of the tree node.

value - the value to render.

Returns:

the new tree node.

See Also:

insertTreeNodeAt(int), getElementTreeNodeStructure(), getElementTreeNodeRenderer()

isUsePatternMarkupToRender

boolean isUsePatternMarkupToRender()

Informs whether the original (saved as pattern) markup is used to render.

The default value is defined by the parent tree node if exists or by ItsNatDocument.isUsePatternMarkupToRender()

Returns:

true if the original markup is used.

See Also:

setUsePatternMarkupToRender(boolean)

setUsePatternMarkupToRender

void setUsePatternMarkupToRender(boolean value)

Sets whether the original (saved as pattern) markup is used to render.

Parameters:

value - true to enable the use of original markup to render.

See Also:

isUsePatternMarkupToRender()