org.zkoss.zul
Class Treeitem

java.lang.Object
  extended by org.zkoss.zk.ui.AbstractComponent
      extended by org.zkoss.zk.ui.HtmlBasedComponent
          extended by org.zkoss.zul.impl.XulElement
              extended by 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
Treeitem()
           
Treeitem(String label)
           
Treeitem(String label, Object value)
           
 
Method Summary
 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()
          Returns whether it is checkable.
 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 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)
          Sets whether it is checkable.
 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 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).
<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, 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, addScopeListener, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildRemoved, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableClientUpdate, equals, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAnnotations, getAttribute, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getAutag, getChildren, getClientEvents, getDefaultMold, getDefinition, getDesktop, getEventHandler, getEventHandlerNames, getEventListenerMap, getEventListeners, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getSpaceOwner, getStubonly, getTemplate, getTemplateNames, getUuid, getWidgetAttribute, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttribute, hasAttributeOrFellow, hasFellow, hasFellow, invalidate, isChildable, isInvalidated, isListenerAvailable, isVisible, onPageAttached, onPageDetached, onWrongValue, query, queryAll, redraw, removeAttribute, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, removeScopeListener, render, render, render, replace, response, response, response, service, sessionDidActivate, sessionWillPassivate, setAttribute, setAttribute, setAttribute, setAuService, setAutag, setDefinition, setDefinition, setId, setMold, setPage, setPageBefore, setStubonly, setStubonly, setTemplate, setVisibleDirectly, setWidgetAttribute, setWidgetClass, setWidgetListener, setWidgetOverride, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdateWidgetListener, smartUpdateWidgetOverride, toString, updateByClient, 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()
Returns whether it is checkable.

Default: true.

Since:
3.0.4

setCheckable

public void setCheckable(boolean checkable)
Sets whether it is checkable.

Note that it is only applied when isCheckmark() of Tree is true.

Default: true.

Since:
3.0.4

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

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

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


Copyright © 2014. All rights reserved.