zul.sel
Class Tree

java.lang.Object
  zk.Object
      zk.Widget
          zul.Widget
              zul.mesh.MeshWidget
                  zul.sel.SelectWidget
                      zul.sel.Tree

public class Tree
extends SelectWidget

A container which can be used to hold a tabular or hierarchical set of rows of elements.

Event:

1. onSelect event is sent when user changes the selection.

Default Widget.getZclass(): z-tree, and an other option is z-dottree.

Field Summary

Fields inherited from class zul.sel.SelectWidget

rightSelect

Fields inherited from class zk.Widget

$weave, auDelay, autag, bindLevel, className, desktop, effects_, firstChild, id, insertingBefore_, inServer, lastChild, nChildren, nextSibling, parent, previousSibling, uuid, widgetName

Fields inherited from class zk.Object

$class, $oid

Method Summary

void	clear() clears the tree children.
TreeItemIter	getBodyWidgetIterator() Returns the tree item iterator.
Treecols	getHeadWidgetClass() Returns the head widget class. i.e.
int	getItemCount() Returns the number of child Treeitem.
Array	getItems() Returns a readonly list of all descending Treeitem (children's children and so on).
TreeItemIter	itemIterator() Returns the tree item iterator.
protected boolean	shallIgnoreSelect_(Event evt, ItemWidget row) Returns whether to ignore the selection.

Methods inherited from class zul.sel.SelectWidget

clearSelection, fireOnSelect, getName, getRows, getSelectedIndex, getSelectedItem, getSelectedItems, indexOfItem, isCheckmark, isMultiple, selectAll, selectItem, setCheckmark, setMultiple, setName, setRows, setSelectAll, setSelectedIndex, setSelectedItem

Methods inherited from class zul.mesh.MeshWidget

calcSize, getActivePage, getFocusCell, getHeadWidget, getInnerWidth, getPageCount, getPageSize, getPaginal, getPagingPosition, getSpan, inPagingMold, isAutopaging, isModel, isSizedByContent, setActivePage, setAutopaging, setInnerWidth, setModel, setPageSize, setPaginal, setPagingPosition, setSizedByContent, setSpan, syncSize

Methods inherited from class zul.Widget

afterKeyDown_, beforeCtrlKeys_, getContext, getCtrlKeys, getOpenTooltip, getPopup, getTooltip, setContext, setContext, setCtrlKeys, setPopup, setPopup, setTooltip, setTooltip

Methods inherited from class zk.Widget

$, $f, $f, $f, $init, $n, $n, $o, afterAnima_, afterParentChanged_, appendChild, appendChild, beforeParentChanged_, beforeSendAU_, bind_, bind, bindChildren_, canActivate, cleanDrag_, clearCache, cloneDrag_, deferRedrawHTML_, detach, doBlur_, doClick_, doDoubleClick_, doFocus_, doKeyDown_, doKeyPress_, doKeyUp_, domAttrs_, domClass_, domListen_, doMouseDown_, doMouseMove_, doMouseOut_, doMouseOver_, doMouseUp_, domStyle_, domTextStyleAttr_, domTooltiptext_, domUnlisten_, doRightClick_, doSelect_, doTooltipOut_, doTooltipOver_, dropEffect_, extraBind_, fire, fireX, focus_, focus, forcerender, fromPageCoord, get, getAction, getCaveNode, getChildAt, getChildIndex, getClass, getDraggable, getDragMessage_, getDragNode, getDragOptions_, getDrop_, getDroppable, getElementsById, getElementsByName, getFirstNode_, getFloatZIndex_, getHeight, getHflex, getId, getLeft, getMold, getOldWidget_, getPage, getRenderdefer, getSclass, getScrollLeft, getScrollTop, getStyle, getTextNode, getTooltiptext, getTop, getTopWidget, getVflex, getWidth, getZclass, getZIndex, hide, ignoreDescendantFloatUp_, ignoreDrag_, initDrag_, insertBefore, insertChildHTML_, isAutoId, isBinding, isFloating_, isListen, isRealVisible, isRealVisible, isVisible, isVisible, isWatchable_, listen, listenOnFitSize_, mimicMouseDown_, newInstance, nextUuid, onChildAdded_, onChildRemoved_, onChildReplaced_, onChildVisible_, onDrop_, redraw, redrawHTML_, register, removeChild, removeChild, removeChildHTML_, removeHTML_, replaceCavedChildren_, replaceChildHTML_, replaceHTML, replaceWidget, rerender, rerender, scrollIntoView, sendAU_, set, set, setAction, setChildren, setDomVisible_, setDraggable, setDroppable, setFloating_, setFloatZIndex_, setHeight, setHflex, setId, setLeft, setListener, setListener, setListeners, setMold, setRenderdefer, setSclass, setScrollLeft, setScrollTop, setStyle, setTooltiptext, setTop, setTopmost, setVflex, setVisible, setWidth, setZclass, setZIndex, shallChildROD_, shallIgnoreClick_, show, smartUpdate, unbind_, unbind, unbindChildren_, uncloneDrag_, unlisten, unlistenOnFitSize_, updateDomClass_, updateDomStyle_, uuid, zsync

Methods inherited from class zk.Object

$init, $instanceof, $super, $super, $supers, $supers, afterInit, isAssignableFrom, isInstance, proxy

Methods inherited from class java.lang.Object

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

Method Detail

clear

public void clear()

clears the tree children.

Overrides:

clear in class Widget

getHeadWidgetClass

public Treecols getHeadWidgetClass()

Returns the head widget class. i.e. Treecols

Returns:

zul.sel.Treecols

getItems

public Array getItems()

Returns a readonly list of all descending Treeitem (children's children and so on).

Note: the performance of the size method of returned collection is no good.

Returns:

Array

getItemCount

public int getItemCount()

Returns the number of child Treeitem. The same as getItems().size().

Note: the performance of this method is no good.

Returns:

int

itemIterator

public TreeItemIter itemIterator()

Returns the tree item iterator.

Returns:

zul.sel.TreeItemIter

getBodyWidgetIterator

public TreeItemIter getBodyWidgetIterator()

Returns the tree item iterator.

Returns:

zul.sel.TreeItemIter

See Also:

itemIterator()

shallIgnoreSelect_

protected boolean shallIgnoreSelect_(Event evt,
                                     ItemWidget row)

Returns whether to ignore the selection. It is called when selecting an item (Widget.doSelect_(zk.Event)).

Default: ignore the selection if it is clicked on the open icon or SelectWidget.rightSelect is true and event is onRightClick.

Parameters:

evt - the event

row - the row about to be selected

Returns:

boolean whether to ignore the selection