org.itsnat.comp.tree

Interface ItsNatTreeStructure

public interface ItsNatTreeStructure

Used by tree components to locate the required elements of the table layout.

Author:

Jose Maria Arranz Santamaria

See Also:

ItsNatComponentManager.createDefaultItsNatTreeStructure(), ItsNatTree.getItsNatTreeStructure(), ElementTreeNodeStructure

Method Summary

Methods

Modifier and Type	Method and Description
org.w3c.dom.Element	getChildListElement(ItsNatTree tree, int row, org.w3c.dom.Element nodeParent) Returns the element containing the child tree nodes of the specified tree node.
org.w3c.dom.Element	getContentElement(ItsNatTree tree, int row, org.w3c.dom.Element nodeParent) Returns the content element of a tree node.
org.w3c.dom.Element	getHandleElement(ItsNatTree tree, int row, org.w3c.dom.Element nodeParent) Returns the handle element of a tree node.
org.w3c.dom.Element	getIconElement(ItsNatTree tree, int row, org.w3c.dom.Element nodeParent) Returns the icon element of a tree node.
org.w3c.dom.Element	getLabelElement(ItsNatTree tree, int row, org.w3c.dom.Element nodeParent) Returns the label element of a tree node.

Method Detail

getContentElement

org.w3c.dom.Element getContentElement(ItsNatTree tree,
                                    int row,
                                    org.w3c.dom.Element nodeParent)

Returns the content element of a tree node.

Default implementation delegates to the default ElementTreeNodeStructure.

Parameters:

tree - the tree component, may be used to provide contextual information. Default implementation ignores it.

row - the tree node row (seeing the tree as a list).

nodeParent - the element containing the tree node markup. Is a hint, if provided should be obtained by calling tree.getItsNatTreeUI().getParentElementFromRow(row).

Returns:

the content element of the tree node.

getHandleElement

org.w3c.dom.Element getHandleElement(ItsNatTree tree,
                                   int row,
                                   org.w3c.dom.Element nodeParent)

Returns the handle element of a tree node.

Default implementation delegates to the default ElementTreeNodeStructure.

Parameters:

tree - the tree component, may be used to provide contextual information. Default implementation ignores it.

row - the tree node row (seeing the tree as a list).

nodeParent - the element containing the tree node markup. Is a hint, if provided should be obtained by calling tree.getItsNatTreeUI().getParentElementFromRow(row).

Returns:

the handle element of the tree node.

getIconElement

org.w3c.dom.Element getIconElement(ItsNatTree tree,
                                 int row,
                                 org.w3c.dom.Element nodeParent)

Returns the icon element of a tree node.

Default implementation delegates to the default ElementTreeNodeStructure.

Parameters:

tree - the tree component, may be used to provide contextual information. Default implementation ignores it.

row - the tree node row (seeing the tree as a list).

nodeParent - the element containing the tree node markup. Is a hint, if provided should be obtained by calling tree.getItsNatTreeUI().getParentElementFromRow(row).

Returns:

the icon element of the tree node.

getLabelElement

org.w3c.dom.Element getLabelElement(ItsNatTree tree,
                                  int row,
                                  org.w3c.dom.Element nodeParent)

Returns the label element of a tree node. This element is used to render and edit the tree node value.

Default implementation delegates to the default ElementTreeNodeStructure.

Parameters:

tree - the tree component, may be used to provide contextual information. Default implementation ignores it.

row - the tree node row (seeing the tree as a list).

nodeParent - the element containing the tree node markup. Is a hint, if provided should be obtained by calling tree.getItsNatTreeUI().getParentElementFromRow(row).

Returns:

the label element of the tree node.

See Also:

ItsNatTreeCellRenderer, ItsNatTreeCellEditor

getChildListElement

org.w3c.dom.Element getChildListElement(ItsNatTree tree,
                                      int row,
                                      org.w3c.dom.Element nodeParent)

Returns the element containing the child tree nodes of the specified tree node.

Default implementation delegates to the default ElementTreeNodeStructure.

Parameters:

tree - the tree component, may be used to provide contextual information. Default implementation ignores it.

row - the tree node row (seeing the tree as a list).

nodeParent - the element containing the tree node markup. Is a hint, if provided should be obtained by calling tree.getItsNatTreeUI().getParentElementFromRow(row).

Returns:

the element containing the child list.