Treeitem (ZK XUL Components 8.0.0 API)

java.lang.Object
- org.zkoss.zk.ui.AbstractComponent
- - org.zkoss.zk.ui.HtmlBasedComponent
  - - org.zkoss.zul.impl.XulElement
    - - org.zkoss.zul.Treeitem

All Implemented Interfaces:

Serializable, Cloneable, org.zkoss.zk.ui.Component, org.zkoss.zk.ui.ext.Disable, org.zkoss.zk.ui.ext.Scope, org.zkoss.zk.ui.sys.ComponentCtrl
```
public class Treeitem
extends XulElement
implements org.zkoss.zk.ui.ext.Disable
```
A treeitem.
Event:
1. onOpen is sent when a tree item is opened or closed by user.
2. onDoubleClick is sent when user double-clicks the treeitem.
3. onRightClick is sent when user right-clicks the treeitem.
Author:

tomyeh

See Also:
Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class org.zkoss.zk.ui.HtmlBasedComponent
  org.zkoss.zk.ui.HtmlBasedComponent.ExtraCtrl
- Nested classes/interfaces inherited from class org.zkoss.zk.ui.AbstractComponent
  org.zkoss.zk.ui.AbstractComponent.Children

Field Summary
- Fields inherited from class org.zkoss.zk.ui.HtmlBasedComponent
  _zclass
- Fields inherited from interface org.zkoss.zk.ui.Component
  APPLICATION_SCOPE, COMPONENT_SCOPE, DESKTOP_SCOPE, PAGE_SCOPE, REQUEST_SCOPE, SESSION_SCOPE, SPACE_SCOPE
- Fields inherited from interface org.zkoss.zk.ui.sys.ComponentCtrl
  CE_BUSY_IGNORE, CE_DUPLICATE_IGNORE, CE_IMPORTANT, CE_NON_DEFERRABLE, CE_REPEAT_IGNORE

Constructor Summary

Constructors
Constructor and Description

Treeitem()

Treeitem(String label)

Treeitem(String label, Object value)

Constructors
Constructor and Description
`Treeitem()`
`Treeitem(String label)`
`Treeitem(String label, Object value)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`beforeChildAdded(org.zkoss.zk.ui.Component child, org.zkoss.zk.ui.Component refChild)`
`void`	`beforeParentChanged(org.zkoss.zk.ui.Component parent)`
`Object`	`clone()`
`String`	`getImage()` Returns the image of the `Treecell` it contains.
`int`	`getIndex()` return the index of this item
`String`	`getLabel()` Returns the label of the `Treecell` it contains, or null if no such cell.
`int`	`getLevel()` Returns the level this cell is.
`Treeitem`	`getParentItem()` Returns the parent tree item, or null if this item is already the top level of the tree.
`String`	`getSrc()` Deprecated. As of release 3.5.0, it is redundant since it the same as `getImage()`.
`Tree`	`getTree()` Returns the tree owning this item.
`Treechildren`	`getTreechildren()` Returns the treechildren that this tree item owns, or null if doesn't have any child.
`Treerow`	`getTreerow()` Returns the treerow that this tree item owns (might null).
`<T> T`	`getValue()` Returns the value.
`int`	`getVisibleItemCount()` Returns the number of visible descendant `Treechildren`.
`int`	`indexOf()` Deprecated. As of release 5.0.9, replaced with `getIndex()`.
`boolean`	`insertBefore(org.zkoss.zk.ui.Component child, org.zkoss.zk.ui.Component refChild)`
`boolean`	`isCheckable()` Deprecated. As of release 8.0.0, please use `isSelectable()`
`boolean`	`isContainer()` Returns whether the element is to act as a container which can have child elements.
`boolean`	`isDisabled()` Returns whether it is disabled.
`boolean`	`isEmpty()` Returns whether this element contains no child elements.
`boolean`	`isLoaded()` Return true whether all children of this tree item, if any, is loaded
`boolean`	`isOpen()` Returns whether this container is open.
`boolean`	`isRendered()` Returns true whether this tree item is rendered.
`boolean`	`isSelectable()` Returns whether it is selectable.
`boolean`	`isSelected()` Returns whether this item is selected.
`void`	`onChildAdded(org.zkoss.zk.ui.Component child)`
`void`	`onChildRemoved(org.zkoss.zk.ui.Component child)`
`protected void`	`redrawChildren(Writer out)`
`protected void`	`renderProperties(org.zkoss.zk.ui.sys.ContentRenderer renderer)`
`void`	`service(org.zkoss.zk.au.AuRequest request, boolean everError)` Processes an AU request.
`void`	`setCheckable(boolean checkable)` Deprecated. As of release 8.0.0, please use `setSelectable(boolean)`
`void`	`setDisabled(boolean disabled)` Sets whether it is disabled.
`void`	`setHflex(String flex)` Deprecated. as of release 6.0.0. To control the size of Tree related components, please refer to `Tree` and `Treecol` instead.
`void`	`setImage(String image)` Sets the image of the `Treecell` it contains.
`void`	`setLabel(String label)` Sets the label of the `Treecell` it contains.
`void`	`setOpen(boolean open)` Sets whether this container is open.
`void`	`setParent(org.zkoss.zk.ui.Component parent)`
`void`	`setSelectable(boolean selectable)` Sets whether it is selectable.
`void`	`setSelected(boolean selected)` Returns whether this item is selected.
`void`	`setSrc(String src)` Deprecated. As of release 3.5.0, it is redundant since it the same as `setImage(java.lang.String)`.
`void`	`setStubonly(boolean stubonly)` Deprecated. as of release 7.0.3.
`void`	`setStubonly(String stubonly)` Deprecated. as of release 7.0.3.
`<T> void`	`setValue(T value)` Sets the value.
`boolean`	`setVisible(boolean visible)`
`void`	`setWidth(String width)` Deprecated. as of release 6.0.0. To control the size of Tree related components, please refer to `Tree` and `Treecol` instead.
`void`	`unload()` Unload the tree item To load the tree item, with `Tree.renderItem(Treeitem)`, `Tree.renderItem(Treeitem, Object)`, or `Tree.renderItems(java.util.Set)`

Methods inherited from class org.zkoss.zul.impl.XulElement
getContext, getCtrlKeys, getPopup, getPropertyAccess, getTooltip, setContext, setContext, setCtrlKeys, setPopup, setPopup, setTooltip, setTooltip

Methods inherited from class org.zkoss.zk.ui.HtmlBasedComponent
focus, getAction, getDraggable, getDroppable, getExtraCtrl, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getStyle, getTooltiptext, getTop, getVflex, getWidth, getZclass, getZindex, getZIndex, setAction, setClass, setDraggable, setDroppable, setFocus, setHeight, setHeightDirectly, setHflexDirectly, setLeft, setLeftDirectly, setRenderdefer, setSclass, setStyle, setTooltiptext, setTop, setTopDirectly, setVflex, setWidthDirectly, setZclass, setZindex, setZIndex, setZIndexDirectly

Methods inherited from class org.zkoss.zk.ui.AbstractComponent
addAnnotation, addAnnotation, addClientEvent, addEventHandler, addEventListener, addEventListener, addForward, addForward, addForward, addForward, addMoved, addRedrawCallback, addScopeListener, addShadowRoot, addShadowRootBefore, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildRemoved, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableBindingAnnotation, disableClientUpdate, enableBindingAnnotation, equals, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAnnotations, getAttribute, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getAutag, getChildren, getClientAttribute, getClientDataAttribute, getClientEvents, getDefaultMold, getDefinition, getDesktop, getEventHandler, getEventHandlerNames, getEventListenerMap, getEventListeners, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNextSibling, getPage, getParent, getPreviousSibling, getRedrawCallback, getRoot, getShadowRoots, getShadowVariable, getShadowVariable0, getSpaceOwner, getSpecialRendererOutput, getStubonly, getSubBindingAnnotationCount, getTemplate, getTemplateNames, getUuid, getWidgetAttribute, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttribute, hasAttributeOrFellow, hasBindingAnnotation, hasFellow, hasFellow, hasSubBindingAnnotation, invalidate, isChildable, isInvalidated, isListenerAvailable, isVisible, onPageAttached, onPageDetached, onWrongValue, query, queryAll, redraw, removeAttribute, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, removeRedrawCallback, removeScopeListener, removeShadowRoot, render, render, render, replace, response, response, response, service, sessionDidActivate, sessionWillPassivate, setAttribute, setAttribute, setAttribute, setAuService, setAutag, setClientAttribute, setClientDataAttribute, setDefinition, setDefinition, setId, setMold, setPage, setPageBefore, setSubBindingAnnotationCount, setTemplate, setVisibleDirectly, setWidgetAttribute, setWidgetClass, setWidgetListener, setWidgetOverride, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdateWidgetListener, smartUpdateWidgetOverride, toString, updateByClient, updateSubBindingAnnotationCount, willPassivate, willPassivate, willSerialize, willSerialize

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

- Constructor Detail
  - Treeitem
```
public Treeitem()
```
  - Treeitem
```
public Treeitem(String label)
```
  - Treeitem
```
public Treeitem(String label,
        Object value)
```
- Method Detail
  - isCheckable
```
public boolean isCheckable()
```
    Deprecated. As of release 8.0.0, please use isSelectable()
  - setCheckable
```
public void setCheckable(boolean checkable)
```
    Deprecated. As of release 8.0.0, please use setSelectable(boolean)
  - isSelectable
```
public boolean isSelectable()
```
    Returns whether it is selectable.
    Default: true.
    
    Since:
    
    8.0.0
  - setSelectable
```
public void setSelectable(boolean selectable)
```
    Sets whether it is selectable.
    If the listbox is in a checkmark mode, the selectable state will affect the checkable icon to display or not.
    
    Default: true.
    
    Parameters:
    selectable -
  - unload
```
public void unload()
```
    Unload the tree item
    To load the tree item, with Tree.renderItem(Treeitem), Tree.renderItem(Treeitem, Object), or Tree.renderItems(java.util.Set)
    
    Since:
    
    3.0.4
  - setDisabled
```
public void setDisabled(boolean disabled)
```
    Sets whether it is disabled.
    
    Specified by:
    
    setDisabled in interface org.zkoss.zk.ui.ext.Disable
    
    Since:
    
    3.0.1
  - isDisabled
```
public boolean isDisabled()
```
    Returns whether it is disabled.
    Default: false.
    
    Specified by:
    
    isDisabled in interface org.zkoss.zk.ui.ext.Disable
    
    Since:
    
    3.0.1
  - isRendered
```
public boolean isRendered()
```
    Returns true whether this tree item is rendered. Unlike isLoaded() which is used to check whether all children of this tree item are loaded.
    Default: false
    
    Since:
    
    7.0.0
  - isLoaded
```
public boolean isLoaded()
```
    Return true whether all children of this tree item, if any, is loaded
    
    Returns:
    true whether all children of this tree item is loaded
    Since:
    
    3.0.0
  - setStubonly
```
public void setStubonly(String stubonly)
```
    Deprecated. as of release 7.0.3.
    
    Please use Treecell or Tree instead.
    
    Specified by:
    
    setStubonly in interface org.zkoss.zk.ui.Component
    
    Overrides:
    
    setStubonly in class org.zkoss.zk.ui.AbstractComponent
  - setStubonly
```
public void setStubonly(boolean stubonly)
```
    Deprecated. as of release 7.0.3.
    
    Please use Treecell or Tree instead.
    
    Specified by:
    
    setStubonly in interface org.zkoss.zk.ui.Component
    
    Overrides:
    
    setStubonly in class org.zkoss.zk.ui.AbstractComponent
  - getIndex
```
public int getIndex()
```
    return the index of this item
    
    Returns:
    the index of this item
    Since:
    
    5.0.9
  - indexOf
```
public int indexOf()
```
    Deprecated. As of release 5.0.9, replaced with getIndex().
  - getTreerow
```
public Treerow getTreerow()
```
    Returns the treerow that this tree item owns (might null). Each tree items has exactly one tree row.
  - getTreechildren
```
public Treechildren getTreechildren()
```
    Returns the treechildren that this tree item owns, or null if doesn't have any child.
  - isContainer
```
public boolean isContainer()
```
    Returns whether the element is to act as a container which can have child elements.
  - isEmpty
```
public boolean isEmpty()
```
    Returns whether this element contains no child elements.
  - getValue
```
public <T> T getValue()
```
    Returns the value. It could be anything you want.
    Default: null.
    Note: the value is not sent to the browser, so it is OK to be anything.
  - setValue
```
public <T> void setValue(T value)
```
    Sets the value.
    
    Parameters:
    value - the value. Note: the value is not sent to the browser, so it is OK to be anything.
  - isOpen
```
public boolean isOpen()
```
    Returns whether this container is open.
    Default: true.
  - setOpen
```
public void setOpen(boolean open)
```
    Sets whether this container is open.
  - isSelected
```
public boolean isSelected()
```
    Returns whether this item is selected.
  - setSelected
```
public void setSelected(boolean selected)
```
    Returns whether this item is selected.
  - getLevel
```
public int getLevel()
```
    Returns the level this cell is. The root is level 0.
  - getLabel
```
public String getLabel()
```
    Returns the label of the Treecell it contains, or null if no such cell.
  - setLabel
```
public void setLabel(String label)
```
    Sets the label of the Treecell it contains.
    If treerow and treecell are not created, we automatically create it.
    Notice that this method will create a treerow and treecell automatically if they don't exist. Thus, you cannot attach a treerow to it again if set an image or a label.
  - getSrc
```
public String getSrc()
```
    Deprecated. As of release 3.5.0, it is redundant since it the same as getImage().
  - setSrc
```
public void setSrc(String src)
```
    Deprecated. As of release 3.5.0, it is redundant since it the same as setImage(java.lang.String).
  - getImage
```
public String getImage()
```
    Returns the image of the Treecell it contains.
  - setImage
```
public void setImage(String image)
```
    Sets the image of the Treecell it contains.
    If treerow and treecell are not created, we automatically create it.
    Notice that this method will create a treerow and treecell automatically if they don't exist. Thus, you cannot attach a treerow to it again if set an image or a label.
  - getParentItem
```
public Treeitem getParentItem()
```
    Returns the parent tree item, or null if this item is already the top level of the tree. The parent tree item is actually the grandparent if any.
    
    Since:
    
    3.0.0
  - getTree
```
public Tree getTree()
```
    Returns the tree owning this item.
  - setVisible
```
public boolean setVisible(boolean visible)
```
    Specified by:
    
    setVisible in interface org.zkoss.zk.ui.Component
    
    Overrides:
    
    setVisible in class org.zkoss.zk.ui.AbstractComponent
  - getVisibleItemCount
```
public int getVisibleItemCount()
```
    Returns the number of visible descendant Treechildren. Descendants include direct children, grand children and so on.
    
    Since:
    
    3.6.1
  - setWidth
```
public void setWidth(String width)
```
    Deprecated. as of release 6.0.0. To control the size of Tree related components, please refer to Tree and Treecol instead.
    
    Overrides:
    
    setWidth in class org.zkoss.zk.ui.HtmlBasedComponent
  - setHflex
```
public void setHflex(String flex)
```
    Deprecated. as of release 6.0.0. To control the size of Tree related components, please refer to Tree and Treecol instead.
    
    Overrides:
    
    setHflex in class org.zkoss.zk.ui.HtmlBasedComponent
  - beforeParentChanged
```
public void beforeParentChanged(org.zkoss.zk.ui.Component parent)
```
    Specified by:
    
    beforeParentChanged in interface org.zkoss.zk.ui.sys.ComponentCtrl
    
    Overrides:
    
    beforeParentChanged in class org.zkoss.zk.ui.AbstractComponent
  - setParent
```
public void setParent(org.zkoss.zk.ui.Component parent)
```
    Specified by:
    
    setParent in interface org.zkoss.zk.ui.Component
    
    Overrides:
    
    setParent in class org.zkoss.zk.ui.AbstractComponent
  - beforeChildAdded
```
public void beforeChildAdded(org.zkoss.zk.ui.Component child,
                    org.zkoss.zk.ui.Component refChild)
```
    Specified by:
    
    beforeChildAdded in interface org.zkoss.zk.ui.sys.ComponentCtrl
    
    Overrides:
    
    beforeChildAdded in class org.zkoss.zk.ui.AbstractComponent
  - insertBefore
```
public boolean insertBefore(org.zkoss.zk.ui.Component child,
                   org.zkoss.zk.ui.Component refChild)
```
    Specified by:
    
    insertBefore in interface org.zkoss.zk.ui.Component
    
    Overrides:
    
    insertBefore in class org.zkoss.zk.ui.AbstractComponent
  - onChildAdded
```
public void onChildAdded(org.zkoss.zk.ui.Component child)
```
    Specified by:
    
    onChildAdded in interface org.zkoss.zk.ui.sys.ComponentCtrl
    
    Overrides:
    
    onChildAdded in class org.zkoss.zk.ui.AbstractComponent
  - onChildRemoved
```
public void onChildRemoved(org.zkoss.zk.ui.Component child)
```
    Specified by:
    
    onChildRemoved in interface org.zkoss.zk.ui.sys.ComponentCtrl
    
    Overrides:
    
    onChildRemoved in class org.zkoss.zk.ui.AbstractComponent
  - redrawChildren
```
protected void redrawChildren(Writer out)
                       throws IOException
```
    Overrides:
    
    redrawChildren in class org.zkoss.zk.ui.AbstractComponent
    
    Throws:
    
    IOException
  - clone
```
public Object clone()
```
    Specified by:
    
    clone in interface org.zkoss.zk.ui.Component
    
    Overrides:
    
    clone in class XulElement
  - renderProperties
```
protected void renderProperties(org.zkoss.zk.ui.sys.ContentRenderer renderer)
                         throws IOException
```
    Overrides:
    
    renderProperties in class XulElement
    
    Throws:
    
    IOException
  - service
```
public void service(org.zkoss.zk.au.AuRequest request,
           boolean everError)
```
    Processes an AU request.
    Default: in addition to what are handled by HtmlBasedComponent.service(org.zkoss.zk.au.AuRequest, boolean), it also handles onOpen.
    
    Specified by:
    
    service in interface org.zkoss.zk.ui.sys.ComponentCtrl
    
    Overrides:
    
    service in class org.zkoss.zk.ui.HtmlBasedComponent
    
    Since:
    
    5.0.0

Class Treeitem

Nested Class Summary

Nested classes/interfaces inherited from class org.zkoss.zk.ui.HtmlBasedComponent

Nested classes/interfaces inherited from class org.zkoss.zk.ui.AbstractComponent

Field Summary

Fields inherited from class org.zkoss.zk.ui.HtmlBasedComponent

Fields inherited from interface org.zkoss.zk.ui.Component

Fields inherited from interface org.zkoss.zk.ui.sys.ComponentCtrl

Constructor Summary

Method Summary

Methods inherited from class org.zkoss.zul.impl.XulElement

Methods inherited from class org.zkoss.zk.ui.HtmlBasedComponent

Methods inherited from class org.zkoss.zk.ui.AbstractComponent

Methods inherited from class java.lang.Object

Constructor Detail

Treeitem

Treeitem

Treeitem

Method Detail

isCheckable

setCheckable

isSelectable

setSelectable

unload

setDisabled

isDisabled

isRendered

isLoaded

setStubonly

setStubonly

getIndex

indexOf

getTreerow

getTreechildren

isContainer

isEmpty

getValue

setValue

isOpen

setOpen

isSelected

setSelected

getLevel

getLabel

setLabel

getSrc

setSrc

getImage

setImage

getParentItem

getTree

setVisible

getVisibleItemCount

setWidth

setHflex

beforeParentChanged

setParent

beforeChildAdded

insertBefore

onChildAdded

onChildRemoved

redrawChildren

clone

renderProperties

service