org.itsnat.comp.tree

Interface ItsNatTreeCellUI

All Superinterfaces:

ItsNatUserData

public interface ItsNatTreeCellUI
extends ItsNatUserData

Contains visual information of a tree node.

This interface is the "componentized" version of ElementTreeNode and follows a similar philosophy. The objective is similar to ItsNatListCellUI applied to tree nodes. Child index, row, tree path, deep level etc are tolerant to tree changes (are automatically updated).

Author:

Jose Maria Arranz Santamaria

See Also:

ItsNatTreeUI.getItsNatTreeCellUIFromRow(int), ItsNatTreeUI.getItsNatTreeCellUIFromNode(org.w3c.dom.Node)

Method Summary

Methods

Modifier and Type	Method and Description
void	expand(boolean expandState) Sets the new expand state.
int	getChildCount() Returns the number of direct child nodes of this node.
ItsNatTreeCellUI	getChildItsNatTreeCellUIAt(int index) Returns the direct child tree node UI at the specified position.
org.w3c.dom.Element	getContentElement() Returns the content element of this tree node.
int	getDeepLevel() Returns the deep (number of parents) of this node.
org.w3c.dom.Element	getHandleElement() Returns the handle element of this tree node.
org.w3c.dom.Element	getIconElement() Returns the icon element of this tree node.
int	getIndex() Returns the zero based index of this node as a child relative to the parent.
ItsNatTreeUI	getItsNatTreeUI() Returns the parent tree UI this object belongs to.
org.w3c.dom.Element	getLabelElement() Returns the label element of this tree node.
org.w3c.dom.Element	getParentElement() Returns the parent element containing this tree node.
int	getRow() Returns the row index of this node seeing the tree as a list. 0 if this node is the root regardless this tree is rootless or not (if rootless never returns 0 because root node has not markup/tree node UI).
ItsNatTreeCellUI	getTreeNodeUIParent() Returns the parent tree node UI of this node.
ItsNatTreeCellUI[]	getTreeNodeUIPath() Returns an array with tree node UI objects from this node to the top most (usually the root).
javax.swing.tree.TreePath	getTreePath() Returns the tree path of this node.
boolean	isExpanded() Returns the current expand state.

Methods inherited from interface org.itsnat.core.ItsNatUserData

containsUserValueName, getUserValue, getUserValueNames, removeUserValue, setUserValue

Method Detail

getItsNatTreeUI

ItsNatTreeUI getItsNatTreeUI()

Returns the parent tree UI this object belongs to.

Returns:

the parent tree UI.

getTreeNodeUIParent

ItsNatTreeCellUI getTreeNodeUIParent()

Returns the parent tree node UI of this node.

Returns:

the parent tree node UI.

getTreeNodeUIPath

ItsNatTreeCellUI[] getTreeNodeUIPath()

Returns an array with tree node UI objects from this node to the top most (usually the root).

Element at 0 is the top most node; if this tree is not rootless 0 element is the root, otherwise is the top most parent node containing this node.

Returns:

an array with this object and any parent tree node UI.

getParentElement

org.w3c.dom.Element getParentElement()

Returns the parent element containing this tree node.

Returns:

the parent element of this node.

See Also:

ItsNatTreeUI.getParentElementFromRow(int)

getContentElement

org.w3c.dom.Element getContentElement()

Returns the content element of this tree node.

Returns:

the content element of this node.

See Also:

ItsNatTreeUI.getContentElementFromRow(int)

getHandleElement

org.w3c.dom.Element getHandleElement()

Returns the handle element of this tree node.

Returns:

the handle element of this node.

See Also:

ItsNatTreeUI.getHandleElementFromRow(int)

getIconElement

org.w3c.dom.Element getIconElement()

Returns the icon element of this tree node.

Returns:

the icon element of this node.

See Also:

ItsNatTreeUI.getIconElementFromRow(int)

getLabelElement

org.w3c.dom.Element getLabelElement()

Returns the label element of this tree node.

Returns:

the label element of this node.

See Also:

ItsNatTreeUI.getLabelElementFromRow(int)

getIndex

int getIndex()

Returns the zero based index of this node as a child relative to the parent.

Returns:

the index of this node relative to the parent. -1 if this node is a root or a top most node (rootless tree).

getChildCount

int getChildCount()

Returns the number of direct child nodes of this node.

Returns:

the number of child nodes.

getChildItsNatTreeCellUIAt

ItsNatTreeCellUI getChildItsNatTreeCellUIAt(int index)

Returns the direct child tree node UI at the specified position.

Parameters:

index - zero based index of the child node position.

Returns:

the child tree node.

getRow

int getRow()

Returns the row index of this node seeing the tree as a list. 0 if this node is the root regardless this tree is rootless or not (if rootless never returns 0 because root node has not markup/tree node UI).

Returns:

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

See Also:

ItsNatTreeUI.getItsNatTreeCellUIFromRow(int)

expand

void expand(boolean expandState)

Sets the new expand state.

Current implementation does not perform DOM changes and only serves to save expand state. Future versions might use this method to render visually the markup effect of the expansion/collapse.

Expand state of child or parent nodes is not affected.

Parameters:

expandState - the new state.

See Also:

isExpanded(), ItsNatTree.expandNode(javax.swing.tree.TreePath), ItsNatTree.collapseNode(javax.swing.tree.TreePath)

isExpanded

boolean isExpanded()

Returns the current expand state.

Returns:

the current expand state, true by default.

See Also:

expand(boolean), ItsNatTree.isExpandedNode(javax.swing.tree.TreePath)

getDeepLevel

int getDeepLevel()

Returns the deep (number of parents) of this node. If this node is root or a top most (rootless case) returns 0.

Returns:

the deep level of this node.

getTreePath

javax.swing.tree.TreePath getTreePath()

Returns the tree path of this node.

Returns:

the tree path.