AbstractTreeModel (zk 6.5.0 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.zkoss.zul
Class AbstractTreeModel<E>

java.lang.Object
  org.zkoss.zul.AbstractTreeModel<E>

All Implemented Interfaces:: java.io.Serializable, Openable<E>, Selectable<E>, TreeOpenableModel, TreeSelectableModel, TreeModel<E>

Direct Known Subclasses:: DefaultTreeModel

public abstract class AbstractTreeModel<E>
extends java.lang.Object
implements TreeModel<E>, TreeSelectableModel, TreeOpenableModel, Selectable<E>, Openable<E>, java.io.Serializable
extends java.lang.Object
implements TreeModel<E>, TreeSelectableModel, TreeOpenableModel, Selectable<E>, Openable<E>, java.io.Serializable

A skeletal implementation for TreeModel.

AbstractTreeModel implements both TreeSelectableModel and TreeOpenableModel. In other words, it stores the selection and open states, such that Tree and other UI can interact with.

In additions, AbstractTreeModel also implements Selectable and Openable to simplify the acess (and provides backward compatibility to ZK 5 and ealier). However, these two interfaces are optional and designed for application. Tree and all ZK core don't access it at all.

For introduction, please refer to ZK Developer's Reference: Tree Model.

Since:: 3.0.0
Author:: jumperchen, tomyeh
See Also:: Serialized Form

Nested Class Summary
`protected static class`	`AbstractTreeModel.Path` Represents a tree path.

Field Summary
`protected java.util.Set<AbstractTreeModel.Path>`	`_opens` The open information.
`protected java.util.Set<AbstractTreeModel.Path>`	`_selection` The selection.

Constructor Summary
`AbstractTreeModel(E root)` Creates a `AbstractTreeModel`.

Method Summary
`boolean`	`addOpenObject(E child)` Add the specified object into the collection of opened objects.
`boolean`	`addOpenPath(int[] path)` Adds path to the current open.
`boolean`	`addOpenPaths(int[][] paths)` Adds paths to the current Open.
`boolean`	`addSelectionPath(int[] path)` Adds path to the current selection.
`boolean`	`addSelectionPaths(int[][] paths)` Adds paths to the current selection.
`boolean`	`addToSelection(E child)` Add the specified object into selection.
`void`	`addTreeDataListener(TreeDataListener l)` Add a listener to the tree that's notified each time a change to the data model occurs
`protected void`	`afterSort(java.lang.Object ctx)` A utility that the deriving class can call to restore the states saved by `beforeSort()`
`protected java.lang.Object`	`beforeSort()` A utility that the deriving class can call to save the states before sorting the model.
`void`	`clearOpen()` Empties the current open path.
`void`	`clearSelection()` Empties the current selection.
`java.lang.Object`	`clone()`
`void`	`fireEvent(E node, int indexFrom, int indexTo, int evtType)` Deprecated. As of release 6.0.0, replaced with `fireEvent(int, int[], int, int)`.
`void`	`fireEvent(int evtType, int[] path, int indexFrom, int indexTo)` Fires a `TreeDataEvent` for all registered listener Note: you can invoke this method only in an event listener.
`protected void`	`fireOpenChanged(int[] path)` Fires a `TreeDataEvent` for all registered listener when open status has changed.
`protected void`	`fireSelectionChanged(int[] path)` Fires a `TreeDataEvent` for all registered listener when selection status has changed.
`E`	`getChild(int[] path)` Returns the child at the given path where the path indicates the child is placed in the whole tree.
`int`	`getIndexOfChild(E parent, E child)` Returns the index of child in parent.
`int`	`getOpenCount()` Returns the number of paths that are opened.
`java.util.Set<E>`	`getOpenObjects()` Returns the objects that are opened.
`int[]`	`getOpenPath()` Returns the first path in the open.
`int[][]`	`getOpenPaths()` Returns the paths in the open.
`int[]`	`getPath(E child)` Returns the path from the specified child.
`E`	`getRoot()` Return the root of the tree model.
`java.util.Set<E>`	`getSelection()` Returns the current selection.
`int`	`getSelectionCount()` Returns the number of paths that are selected.
`int[]`	`getSelectionPath()` Returns the first path in the selection.
`int[][]`	`getSelectionPaths()` Returns the paths in the selection.
`boolean`	`isMultiple()` Returns whether the current selection mode is multiple.
`boolean`	`isObjectOpened(java.lang.Object child)` Returns whether the specified object be opened.
`boolean`	`isOpenEmpty()` Returns true if the open is currently empty.
`boolean`	`isPathOpened(int[] path)` Returns true if the path, `path`, is in the current open.
`boolean`	`isPathSelected(int[] path)` Returns true if the path, `path`, is in the current selection.
`boolean`	`isSelected(java.lang.Object child)` Returns whether an object is selected.
`boolean`	`isSelectionEmpty()` Returns true if the selection is currently empty.
`boolean`	`removeFromSelection(java.lang.Object child)` Remove the specified object from selection.
`boolean`	`removeOpenObject(java.lang.Object child)` Remove the specified object from selection.
`boolean`	`removeOpenPath(int[] path)` Removes path from the open.
`boolean`	`removeOpenPaths(int[][] paths)` Removes paths from the open.
`boolean`	`removeSelectionPath(int[] path)` Removes path from the selection.
`boolean`	`removeSelectionPaths(int[][] paths)` Removes paths from the selection.
`void`	`removeTreeDataListener(TreeDataListener l)` Remove a listener to the tree that's notified each time a change to the data model occurs
`void`	`setMultiple(boolean multiple)` Sets the selection mode to be multiple.
`void`	`setOpenObjects(java.util.Collection<? extends E> opened)` Replace the current set of opened objects with the given set.
`void`	`setSelection(java.util.Collection<? extends E> selection)` Replace the current selection with the given set.

Methods inherited from class java.lang.Object
`equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Methods inherited from interface org.zkoss.zul.TreeModel
`getChild, getChildCount, isLeaf`

Field Detail

_selection

protected java.util.Set<AbstractTreeModel.Path> _selection

The selection.

_opens

protected java.util.Set<AbstractTreeModel.Path> _opens

The open information.

Constructor Detail

AbstractTreeModel

public AbstractTreeModel(E root)

Creates a AbstractTreeModel.

Parameters:: root - root of tree

Method Detail

getRoot

public E getRoot()

Return the root of the tree model.

Specified by:: getRoot in interface TreeModel<E>

Returns:: the root of Tree.

fireEvent

public void fireEvent(E node,
                      int indexFrom,
                      int indexTo,
                      int evtType)

Deprecated. As of release 6.0.0, replaced with fireEvent(int, int[], int, int).

fireEvent

public void fireEvent(int evtType,
                      int[] path,
                      int indexFrom,
                      int indexTo)

Fires a TreeDataEvent for all registered listener

Note: you can invoke this method only in an event listener.

Since:: 6.0.0

fireSelectionChanged

protected void fireSelectionChanged(int[] path)

Fires a TreeDataEvent for all registered listener when selection status has changed.

Since:: 6.0.0

fireOpenChanged

protected void fireOpenChanged(int[] path)

Fires a TreeDataEvent for all registered listener when open status has changed.

Since:: 6.0.0

getIndexOfChild

public int getIndexOfChild(E parent,
                           E child)

Returns the index of child in parent. If either parent or child is null, returns -1. If either parent or child don't belong to this tree model, returns -1.

The default implementation iterates through all children of parent by invoking, and check if child is part of them. You could override it if you have a better algorithm. getChild(int[])

Specified by:: getIndexOfChild in interface TreeModel<E>

Parameters:: parent - a node in the tree, obtained from this data source; child - the node we are interested in
Returns:: the index of the child in the parent, or -1 if either child or parent are null or don't belong to this tree model
Since:: 5.0.6

getChild

public E getChild(int[] path)

Description copied from interface: TreeModel

Returns the child at the given path where the path indicates the child is placed in the whole tree.

Specified by:: getChild in interface TreeModel<E>

Parameters:: path - the tree path
Returns:: the child at path

getPath

public int[] getPath(E child)

Returns the path from the specified child. This implementation looks for the child by traversing every possible child (deep-first). It is suggested to override this method for better performance, if there is a better algorithm.

Specified by:: getPath in interface TreeModel<E>

Parameters:: child - the node we are interested in
Since:: 6.0.0

addTreeDataListener

public void addTreeDataListener(TreeDataListener l)

Description copied from interface: TreeModel

Add a listener to the tree that's notified each time a change to the data model occurs

Specified by:: addTreeDataListener in interface TreeModel<E>

Parameters:: l - the listener to add

removeTreeDataListener

public void removeTreeDataListener(TreeDataListener l)

Description copied from interface: TreeModel

Remove a listener to the tree that's notified each time a change to the data model occurs

Specified by:: removeTreeDataListener in interface TreeModel<E>

Parameters:: l - the listener to remove