org.itsnat.core.domutil

Interface ElementTreeNodeStructure

public interface ElementTreeNodeStructure

Used by ElementTreeNode objects to obtain the required element of the tree node markup.

Author:

Jose Maria Arranz Santamaria

See Also:

ElementGroupManager.createDefaultElementTreeNodeStructure()

Method Summary

Methods

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

Method Detail

getContentElement

org.w3c.dom.Element getContentElement(ElementTreeNode treeNode,
                                    org.w3c.dom.Element nodeParent)

Returns the content element of a tree node.

The intend of the content element is to contain the markup of handle, icon and label, it does not contain the child nodes if any. Should be return null if these constrains can not be accomplished (take account that handle and icon may be optional).

Default implementation returns the first child element of the effective tree node parent element if tree node is not part of a tree-table. If a tree-table returns the first <td> if parent tree node element is an HTML row otherwise returns the parent element (treeNode).

The "effective" tree node parent element differs from treeNode when this node is an HTML row, in this case the effective node parent is the first child <td>

Parameters:

treeNode - the target tree node.

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

Returns:

the content element. May be null (rare case).

getHandleElement

org.w3c.dom.Element getHandleElement(ElementTreeNode treeNode,
                                   org.w3c.dom.Element nodeParent)

Returns the handle element of a tree node.

The handle element is the element containing the markup of the tree node handle, this handle is usually used to control "folders".

Default implementation returns the first child element of the content element or null if no handle is detected in the content markup.

Parameters:

treeNode - the target tree node.

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

Returns:

the handle element. May be null (no handle).

getIconElement

org.w3c.dom.Element getIconElement(ElementTreeNode treeNode,
                                 org.w3c.dom.Element nodeParent)

Returns the icon element of a tree node.

The icon element is the element containing the markup of the tree node icon, this icon is usually used to show the type of node (a folder a final leaf etc).

Default implementation returns the next sibling of the handle element or null if no icon is detected in the content markup.

Parameters:

treeNode - the target tree node.

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

Returns:

the icon element. May be null (no icon).

getLabelElement

org.w3c.dom.Element getLabelElement(ElementTreeNode treeNode,
                                  org.w3c.dom.Element nodeParent)

Returns the label element of a tree node.

The label element is the element containing the markup of the tree node text info.

Default implementation returns the next sibling of the icon element, or the content element itself if no icon and handle is detected.

Parameters:

treeNode - the target tree node.

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

Returns:

the label element. May be null (rare case).

getChildListElement

org.w3c.dom.Element getChildListElement(ElementTreeNode treeNode,
                                      org.w3c.dom.Element nodeParent)

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

Default implementation returns null if the tree node is part of a tree-table, otherwise returns the next sibling of the content element.

If not a tree-table and a null is returned, then the tree node cannot have child nodes.

Parameters:

treeNode - the target tree node.

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

Returns:

the element containing the child list. May be null (is a tree-table or tree node has not child nodes).