org.itsnat.comp.tree

Interface ItsNatTreeCellRenderer

public interface ItsNatTreeCellRenderer

Is used to render tree node values as markup into DOM elements.

Author:

Jose Maria Arranz Santamaria

See Also:

ItsNatComponentManager.createDefaultItsNatTreeCellRenderer(), ItsNatTree.getItsNatTreeCellRenderer(), ItsNatTree.setItsNatTreeCellRenderer(ItsNatTreeCellRenderer)

Method Summary

Methods

Modifier and Type	Method and Description
void	renderTreeCell(ItsNatTree tree, int row, Object value, boolean isSelected, boolean isExpanded, boolean isLeaf, boolean hasFocus, Element treeNodeLabelElem, boolean isNew) Renders as markup the specified tree node value into the specified element, usually as a text node.
void	unrenderTreeCell(ItsNatTree tree, int row, Element treeNodeLabelElem) Unrenders the markup of the specified tree node.

Method Detail

renderTreeCell

void renderTreeCell(ItsNatTree tree,
                  int row,
                  Object value,
                  boolean isSelected,
                  boolean isExpanded,
                  boolean isLeaf,
                  boolean hasFocus,
                  Element treeNodeLabelElem,
                  boolean isNew)

Renders as markup the specified tree node value into the specified element, usually as a text node.

Default implementation delegates to the default ElementRenderer.

Default implementation ignores isSelected, isExpanded, isLeaf and hasFocus (current implementation of ItsNat trees does not handle focus on tree nodes, ever is false).

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

value - the value to render.

isSelected - true if the tree node is selected.

isExpanded - true if the tree node is expanded.

isLeaf - true if the tree node is a leaf.

hasFocus - true if the tree node has the focus.

treeNodeLabelElem - the tree node label element to render the value into. Is a hint, if provided should be obtained by calling tree.getItsNatTreeUI().getLabelElementFromRow(row).

isNew - true if this is the first time the markup is rendered. Default implementation ignores this parameter.

unrenderTreeCell

void unrenderTreeCell(ItsNatTree tree,
                    int row,
                    Element treeNodeLabelElem)

Unrenders the markup of the specified tree node. This method is called before the markup is removed.

Default implementation does nothing.

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

treeNodeLabelElem - the tree node label element to render the value into. Is a hint, if provided should be obtained by calling tree.getItsNatTreeUI().getLabelElementFromRow(row).