eu.webtoolkit.jwt
Class WTreeNode

java.lang.Object
  eu.webtoolkit.jwt.WObject
      eu.webtoolkit.jwt.WWidget
          eu.webtoolkit.jwt.WCompositeWidget
              eu.webtoolkit.jwt.WTreeNode

Direct Known Subclasses:

WTreeTableNode

public class WTreeNode
extends WCompositeWidget

A single node in a tree.

A tree list is constructed by combining several tree node objects in a tree hierarchy, by passing the parent tree node as the last argument in the child node constructor, or by using addChildNode(), to add a child to its parent.

Each tree node has a label, and optionally a label icon pair. The icon pair offers the capability to show a different icon depending on the state of the node (expanded or collapsed). When the node has any children, a child count may be displayed next to the label using setChildCountPolicy().

Expanding a tree node it will collapse all its children, so that a user may collapse/expand a node as a short-cut to collapsing all children.

The treenode provides several policies to communicate the current contents of the tree to the client (if possible):

• WTreeNode.LoadPolicy.PreLoading: the entire tree is transmitted to the client, and all tree navigation requires no further communication.
• WTreeNode.LoadPolicy.LazyLoading: only the minimum is transmitted to the client. When expanding a node for the first time, only then it is transmitted to the client, and this may thus have some latency.
• WTreeNode.LoadPolicy.NextLevelLoading: all leafs of visible children are transmitted, but not their children. This provides a good trade-off between bandwith use and interactivity, since expanding any tree node will happen instantly, and at the same time trigger some communication in the back-ground to load the next level of invisible nodes.

The default policy is WTreeNode.LoadPolicy.LazyLoading. Another load policy may be specified using setLoadPolicy() on the root node and before adding any children. The load policy is inherited by all children in the tree.

There are a few scenarios where it makes sense to specialize the WTreeNode class. One scenario is create a tree that is populated dynamically while browsing. For this purpose you should reimplement the populate() method, whose default implementation does nothing. This method is called when 'loading' the node. The exact moment for loading a treenode depends on the LoadPolicy.

A second scenario that is if you want to customize the look of the tree label (see getLabelArea()) or if you want to modify or augment the event collapse/expand event handling (see doExpand() and doCollapse()).

See WTree for a usage example.

CSS

The tree is styled by the current CSS theme. The look can be overridden using the Wt-tree CSS class and the following selectors:

 .Wt-tree .Wt-trunk          : vertical line, trunk
 .Wt-tree .Wt-end            : vertical line, last item
 .Wt-tree .Wt-collapse       : collapse icon (img *)
 .Wt-tree .Wt-expand         : expand icon (img *)
 .Wt-tree .Wt-noexpand       : leaf icon
 
 .Wt-tree .Wt-label          : the node label
 .Wt-tree .Wt-childcount     : the node child count
 .Wt-tree .Wt-node           : the node's table row
 

* The collapse and expand icons are fetched themselves as images, nav-plus.gif and nav-minus.gif.

See Also:

WTree, WTreeTableNode

Nested Class Summary

static class	WTreeNode.ChildCountPolicy An enumeration for the policy to display the child count.
static class	WTreeNode.LoadPolicy An enumeration for the policy to load children.

Constructor Summary

protected	WTreeNode() Creates a tree node with empty getLabelArea().
	WTreeNode(java.lang.CharSequence labelText) Creates a tree node with the given label.
	WTreeNode(java.lang.CharSequence labelText, WIconPair labelIcon) Creates a tree node with the given label.
	WTreeNode(java.lang.CharSequence labelText, WIconPair labelIcon, WTreeNode parent) Creates a tree node with the given label.
protected	WTreeNode(WTreeNode parent) Creates a tree node with empty getLabelArea().

Method Summary

void	addChildNode(WTreeNode node) Adds a child node.
void	collapse() Collapses this node.
EventSignal1<WMouseEvent>	collapsed() Signal emitted when the node is collapsed by the user.
protected void	descendantAdded(WTreeNode node) Reacts to the addition of a descendant node.
protected void	descendantRemoved(WTreeNode node) Reacts to the removal of a descendant node.
protected void	doCollapse() The actual collapse.
protected void	doExpand() The actual expand.
void	expand() Expands this node.
EventSignal1<WMouseEvent>	expanded() Signal emitted when the node is expanded by the user.
WTreeNode.ChildCountPolicy	getChildCountPolicy() Returns the child count policy.
java.util.List<WTreeNode>	getChildNodes() Returns the list of children.
int	getDisplayedChildCount() Returns the number of children that should be displayed.
protected WIconPair	getExpandIcon() Accesses the icon pair that allows expansion of the tree node.
protected java.lang.String	getImagePack() Deprecated. This method returns "" since JWt 3.1.1, as the image pack is no longer used in favour of the CSS themes.
WText	getLabel() Returns the label.
protected WTableCell	getLabelArea() Accesses the container widget that holds the label area.
WIconPair	getLabelIcon() Returns the label icon.
WTreeNode	getParentNode() Returns the parent node.
WTree	getTree() Returns the tree.
void	insertChildNode(int index, WTreeNode node) Inserts a child node.
protected boolean	isExpandable() Returns whether this node can be expanded.
boolean	isExpanded() Returns whether this node is expanded.
protected boolean	isPopulated() Returns whether this node has already been populated.
boolean	isSelectable() Returns if this node may be selected.
protected void	populate() Populates the node dynamically on loading.
void	remove() Destructor.
void	removeChildNode(WTreeNode node) Removes a child node.
protected void	renderSelected(boolean isSelected) Renders the node to be selected.
Signal1<java.lang.Boolean>	selected() Signal that is emitted when the node is added or removed from the selection
void	setChildCountPolicy(WTreeNode.ChildCountPolicy policy) Configures how and when the child count should be displayed.
void	setChildrenDecorated(boolean decorated) Sets whether this node's children are decorated.
void	setImagePack(java.lang.String url) Deprecated. This method does not do anything since JWt 3.1.1, as the tree is now styled based on the current CSS theme.
void	setInteractive(boolean interactive) Sets whether this node is interactive.
void	setLabelIcon(WIconPair labelIcon) Sets the label icon.
void	setLoadPolicy(WTreeNode.LoadPolicy loadPolicy) Sets the load policy for this tree.
void	setNodeVisible(boolean visible) Sets the visibility of the node itself.
void	setSelectable(boolean selectable) Allows this node to be selected.
protected void	undoDoCollapse() Undo method for doCollapse() stateless implementation.
protected void	undoDoExpand() Undo method for doCollapse() stateless implementation.

Methods inherited from class eu.webtoolkit.jwt.WCompositeWidget

addStyleClass, boxBorder, boxPadding, callJavaScriptMember, doJavaScript, enableAjax, find, getAttributeValue, getClearSides, getDecorationStyle, getFloatSide, getHeight, getId, getImplementation, getJavaScriptMember, getLineHeight, getMargin, getMaximumHeight, getMaximumWidth, getMinimumHeight, getMinimumWidth, getOffset, getPositionScheme, getStyleClass, getTabIndex, getToolTip, getVerticalAlignment, getVerticalAlignmentLength, getWidth, isDisabled, isEnabled, isHidden, isHiddenKeepsGeometry, isInline, isLoaded, isPopup, isVisible, load, propagateSetEnabled, refresh, removeStyleClass, resize, setAttributeValue, setClearSides, setDecorationStyle, setDisabled, setFloatSide, setHidden, setHiddenKeepsGeometry, setId, setImplementation, setInline, setJavaScriptMember, setLineHeight, setMargin, setMaximumSize, setMinimumSize, setOffsets, setPopup, setPositionScheme, setStyleClass, setTabIndex, setToolTip, setVerticalAlignment

Methods inherited from class eu.webtoolkit.jwt.WWidget

acceptDrops, acceptDrops, addCssRule, addCssRule, addStyleClass, animateHide, animateShow, containsExposed, disable, dropEvent, enable, getDrop, getJsRef, getParent, hide, htmlText, isLayoutSizeAware, isRendered, layoutSizeChanged, positionAt, positionAt, removeStyleClass, resize, setClearSides, setHeight, setHidden, setLayoutSizeAware, setMargin, setMargin, setMargin, setMargin, setMargin, setOffsets, setOffsets, setOffsets, setOffsets, setOffsets, setToolTip, setVerticalAlignment, setWidth, show, stopAcceptDrops, toggleStyleClass, toggleStyleClass, tr

Methods inherited from class eu.webtoolkit.jwt.WObject

addChild, getObjectName, setObjectName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WTreeNode

public WTreeNode(java.lang.CharSequence labelText,
                 WIconPair labelIcon,
                 WTreeNode parent)

Creates a tree node with the given label.

The labelIcon, if specified, will appear just before the label and its state reflect the expand/collapse state of the node.

The node is initialized to be collapsed.

WTreeNode

public WTreeNode(java.lang.CharSequence labelText)

Creates a tree node with the given label.

Calls this(labelText, (WIconPair)null, (WTreeNode)null)

WTreeNode

public WTreeNode(java.lang.CharSequence labelText,
                 WIconPair labelIcon)

Creates a tree node with the given label.

Calls this(labelText, labelIcon, (WTreeNode)null)

WTreeNode

protected WTreeNode(WTreeNode parent)

Creates a tree node with empty getLabelArea().

This tree node has no label or labelicon, and is therefore ideally suited to provide a custom look.

WTreeNode

protected WTreeNode()

Creates a tree node with empty getLabelArea().

Calls this((WTreeNode)null)

Method Detail

remove

public void remove()

Destructor.

Overrides:

remove in class WCompositeWidget

See Also:

WContainerWidget.removeWidget(WWidget widget)

getTree

public WTree getTree()

Returns the tree.

By default if this node has no parent the result will be 0.

getLabel

public WText getLabel()

Returns the label.

getLabelIcon

public WIconPair getLabelIcon()

Returns the label icon.

setLabelIcon

public void setLabelIcon(WIconPair labelIcon)

Sets the label icon.

insertChildNode

public void insertChildNode(int index,
                            WTreeNode node)

Inserts a child node.

Inserts the node node at index index.

addChildNode

public void addChildNode(WTreeNode node)

Adds a child node.

Equivalent to:

 insertChildNode(childNodes().size(), node);
   
 

See Also:

insertChildNode(int index, WTreeNode node)

removeChildNode

public void removeChildNode(WTreeNode node)

Removes a child node.

getChildNodes

public java.util.List<WTreeNode> getChildNodes()

Returns the list of children.

getDisplayedChildCount

public int getDisplayedChildCount()

Returns the number of children that should be displayed.

This is used to display the count in the count label. The default implementation simply returns getChildNodes().size().

setChildCountPolicy

public void setChildCountPolicy(WTreeNode.ChildCountPolicy policy)

Configures how and when the child count should be displayed.

By default, no child count indication is disabled (this is the behaviour since 2.1.1). Use this method to enable child count indications.

The child count policy is inherited by all children in the tree.

getChildCountPolicy

public WTreeNode.ChildCountPolicy getChildCountPolicy()

Returns the child count policy.

See Also:

setChildCountPolicy(WTreeNode.ChildCountPolicy policy)

setImagePack

public void setImagePack(java.lang.String url)

Deprecated. This method does not do anything since JWt 3.1.1, as the tree is now styled based on the current CSS theme.

Sets the image pack for this (sub)tree (deprecated).

setLoadPolicy

public void setLoadPolicy(WTreeNode.LoadPolicy loadPolicy)

Sets the load policy for this tree.

This may only be set on the root of a tree, and before adding any children.

isExpanded

public boolean isExpanded()

Returns whether this node is expanded.

setSelectable

public void setSelectable(boolean selectable)

Allows this node to be selected.

By default, all nodes may be selected.

Overrides:

setSelectable in class WCompositeWidget

See Also:

isSelectable(), WTree.select(WTreeNode node, boolean selected)

isSelectable

public boolean isSelectable()

Returns if this node may be selected.

See Also:

setSelectable(boolean selectable)

getParentNode

public WTreeNode getParentNode()

Returns the parent node.

See Also:

getChildNodes()

setNodeVisible

public void setNodeVisible(boolean visible)

Sets the visibility of the node itself.

If false, then the node itself is not displayed, but only its children. This is typically used to hide the root node of a tree.

setChildrenDecorated

public void setChildrenDecorated(boolean decorated)

Sets whether this node's children are decorated.

By default, node's children have expand/collapse and other lines to display their linkage and offspring.

By setting decorated to false, you can hide the decorations for the node's children.

setInteractive

public void setInteractive(boolean interactive)

Sets whether this node is interactive.

Interactive nodes can be clicked upon and will populate a list of children when clicked. By disabling the interactivity, a node will not react to a click event.

expand

public void expand()

Expands this node.

Besides the actual expansion of the node, this may also trigger the loading and population of the node children, or of the children's children.

See Also:

collapse(), doExpand()

collapse

public void collapse()

Collapses this node.

See Also:

expand(), doCollapse()

expanded

public EventSignal1<WMouseEvent> expanded()

Signal emitted when the node is expanded by the user.

See Also:

collapsed()

collapsed

public EventSignal1<WMouseEvent> collapsed()

Signal emitted when the node is collapsed by the user.

See Also:

expanded()

selected

public Signal1<java.lang.Boolean> selected()

Signal that is emitted when the node is added or removed from the selection

See Also:

WTree.itemSelectionChanged()

getLabelArea

protected WTableCell getLabelArea()

Accesses the container widget that holds the label area.

Use this to customize how the label should look like.

populate

protected void populate()

Populates the node dynamically on loading.

Reimplement this method if you want to populate the widget dynamically, as the tree is being browsed and therefore loaded. This is only usefull with LazyLoading or NextLevelLoading strategies.

isPopulated

protected boolean isPopulated()

Returns whether this node has already been populated.

See Also:

populate()

isExpandable

protected boolean isExpandable()

Returns whether this node can be expanded.

The default implementation populates the node if necessary, and then checks if there are any child nodes.

You may wish to reimplement this method if you reimplement populate(), and you have a quick default for determining whether a node may be expanded (which does not require populating the node).

See Also:

populate()

renderSelected

protected void renderSelected(boolean isSelected)

Renders the node to be selected.

The default implementation changes the style class of the getLabelArea() to "selected".

getImagePack

protected java.lang.String getImagePack()

Deprecated. This method returns "" since JWt 3.1.1, as the image pack is no longer used in favour of the CSS themes.

The image pack that is used for this tree node (deprecated).

descendantRemoved

protected void descendantRemoved(WTreeNode node)

Reacts to the removal of a descendant node.

Reimplement this method if you wish to react on the removal of a descendant node. The default implementation simply propagates the event to the parent.

descendantAdded

protected void descendantAdded(WTreeNode node)

Reacts to the addition of a descendant node.

Reimplement this method if you wish to react on the addition of a descendant node. The default implementation simply propagates the event to the parent.

doExpand

protected void doExpand()

The actual expand.

This method, which is implemented as a stateless slot, performs the actual expansion of the node.

You may want to reimplement this function (and undoDoExpand()) if you wish to do additional things on node expansion.

See Also:

doCollapse(), expand()

doCollapse

protected void doCollapse()

The actual collapse.

This method, which is implemented as a stateless slot, performs the actual collapse of the node.

You may want to reimplement this function (and undoDoCollapse()) if you wish to do additional things on node expansion.

See Also:

doExpand(), collapse()

undoDoExpand

protected void undoDoExpand()

Undo method for doCollapse() stateless implementation.

See Also:

doCollapse()

undoDoCollapse

protected void undoDoCollapse()

Undo method for doCollapse() stateless implementation.

See Also:

doExpand()

getExpandIcon

protected WIconPair getExpandIcon()

Accesses the icon pair that allows expansion of the tree node.