to.etc.domui.component.tree

Class Tree<T>

java.lang.Object

to.etc.domui.dom.css.CssBase

to.etc.domui.dom.html.NodeBase

to.etc.domui.dom.html.NodeContainer

to.etc.domui.dom.html.Div

to.etc.domui.component.tree.Tree<T>

All Implemented Interfaces:

Iterable<NodeBase>, ITreeModelChangedListener<T>, INodeErrorDelegate, IDraggable, IDropBody, IDropTargetable

Direct Known Subclasses:

TreeSelect, TreeSelectMulti

public class Tree<T>
extends Div
implements ITreeModelChangedListener<T>

Constructor Summary

Constructors

Constructor and Description
Tree()
Tree(ITreeModel<T> model)

Method Summary

Modifier and Type	Method and Description
protected void	cellClicked(TD cell, T value, ClickInfo clinfo)
void	collapseAll()
void	collapseNode(T item) Force the specified node to collapse.
void	createContent() Main initial renderer.
void	expandNode(T item) Force the specified node to expand.
ICellClicked<?>	getCellClicked()
INodeContentRenderer<?>	getContentRenderer()
Class<? extends INodeContentRenderer<?>>	getContentRendererClass()
boolean	getExpandRoot()
ITreeModel<T>	getModel() Get the currently used model.
INodePredicate<T>	getNodeSelectablePredicate()
PropertyMetaModel<?>	getPropertyMetaModel()
List<T>	getTreePath(T item) Calculates a tree path for a given node, as a set of nodes that walk to the item.
boolean	isExpanded(T node) Returns T if this node is currently expanded (opened).
protected boolean	isSelectable(T node)
protected boolean	isSelected(T node)
boolean	isShowRoot()
TR	locateRowIfExpanded(T node)
protected void	markAsSelected(T node, boolean selected) Internal use: set or reset the 'selected' indication on the visible node.
void	onNodeAdded(T parent, int index, T node) Called after a node is added in the model
void	onNodeRemoved(T oldParent, int oldIndex, T deletedNode) Called after a node is removed in the model
void	onNodeUpdated(T node) Called after a node is updated in the model.
void	setCellClicked(ICellClicked<?> cellClicked)
void	setContentRenderer(INodeContentRenderer<?> contentRenderer)
void	setContentRendererClass(Class<? extends INodeContentRenderer<T>> contentRendererClass)
void	setExpandRoot(boolean x)
void	setModel(ITreeModel<T> model) Set a new model for this table.
void	setNodeSelectablePredicate(INodePredicate<T> nodeSelectablePredicate)
void	setPropertyMetaModel(PropertyMetaModel<?> propertyMetaModel)
void	setShowRoot(boolean showRoot)
void	toggleNode(T item)

Methods inherited from class to.etc.domui.dom.html.Div

afterCreateContent, componentHandleWebAction, fadeIn, fadeOut, getCustomUpdatesCallJS, getDragHandler, getDropBody, getDropHandler, getDropMode, getReturnPressed, setDragHandler, setDropBody, setDropHandler, setReturnPressed, slideDown, slideUp, tb, visit

Methods inherited from class to.etc.domui.dom.html.NodeContainer

add, add, add, addTable, addTableForLayout, addTableForLayout, appendTreeErrors, canContain, createFrame, delegateTo, disableAllChildControlsDeep, findChildIndex, forceRebuild, getChild, getChildCount, getChildren, getDeepChildren, getDelegate, getErrorFence, getTextContents, hasError, internalAdd, internalCheckNotDirty, internalClearDelta, internalClearDeltaFully, internalCreateFrame, internalGetNodeCount, internalGetOldChildren, internalOnBeforeRender, internalShelve, internalUnshelve, iterator, onRefresh, removeAllChildren, removeChild, removeChild, replaceChild, setErrorFence, setErrorFence, setText, setValue, undelegatedAdd, undelegatedGetChild

Methods inherited from class to.etc.domui.dom.html.NodeBase

$, acceptRequestParameter, addBinding, addCssClass, addGlobalMessage, addNotificationListener, alignToLeft, alignToLeft, alignToMiddle, alignToMiddle, alignTopToBottom, alignTopToBottom, alignToRight, alignToRight, alignToTop, alignToTop, appendAfterMe, appendBeforeMe, appendCreateJS, appendJavascript, appendJQuerySelector, appendJsCustomUpdatesContributor, appendShowOverflowTextAsTitleJs, appendStatement, beforeCreateContent, bind, bind, bindErrors, build, calcTestID, changed, changedJavascriptState, clearFocusRequested, clearGlobalMessage, clearGlobalMessage, clearGlobalMessage, clearMessage, clearValidationFailure, componentHandleWebDataRequest, createStatement, findComponentBundle, findParent, getActualID, getAllocationTracepoint, getBindingErrors, getBindingList, getBrowserWindowSize, getCalculatedTestID, getClicked, getClientBounds, getComponentBundle, getComponentDataURL, getComponentDataURL, getComponentInfo, getComponentJSONURL, getCreateJS, getCssClass, getErrorList, getErrorLocation, getFocusID, getMessage, getOnClickJS, getOnMouseDownJS, getOnSizeAndPositionChange, getPage, getParent, getParent, getParent, getParentOfTypes, getSharedContext, getSharedContextFactory, getSpecialAttribute, getSpecialAttributeList, getTag, getTestID, getTestRepeatId, getThemedResourceRURL, getTitle, getUserObject, handleDrop, hasCssClass, hasParent, internalGetOldParent, internalGetParent, internalHasChangedAttributes, internalNeedClickHandler, internalOnClicked, internalOnValueChanged, internalRenderJavascriptDelta, internalRenderJavascriptState, internalSetHasChangedAttributes, internalSetHasChangedAttributes, internalSetLogAllocations, internalSetTag, isAttached, isBuilt, isFocusable, isFocusRequested, isRendersOwnClose, isStretchHeight, lc, notify, notifyParentOrOpenerPage, onAddedToPage, onBeforeFullRender, onBeforeRender, onForceRebuild, onHeaderContributors, onRemoveFromPage, onShelve, onUnshelve, refresh, remove, removeBinding, removeCssClass, renderJavascriptDelta, renderJavascriptState, renderJavascriptState, replaceWith, setBrowserWindowSize, setCalculcatedId, setCalculcatedId, setClicked, setClientBounds, setComponentBundle, setCssClass, setErrorLocation, setFocus, setMessage, setOnClickJS, setOnMouseDownJS, setOnSizeAndPositionChange, setOverrideTitle, setSpecialAttribute, setStretchHeight, setTestID, setTestRepeatID, setTitle, setUserObject, toString

Methods inherited from class to.etc.domui.dom.css.CssBase

getBackgroundAttachment, getBackgroundColor, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorderBottomColor, getBorderBottomStyle, getBorderBottomWidth, getBorderLeftColor, getBorderLeftStyle, getBorderLeftWidth, getBorderRightColor, getBorderRightStyle, getBorderRightWidth, getBorderTopColor, getBorderTopStyle, getBorderTopWidth, getBottom, getCachedStyle, getClear, getColor, getDisplay, getFloat, getFontFamily, getFontSize, getFontSizeAdjust, getFontStyle, getFontVariant, getFontWeight, getHeight, getLeft, getLineHeight, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOverflow, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getPosition, getRight, getTextAlign, getTop, getTransform, getVerticalAlign, getVisibility, getWidth, getZIndex, internalSetDisplay, setBackgroundAttachment, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBorder, setBorderBottomColor, setBorderBottomStyle, setBorderBottomWidth, setBorderColor, setBorderLeftColor, setBorderLeftStyle, setBorderLeftWidth, setBorderRightColor, setBorderRightStyle, setBorderRightWidth, setBorderStyle, setBorderTopColor, setBorderTopStyle, setBorderTopWidth, setBorderWidth, setBottom, setBottom, setCachedStyle, setClear, setColor, setDisplay, setFloat, setFontFamily, setFontSize, setFontSizeAdjust, setFontStyle, setFontVariant, setFontWeight, setHeight, setLeft, setLeft, setLineHeight, setMargin, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setOverflow, setPadding, setPaddingBottom, setPaddingLeft, setPaddingRight, setPaddingTop, setPosition, setRight, setRight, setTextAlign, setTop, setTop, setTransform, setVerticalAlign, setVisibility, setWidth, setZIndex

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

Tree

public Tree()

Tree

public Tree(ITreeModel<T> model)

Method Detail

createContent

public void createContent()
                   throws Exception

Main initial renderer.

Overrides:

createContent in class NodeBase

Throws:

Exception

See Also:

NodeBase.createContent()

expandNode

public void expandNode(T item)
                throws Exception

Force the specified node to expand. If the node is a leaf then the entire path up to that leaf is expanded. The inner logic is as follows:

• Determine the full TreePath to the node. This defines all nodes that need to be expanded to display the target node.
• For each node in the path check expansion state; if the node is expanded we're done, but if not we need to expand it, so render the expanded state in the tree.

Parameters:

item -

Throws:

Exception

collapseNode

public void collapseNode(T item)
                  throws Exception

Force the specified node to collapse. This also collapses all nodes after it, of course.

Parameters:

item -

Throws:

Exception

collapseAll

public void collapseAll()
                 throws Exception

Throws:

Exception

toggleNode

public void toggleNode(T item)
                throws Exception

Throws:

Exception

getTreePath

public List<T> getTreePath(T item)
                    throws Exception

Calculates a tree path for a given node, as a set of nodes that walk to the item. The root element is always the 1st element in the treepath

Parameters:

item -

Returns:

Throws:

Exception

cellClicked

protected void cellClicked(@Nonnull
                           TD cell,
                           @Nonnull
                           T value,
                           @Nonnull
                           ClickInfo clinfo)
                    throws Exception

Throws:

Exception

isExpanded

public boolean isExpanded(T node)

Returns T if this node is currently expanded (opened).

Parameters:

node -

Returns:

isSelectable

protected boolean isSelectable(@Nonnull
                               T node)
                        throws Exception

Throws:

Exception

markAsSelected

protected void markAsSelected(T node,
                              boolean selected)
                       throws Exception

Internal use: set or reset the 'selected' indication on the visible node.

Parameters:

node -

selected -

Throws:

Exception

locateRowIfExpanded

@Nullable
public TR locateRowIfExpanded(T node)

isSelected

protected boolean isSelected(@Nonnull
                             T node)

setModel

public void setModel(ITreeModel<T> model)

Set a new model for this table. This discards the entire presentation and causes a full build at render time.

setExpandRoot

public void setExpandRoot(boolean x)
                   throws Exception

Throws:

Exception

getExpandRoot

public boolean getExpandRoot()

getModel

public ITreeModel<T> getModel()

Get the currently used model.

Returns:

isShowRoot

public boolean isShowRoot()

setShowRoot

public void setShowRoot(boolean showRoot)

getContentRenderer

public INodeContentRenderer<?> getContentRenderer()

setContentRenderer

public void setContentRenderer(INodeContentRenderer<?> contentRenderer)

getContentRendererClass

public Class<? extends INodeContentRenderer<?>> getContentRendererClass()

setContentRendererClass

public void setContentRendererClass(Class<? extends INodeContentRenderer<T>> contentRendererClass)

getCellClicked

public ICellClicked<?> getCellClicked()

setCellClicked

public void setCellClicked(ICellClicked<?> cellClicked)

getPropertyMetaModel

public PropertyMetaModel<?> getPropertyMetaModel()

setPropertyMetaModel

public void setPropertyMetaModel(PropertyMetaModel<?> propertyMetaModel)

getNodeSelectablePredicate

public INodePredicate<T> getNodeSelectablePredicate()

setNodeSelectablePredicate

public void setNodeSelectablePredicate(INodePredicate<T> nodeSelectablePredicate)

onNodeAdded

public void onNodeAdded(T parent,
                        int index,
                        T node)

Description copied from interface: ITreeModelChangedListener

Called after a node is added in the model

Specified by:

onNodeAdded in interface ITreeModelChangedListener<T>

Parameters:

parent - the parent of the added node

index - the index of the added node

node - the added node

onNodeUpdated

public void onNodeUpdated(T node)

Description copied from interface: ITreeModelChangedListener

Called after a node is updated in the model.

Specified by:

onNodeUpdated in interface ITreeModelChangedListener<T>

Parameters:

node - the node that is updated

onNodeRemoved

public void onNodeRemoved(T oldParent,
                          int oldIndex,
                          T deletedNode)

Description copied from interface: ITreeModelChangedListener

Called after a node is removed in the model

Specified by:

onNodeRemoved in interface ITreeModelChangedListener<T>

Parameters:

oldParent - the parent of the removed node

oldIndex - the index of the node that was removed

deletedNode - The node that was just deleted