Package com.hybris.cockpitng.widgets.common.explorertree.model

Class DefaultExplorerTreeModel

java.lang.Object

org.zkoss.zul.AbstractTreeModel<NavigationNode>

com.hybris.cockpitng.widgets.common.explorertree.model.DefaultExplorerTreeModel

All Implemented Interfaces:

RefreshableTreeModel<NavigationNode>, java.io.Serializable, java.lang.Cloneable, org.zkoss.zul.ext.Openable<NavigationNode>, org.zkoss.zul.ext.Pageable, org.zkoss.zul.ext.Selectable<NavigationNode>, org.zkoss.zul.ext.Sortable<NavigationNode>, org.zkoss.zul.ext.TreeOpenableModel, org.zkoss.zul.ext.TreeSelectableModel, org.zkoss.zul.PageableModel, org.zkoss.zul.TreeModel<NavigationNode>

public class DefaultExplorerTreeModel
extends org.zkoss.zul.AbstractTreeModel<NavigationNode>
implements RefreshableTreeModel<NavigationNode>, java.lang.Cloneable, org.zkoss.zul.ext.Sortable<NavigationNode>

Default tree model for the explorer tree widget.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.zkoss.zul.AbstractTreeModel

org.zkoss.zul.AbstractTreeModel.DefaultSelectionControl<E extends java.lang.Object>, org.zkoss.zul.AbstractTreeModel.Path

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ZK_SORT_ASCENDING
static java.lang.String	ZK_SORT_DESCENDING

Fields inherited from class org.zkoss.zul.AbstractTreeModel

_opens, _selection

Fields inherited from interface org.zkoss.zul.PageableModel

INTERNAL_EVENT

Constructor Summary

Constructors

Constructor	Description
DefaultExplorerTreeModel(NavigationTree navTree)

Method Summary

Modifier and Type	Method	Description
java.lang.Object	clone()
protected java.util.List<NavigationNode>	findChildren(NavigationNode parent)
java.util.List<NavigationNode>	findNodesByData(java.lang.Object data)	Gets all nodes related to specified data.
protected java.util.List<NavigationNode>	findNodesWithWrappedData(java.lang.Object data)
NavigationNode	getChild(NavigationNode parent, int index)
int	getChildCount(NavigationNode parent)
protected java.util.List<NavigationNode>	getChildren(NavigationNode node)
int	getIndexOfChild(NavigationNode parent, NavigationNode child)
int[]	getPath(NavigationNode child)
NavigationNode	getRoot()
java.lang.String	getSortDirection(java.util.Comparator comparator)
protected int	indexOf(NavigationNode node, java.util.List<NavigationNode> children)	Deprecated, for removal: This API element is subject to removal in a future version. since 1808, is no longer used
boolean	isLeaf(NavigationNode node)
void	refreshChildren(NavigationNode node, java.util.List<NavigationNode> children)	Sets new children nodes of specified parent node and refreshes all data related to them.
void	sort(java.util.Comparator<NavigationNode> comparator, boolean ascending)
protected NavigationNode	unpackNavigationNodeDecorator(NavigationNode node)	Deprecated, for removal: This API element is subject to removal in a future version. since 1808, is no longer used

Methods inherited from class org.zkoss.zul.AbstractTreeModel

addOpenObject, addOpenPath, addOpenPaths, addPagingEventListener, addSelectionPath, addSelectionPaths, addToSelection, addTreeDataListener, afterSort, beforeSort, clearOpen, clearSelection, fireEvent, fireEvent, fireEvent, fireOpenChanged, fireSelectionChanged, getActivePage, getChild, getOpenCount, getOpenObjects, getOpenPath, getOpenPaths, getPageCount, getPageSize, getSelection, getSelectionControl, getSelectionCount, getSelectionPath, getSelectionPaths, isMultiple, isObjectOpened, isOpenEmpty, isPathOpened, isPathSelected, isSelected, isSelectionEmpty, removeFromSelection, removeOpenObject, removeOpenPath, removeOpenPaths, removePagingEventListener, removeSelectionPath, removeSelectionPaths, removeTreeDataListener, setActivePage, setMultiple, setOpenObjects, setPageSize, setSelection, setSelectionControl

Methods inherited from class java.lang.Object

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

Field Detail

ZK_SORT_ASCENDING

public static final java.lang.String ZK_SORT_ASCENDING

See Also:

Constant Field Values

ZK_SORT_DESCENDING

public static final java.lang.String ZK_SORT_DESCENDING

See Also:

Constant Field Values

Constructor Detail

DefaultExplorerTreeModel

public DefaultExplorerTreeModel(NavigationTree navTree)

Method Detail

clone

public java.lang.Object clone()

Overrides:

clone in class org.zkoss.zul.AbstractTreeModel<NavigationNode>

getChild

public NavigationNode getChild(NavigationNode parent,
                               int index)

Specified by:

getChild in interface org.zkoss.zul.TreeModel<NavigationNode>

findChildren

protected java.util.List<NavigationNode> findChildren(NavigationNode parent)

getChildCount

public int getChildCount(NavigationNode parent)

Specified by:

getChildCount in interface org.zkoss.zul.TreeModel<NavigationNode>

getIndexOfChild

public int getIndexOfChild(NavigationNode parent,
                           NavigationNode child)

Specified by:

getIndexOfChild in interface org.zkoss.zul.TreeModel<NavigationNode>

Overrides:

getIndexOfChild in class org.zkoss.zul.AbstractTreeModel<NavigationNode>

getRoot

public NavigationNode getRoot()

Specified by:

getRoot in interface org.zkoss.zul.TreeModel<NavigationNode>

Overrides:

getRoot in class org.zkoss.zul.AbstractTreeModel<NavigationNode>

isLeaf

public boolean isLeaf(NavigationNode node)

Specified by:

isLeaf in interface org.zkoss.zul.TreeModel<NavigationNode>

getChildren

protected java.util.List<NavigationNode> getChildren(NavigationNode node)

refreshChildren

public void refreshChildren(NavigationNode node,
                            java.util.List<NavigationNode> children)

Description copied from interface: RefreshableTreeModel

Sets new children nodes of specified parent node and refreshes all data related to them.

Specified by:

refreshChildren in interface RefreshableTreeModel<NavigationNode>

Parameters:

node - parent node

children - new children nodes

findNodesByData

public java.util.List<NavigationNode> findNodesByData(java.lang.Object data)

Description copied from interface: RefreshableTreeModel

Gets all nodes related to specified data.

In case of dynamic trees, method should return only those nodes that are already known and avoid traversing through whole tree to gather all related nodes.

Specified by:

findNodesByData in interface RefreshableTreeModel<NavigationNode>

Parameters:

data - node data

Returns:

list of known nodes that are related to data

findNodesWithWrappedData

protected java.util.List<NavigationNode> findNodesWithWrappedData(java.lang.Object data)

getPath

public int[] getPath(NavigationNode child)

Specified by:

getPath in interface org.zkoss.zul.TreeModel<NavigationNode>

Overrides:

getPath in class org.zkoss.zul.AbstractTreeModel<NavigationNode>

indexOf

@Deprecated(since="1808",
            forRemoval=true)
protected int indexOf(NavigationNode node,
                      java.util.List<NavigationNode> children)

Deprecated, for removal: This API element is subject to removal in a future version.

since 1808, is no longer used

unpackNavigationNodeDecorator

@Deprecated(since="1808",
            forRemoval=true)
protected NavigationNode unpackNavigationNodeDecorator(NavigationNode node)

Deprecated, for removal: This API element is subject to removal in a future version.

since 1808, is no longer used

sort

public void sort(java.util.Comparator<NavigationNode> comparator,
                 boolean ascending)

Specified by:

sort in interface org.zkoss.zul.ext.Sortable<NavigationNode>

getSortDirection

public java.lang.String getSortDirection(java.util.Comparator comparator)

Specified by:

getSortDirection in interface org.zkoss.zul.ext.Sortable<NavigationNode>