org.itsnat.core.domutil

Interface ElementTreeNode

All Superinterfaces:

ElementGroup, ItsNatUserData

public interface ElementTreeNode
extends ElementGroup

Represents a pattern based DOM tree node. A tree node contains (may contain) a handle, an icon and a label elements (these three are the node "content"), and may have child nodes. The tree node structure is used as pattern to create child tree nodes (by using a deep clone), so all child tree nodes have the same structure (same as the pattern), unless there is one child node in markup.

This interface supports "out the box" the typical DOM tree node structure with handle, icon and label elements:

   <parent>
     <content><handle/><icon/><label>markup of label</label></content>
     <children>
      ...child tree nodes go here
     </children>
   </parent>
 

The label element is normally used to render below the value associated to node. The method setValue(Object) is used to render this value, the structure and renderer objects are used to customize how and where this value is saved in the tree node beyond the default cases.

A pattern based DOM tree node ever works in "master" mode, see ElementListFree.isMaster().

Author:

Jose Maria Arranz Santamaria

See Also:

ElementGroupManager.createElementTreeNode(org.w3c.dom.Element,boolean)

Method Summary

Methods

Modifier and Type	Method and Description
org.w3c.dom.Element	getChildListElement() Returns the parent element of the child tree nodes.
ElementTreeNodeList	getChildTreeNodeList() Returns the child tree node list of this tree node.
org.w3c.dom.Element	getContentElement() Returns the content element.
int	getDeepLevel() Returns the number of levels (parents) above.
ElementTreeNode	getElementTreeNodeFromNode(org.w3c.dom.Node node) Returns this tree node or the tree node containing the specified node.
ElementTreeNode	getElementTreeNodeParent() Returns the parent tree node if exists.
ElementTreeNodeRenderer	getElementTreeNodeRenderer() Returns the current renderer used by this tree node.
ElementTreeNodeStructure	getElementTreeNodeStructure() Returns the current structure used by this tree node.
org.w3c.dom.Element	getHandleElement() Returns the handle element.
org.w3c.dom.Element	getIconElement() Returns the icon element.
int	getIndex() Returns the index of this node as a child of its node parent.
org.w3c.dom.DocumentFragment	getLabelContentPatternFragment() Returns the pattern used to render values if isUsePatternMarkupToRender() is true.
org.w3c.dom.Element	getLabelElement() Returns the label element.
ElementTreeNode	getNextSiblingTreeNode() Returns the tree node immediately following this tree node (same level).
ElementTreeNode	getNextTreeNode() Returns the next tree node in the logical order of the tree (seen as a list).
ElementTreeNode	getPreviousSiblingTreeNode() Returns the tree node immediately preceding this tree node (same level).
ElementTreeNode	getPreviousTreeNode() Returns the previous tree node in the logical order of the tree (seen as a list).
int	getRow() Returns the row index of this node seeing the tree as a list.
int	getRowCount() Returns the number of rows below this tree node including itself.
boolean	isLeaf() Informs whether this node is a leaf, it does not contain child nodes.
boolean	isTreeTable() Informs whether this node is part of a tree table.
boolean	isUsePatternMarkupToRender() Informs whether the original (saved as pattern) markup is used to render.
void	setElementTreeNodeRenderer(ElementTreeNodeRenderer renderer) Sets the renderer used by this tree node.
void	setUsePatternMarkupToRender(boolean value) Sets whether the original (saved as pattern) markup is used to render.
void	setValue(java.lang.Object value) Renders the submitted value into the tree node markup using the current renderer.

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 used by this tree node.

Returns:

the current structure.

getElementTreeNodeRenderer

ElementTreeNodeRenderer getElementTreeNodeRenderer()

Returns the current renderer used by this tree node.

Returns:

the current renderer.

setElementTreeNodeRenderer

void setElementTreeNodeRenderer(ElementTreeNodeRenderer renderer)

Sets the renderer used by this tree node.

Parameters:

renderer - the new renderer.

getRowCount

int getRowCount()

Returns the number of rows below this tree node including itself.

Returns:

the number of rows. Min value is 1 (this node).

getElementTreeNodeParent

ElementTreeNode getElementTreeNodeParent()

Returns the parent tree node if exists.

Returns:

the parent tree node, null if this node is root or rootless tree.

getContentElement

org.w3c.dom.Element getContentElement()

Returns the content element. This element usually contains the handle, icon and label elements. The current structure is used to obtain this element.

Returns:

the content element.

See Also:

getElementTreeNodeStructure(), ElementTreeNodeStructure.getContentElement(ElementTreeNode,Element)

getHandleElement

org.w3c.dom.Element getHandleElement()

Returns the handle element. The current structure is used to obtain this element.

Returns:

the handle element.

See Also:

getElementTreeNodeStructure(), ElementTreeNodeStructure.getHandleElement(ElementTreeNode,Element)

getIconElement

org.w3c.dom.Element getIconElement()

Returns the icon element. The current structure is used to obtain this element.

Returns:

the icon element.

See Also:

getElementTreeNodeStructure(), ElementTreeNodeStructure.getIconElement(ElementTreeNode,Element)

getLabelElement

org.w3c.dom.Element getLabelElement()

Returns the label element. The current structure is used to obtain this element.

Returns:

the label element.

See Also:

getElementTreeNodeStructure(), ElementTreeNodeStructure.getLabelElement(ElementTreeNode,Element)

getChildListElement

org.w3c.dom.Element getChildListElement()

Returns the parent element of the child tree nodes. The current structure is used to obtain this element.

Returns:

the parent of child nodes.

See Also:

getElementTreeNodeStructure(), ElementTreeNodeStructure.getChildListElement(ElementTreeNode,Element)

setValue

void setValue(java.lang.Object value)

Renders the submitted value into the tree node markup using the current renderer.

Parameters:

value - the value to render.

See Also:

getElementTreeNodeRenderer(), ElementTreeNodeRenderer.renderTreeNode(ElementTreeNode,Object,Element,boolean)

getIndex

int getIndex()

Returns the index of this node as a child of its node parent.

Returns:

the position as child, -1 if root.

See Also:

getElementTreeNodeParent()

getRow

int getRow()

Returns the row index of this node seeing the tree as a list.

Returns:

the row index, 0 if root.

getDeepLevel

int getDeepLevel()

Returns the number of levels (parents) above.

Returns:

the number of levels, 0 if root or a child node of the root list in a rootless tree.

isLeaf

boolean isLeaf()

Informs whether this node is a leaf, it does not contain child nodes.

Returns:

true if this node is a leaf.

getElementTreeNodeFromNode

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

Returns this tree node or 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 node or child tree nodes.

getChildTreeNodeList

ElementTreeNodeList getChildTreeNodeList()

Returns the child tree node list of this tree node.

Returns:

the child tree node list

getPreviousTreeNode

ElementTreeNode getPreviousTreeNode()

Returns the previous tree node in the logical order of the tree (seen as a list).

Returns:

the previous tree node.

getNextTreeNode

ElementTreeNode getNextTreeNode()

Returns the next tree node in the logical order of the tree (seen as a list).

Returns:

the next tree node.

getPreviousSiblingTreeNode

ElementTreeNode getPreviousSiblingTreeNode()

Returns the tree node immediately preceding this tree node (same level).

Returns:

the previous sibling or null if there is no such tree node.

getNextSiblingTreeNode

ElementTreeNode getNextSiblingTreeNode()

Returns the tree node immediately following this tree node (same level).

Returns:

the next sibling or null if there is no such tree node.

isTreeTable

boolean isTreeTable()

Informs whether this node is part of a tree table.

Returns:

true if this node is part of a tree table.

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 list 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()

getLabelContentPatternFragment

org.w3c.dom.DocumentFragment getLabelContentPatternFragment()

Returns the pattern used to render values if isUsePatternMarkupToRender() is true.

Returns:

the pattern used to render values.