org.itsnat.comp.tree

Interface ItsNatTreeUI

All Superinterfaces:

ItsNatComponentUI, ItsNatElementComponentUI

public interface ItsNatTreeUI
extends ItsNatElementComponentUI

Is the base interface of the User Interface of a tree component.

Tree nodes are managed using the current tree structure and renderer.

Current implementation uses the tree data model when necessary and relays heavily on ElementTree and related interfaces/objects.

If the tree is visually "rootless" there is no markup to the root but the root is ever counted for indexing as row 0 (including when there is no root in data model). Method calls like getParentElementFromRow(0) returns null. This guaranties same row values for trees visually "rootless" and with visible root.

Current implementation does not use the data model on methods not containing TreePath parameters.

Author:

Jose Maria Arranz Santamaria

See Also:

ItsNatTree.getItsNatTreeUI(), ItsNatTree.getItsNatTreeCellRenderer(), ItsNatTree.getItsNatTreeStructure()

Method Summary

Methods

Modifier and Type	Method and Description
Element	getContentElementFromRow(int row) Returns the content element of the tree node at the specified row position seeing the tree as a list (root node is 0).
Element	getContentElementFromTreePath(TreePath path) Returns the content element of the tree node specified by the tree path.
Element	getHandleElementFromRow(int row) Returns the handle element of the tree node at the specified row position seeing the tree as a list (root node is 0).
Element	getHandleElementFromTreePath(TreePath path) Returns the handle element of the tree node specified by the tree path.
Element	getIconElementFromRow(int row) Returns the icon element of the tree node at the specified row position seeing the tree as a list (root node is 0).
Element	getIconElementFromTreePath(TreePath path) Returns the icon element of the tree node specified by the tree path.
ItsNatTree	getItsNatTree() Returns the associated component object.
ItsNatTreeCellUI	getItsNatTreeCellUIFromNode(Node node) Returns the object info of the tree node containing the specified node.
ItsNatTreeCellUI	getItsNatTreeCellUIFromRow(int row) Returns the object info of the tree node at the specified row position seeing the tree as a list (root node is 0).
ItsNatTreeCellUI	getItsNatTreeCellUIFromTreePath(TreePath path) Returns the object info of the tree node specified by the tree path.
Element	getLabelElementFromRow(int row) Returns the label element of the tree node at the specified row position seeing the tree as a list (root node is 0).
Element	getLabelElementFromTreePath(TreePath path) Returns the label element of the tree node specified by the tree path.
Element	getParentElementFromRow(int row) Returns the parent element of the tree node at the specified row position seeing the tree as a list (root node is 0).
Element	getParentElementFromTreePath(TreePath path) Returns the parent element of the tree node specified by the tree path.
int	getRow(int index, TreePath parentPath) Returns the row index of the child tree node at the specified position below the parent tree node specified by its path.
int	getRow(TreePath path) Returns the row index of the specified tree node.
int	getRowCount() Returns the number of rows in the tree.
int	getRowCount(int index, TreePath parentPath) Returns the number of rows contained in the child tree node at the specified position below the parent tree node specified by its path.
int	getRowCount(TreePath path) Returns the number of rows contained below the specified node including itself.
boolean	isUsePatternMarkupToRender() Informs whether the original (saved as pattern) markup is used to render.
void	setUsePatternMarkupToRender(boolean value) Sets whether the original (saved as pattern) markup is used to render.

Methods inherited from interface org.itsnat.comp.ItsNatElementComponentUI

getItsNatElementComponent

Methods inherited from interface org.itsnat.comp.ItsNatComponentUI

getItsNatComponent

Method Detail

getItsNatTree

ItsNatTree getItsNatTree()

Returns the associated component object.

Returns:

the component object.

getRowCount

int getRowCount()

Returns the number of rows in the tree. If the tree is rootless the root node is ever counted (including when there is no root in data model).

Returns:

the number of rows. If rootless min value returned is 1.

getRow

int getRow(TreePath path)

Returns the row index of the specified tree node.

Parameters:

path - the path of the tree node.

Returns:

the row index of the specified tree node.

getRowCount

int getRowCount(TreePath path)

Returns the number of rows contained below the specified node including itself.

This method uses the data model (to locate the specified tree node) but can be called including when the child nodes are missing in the data model (for instance were removed before).

Parameters:

path - the path of the tree node.

Returns:

the number of rows.

getRow

int getRow(int index,
         TreePath parentPath)

Returns the row index of the child tree node at the specified position below the parent tree node specified by its path.

This method uses the data model (to locate the parent) but can be called including when the specified child node is missing in the data model (for instance was removed before).

Parameters:

index - 0 based index of the child tree node relative to the parent.

parentPath - the path of the parent tree node.

Returns:

the row index of the specified child node.

getRowCount

int getRowCount(int index,
              TreePath parentPath)

Returns the number of rows contained in the child tree node at the specified position below the parent tree node specified by its path. The child node is counted too.

This method uses the data model (to locate the parent) but can be called including when the specified child node is missing in the data model (for instance was removed before).

Parameters:

index - 0 based index of the child tree node relative to the parent.

parentPath - the path of the parent tree node.

Returns:

the row index of the specified child node.

getParentElementFromRow

Element getParentElementFromRow(int row)

Returns the parent element of 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 parent element of the tree node at the specified position or null if the tree is empty or row is out of bounds.

See Also:

ItsNatTreeCellUI.getParentElement(), ElementGroup.getParentElement()

getContentElementFromRow

Element getContentElementFromRow(int row)

Returns the content element of 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 content element of the tree node at the specified position or null if the tree is empty or row is out of bounds.

See Also:

ItsNatTreeCellUI.getContentElement(), ItsNatTreeStructure.getContentElement(ItsNatTree,int,Element), ElementTreeNode.getContentElement()

getHandleElementFromRow

Element getHandleElementFromRow(int row)

Returns the handle element of 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 handle element of the tree node at the specified position or null if the tree is empty or row is out of bounds.

See Also:

ItsNatTreeCellUI.getHandleElement(), ItsNatTreeStructure.getHandleElement(ItsNatTree,int,Element), ElementTreeNode.getHandleElement()

getIconElementFromRow

Element getIconElementFromRow(int row)

Returns the icon element of 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 icon element of the tree node at the specified position or null if the tree is empty or row is out of bounds.

See Also:

ItsNatTreeCellUI.getIconElement(), ItsNatTreeStructure.getIconElement(ItsNatTree,int,Element), ElementTreeNode.getIconElement()

getLabelElementFromRow

Element getLabelElementFromRow(int row)

Returns the label element of 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 label element of the tree node at the specified position or null if the tree is empty or row is out of bounds.

See Also:

ItsNatTreeCellUI.getLabelElement(), ItsNatTreeStructure.getLabelElement(ItsNatTree,int,Element), ElementTreeNode.getLabelElement()

getParentElementFromTreePath

Element getParentElementFromTreePath(TreePath path)

Returns the parent element of the tree node specified by the tree path.

Parameters:

path - the tree node path.

Returns:

the parent element of the tree node.

See Also:

getParentElementFromRow(int)

getContentElementFromTreePath

Element getContentElementFromTreePath(TreePath path)

Returns the content element of the tree node specified by the tree path.

Parameters:

path - the tree node path.

Returns:

the content element of the tree node.

See Also:

getContentElementFromRow(int)

getHandleElementFromTreePath

Element getHandleElementFromTreePath(TreePath path)

Returns the handle element of the tree node specified by the tree path.

Parameters:

path - the tree node path.

Returns:

the handle element of the tree node.

See Also:

getHandleElementFromRow(int)

getIconElementFromTreePath

Element getIconElementFromTreePath(TreePath path)

Returns the icon element of the tree node specified by the tree path.

Parameters:

path - the tree node path.

Returns:

the icon element of the tree node.

See Also:

getIconElementFromRow(int)

getLabelElementFromTreePath

Element getLabelElementFromTreePath(TreePath path)

Returns the label element of the tree node specified by the tree path.

Parameters:

path - the tree node path.

Returns:

the label element of the tree node.

See Also:

getLabelElementFromRow(int)

getItsNatTreeCellUIFromRow

ItsNatTreeCellUI getItsNatTreeCellUIFromRow(int row)

Returns the object info of 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 object info of the tree node at the specified position or null if the tree is empty or row is out of bounds. This object is ever the same per tree node and may be used to save any context data.

See Also:

ElementTree.getElementTreeNodeFromRow(int)

getItsNatTreeCellUIFromTreePath

ItsNatTreeCellUI getItsNatTreeCellUIFromTreePath(TreePath path)

Returns the object info of the tree node specified by the tree path.

Parameters:

path - the tree node path.

Returns:

the object info of the tree node. This object is ever the same per tree node and may be used to save any context data.

See Also:

getItsNatTreeCellUIFromRow(int)

getItsNatTreeCellUIFromNode

ItsNatTreeCellUI getItsNatTreeCellUIFromNode(Node node)

Returns the object info of 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. This object is ever the same per tree node and may be used to save any context data.

See Also:

ElementTree.getElementTreeNodeFromNode(Node)

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