org.itsnat.core.domutil

Interface ElementTree

All Superinterfaces:

ElementGroup, ItsNatUserData

public interface ElementTree
extends ElementGroup

Represents a pattern based DOM tree with a removable root. This structure may be seen as a tree node list with none or only one tree node.

The starting point is a root DOM tree node, this node is saved as the pattern (really a deep clone). This pattern is used to recreate the root node (the root may be removed).

The initial root tree node may be initially removed or kept as is when this tree is created and attached to the underlying DOM.

Author:

Jose Maria Arranz Santamaria

See Also:

ElementGroupManager.createElementTree(boolean,Element,boolean,ElementTreeNodeStructure,ElementTreeNodeRenderer)

Method Summary

Methods

Modifier and Type	Method and Description
ElementTreeNode	addRootNode() Adds a root tree node.
ElementTreeNode	addRootNode(java.lang.Object value) Adds a root tree node and renders the value using the current structure and renderer.
ElementTreeNode	getElementTreeNodeFromNode(org.w3c.dom.Node node) Returns the tree node containing the specified node.
ElementTreeNode	getElementTreeNodeFromRow(int row) Returns the tree node at the specified row position seeing the tree as a list (root node is 0).
ElementTreeNodeRenderer	getElementTreeNodeRenderer() Returns the current renderer defined in this tree.
ElementTreeNodeStructure	getElementTreeNodeStructure() Returns the current structure defined in this tree.
ElementTreeNode	getRootNode() Returns the root tree node.
org.w3c.dom.Element	getRootPatternElement() Returns the element used as a pattern.
int	getRowCount() Returns the number of rows in the tree.
boolean	hasTreeNodeRoot() Informs whether the current tree has a root tree node (not empty).
boolean	isUsePatternMarkupToRender() Informs whether the original (saved as pattern) markup is used to render.
void	removeRootNode() Removes the current root tree node.
void	setElementTreeNodeRenderer(ElementTreeNodeRenderer renderer) Sets the renderer defined in this tree.
void	setElementTreeNodeStructure(ElementTreeNodeStructure structure) Sets the structure defined in this tree.
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.

Returns:

the current structure.

See Also:

setElementTreeNodeStructure(ElementTreeNodeStructure)

setElementTreeNodeStructure

void setElementTreeNodeStructure(ElementTreeNodeStructure structure)

Sets the structure defined in this tree.

Parameters:

structure - the new structure.

See Also:

getElementTreeNodeStructure()

getElementTreeNodeRenderer

ElementTreeNodeRenderer getElementTreeNodeRenderer()

Returns the current renderer defined in this tree.

Returns:

the current renderer.

See Also:

setElementTreeNodeRenderer(ElementTreeNodeRenderer)

setElementTreeNodeRenderer

void setElementTreeNodeRenderer(ElementTreeNodeRenderer renderer)

Sets the renderer defined in this tree.

Parameters:

renderer - the new renderer.

See Also:

getElementTreeNodeRenderer()

getRootPatternElement

org.w3c.dom.Element getRootPatternElement()

Returns the element used as a pattern. This element is a clone of the original root node parent element used as a pattern.

Returns:

the pattern element.

getRowCount

int getRowCount()

Returns the number of rows in the tree.

Returns:

the number of rows.

hasTreeNodeRoot

boolean hasTreeNodeRoot()

Informs whether the current tree has a root tree node (not empty).

Returns:

true if the tree has a root tree node.

See Also:

getRootNode()

getRootNode

ElementTreeNode getRootNode()

Returns the root tree node.

Returns:

the root tree node or null if the tree is empty.

See Also:

addRootNode(), removeRootNode()

addRootNode

ElementTreeNode addRootNode()

Adds a root tree node. If the tree already has a root node an exception is thrown.

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

Returns:

the new root node.

See Also:

getRootNode(), removeRootNode()

addRootNode

ElementTreeNode addRootNode(java.lang.Object value)

Adds a root tree node and renders the value using the current structure and renderer. If the tree already has a root node an exception is thrown.

Returns:

the new root node.

See Also:

addRootNode(), getElementTreeNodeStructure(), getElementTreeNodeRenderer()

removeRootNode

void removeRootNode()

Removes the current root tree node. If the tree has no root does nothing.

See Also:

getRootNode(), addRootNode()

getElementTreeNodeFromRow

ElementTreeNode getElementTreeNodeFromRow(int row)

Returns the tree node at the specified row position seeing the tree as a list (root node is 0).

Parameters:

row - the row position.

Returns:

the tree node at the specified position or null if the tree is empty or row is out of bounds.

getElementTreeNodeFromNode

ElementTreeNode getElementTreeNodeFromNode(org.w3c.dom.Node node)

Returns the tree node containing the specified node.

Parameters:

node - the node to search for.

Returns:

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

isUsePatternMarkupToRender

boolean isUsePatternMarkupToRender()

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

The default value is defined 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()