org.zkoss.zul
Class Treeitem

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:

java.io.Serializable, java.lang.Cloneable, HtmlBasedComponent, Component, Scope, ComponentCtrl, Treeitem, XulElement

public class Treeitem
extends XulElement
implements Treeitem

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

protected class

Treeitem.ExtraCtrl A utility class to implement AbstractComponent.getExtraCtrl().

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

AbstractComponent.Children

Field Summary

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

_zclass, RS_NO_DISPLAY, RS_NO_HEIGHT, RS_NO_WIDTH

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

_visible

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

APPLICATION_SCOPE, COMPONENT_SCOPE, DESKTOP_SCOPE, PAGE_SCOPE, REQUEST_SCOPE, SESSION_SCOPE, SPACE_SCOPE

Constructor Summary

Treeitem()

Treeitem(java.lang.String label)

Treeitem(java.lang.String label, java.lang.Object value)

Method Summary

void	beforeChildAdded(Component child, Component refChild) Default: does nothing.
void	beforeParentChanged(Component parent) Default: does nothing.
java.lang.Object	clone() Clones the component.
java.lang.String	getImage() Returns the image of the Treecell it contains.
java.lang.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.
Treeitem	getParentItemApi() Returns the parent tree item, or null if this item is already the top level of the tree.
java.lang.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.
Tree	getTreeApi() Returns the tree owning this item.
Treechildren	getTreechildren() Returns the treechildren that this tree item owns, or null if doesn't have any child.
Treechildren	getTreechildrenApi() Returns the treechildren that this tree item owns, or null if
Treerow	getTreerow() Returns the treerow that this tree item owns (might null).
Treerow	getTreerowApi() Returns the treerow that this tree item owns (might null).
java.lang.Object	getValue() Returns the value.
int	getVisibleItemCount() Returns the number of visible descendant Treechildren.
int	indexOf() return the index of this container
boolean	insertBefore(Component child, Component refChild) Inserts a child before the reference child.
void	invalidate() Invalidates this component by setting the dirty flag such that it will be redraw the whole content later.
protected boolean	isAsapRequired(java.lang.String evtnm) Returns if any non-deferrable (ASAP) event listener is registered for the specified event.
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.
protected java.lang.Object	newExtraCtrl() Used by AbstractComponent.getExtraCtrl() to create a client control.
void	onChildAdded(Component child) Default: does nothing.
void	onChildRemoved(Component child) Default: does nothing.
void	setAction(java.lang.String action) Not callable.
void	setCheckable(boolean checkable) Sets whether it is checkable.
void	setDisabled(boolean disabled) Sets whether it is disabled.
void	setDraggable(java.lang.String draggable) No callable.
void	setDroppable(java.lang.String dropable) No callable.
void	setImage(java.lang.String image) Sets the image of the Treecell it contains.
void	setLabel(java.lang.String label) Sets the label of the Treecell it contains.
void	setOpen(boolean open) Sets whether this container is open.
void	setParent(Component parent) Sets the parent component.
void	setSelected(boolean selected) Returns whether this item is selected.
void	setSrc(java.lang.String src) Deprecated. As of release 3.5.0, it is redundant since it the same as setImage(java.lang.String).
void	setValue(java.lang.Object value) Sets the value.
boolean	setVisible(boolean visible) Sets whether this component is visible.
void	smartUpdate(java.lang.String attr, java.lang.String value) Smart-updates a property with the specified value.
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

getAction, getActionAttrs, getAllOnClickAttrs, getContext, getCtrlKeys, getInnerAttrs, getOuterAttrs, getPopup, getTooltip, setContext, setContext, setCtrlKeys, setPopup, setPopup, setTooltip, setTooltip

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

focus, getAllOnClickAttrs, getDraggable, getDroppable, getHeight, getLeft, getMoldSclass, getRealSclass, getRealStyle, getRealStyleFlags, getSclass, getStyle, getTooltiptext, getTop, getWidth, getZclass, getZindex, getZIndex, redraw, setClass, setFocus, setHeight, setLeft, setMoldSclass, setSclass, setStyle, setTooltiptext, setTop, setWidth, setZclass, setZindex, setZIndex

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

addAnnotation, addAnnotation, addEventHandler, addEventListener, addForward, addForward, addForward, addForward, addMoved, addSharedAnnotationMap, addSharedEventHandlerMap, appendAsapAttr, appendAsapAttr, appendChild, applyProperties, beforeChildRemoved, containsVariable, detach, disableClientUpdate, equals, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAttribute, getAttribute, getAttributes, getAttributes, getChildren, getCommand, getDefinition, getDesktop, getEventHandler, getEventHandlerNames, getExtraCtrl, getFellow, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getMoldURI, getNamespace, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getSpaceOwner, getUuid, getVariable, hasFellow, isChildable, isInvalidated, isListenerAvailable, isVisible, newChildren, onDrawNewChild, onPageAttached, onPageDetached, onWrongValue, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, response, sessionDidActivate, sessionWillPassivate, setAttribute, setAttribute, setComponentDefinition, setId, setMold, setPage, setPageBefore, setVariable, smartUpdate, smartUpdate, smartUpdateDeferred, smartUpdateValues, toString, unsetVariable

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.zkoss.zul.impl.api.XulElement

getAction, getContext, getCtrlKeys, getPopup, getTooltip, setContext, setContext, setCtrlKeys, setPopup, setPopup, setTooltip, setTooltip

Methods inherited from interface org.zkoss.zk.ui.api.HtmlBasedComponent

focus, getHeight, getLeft, getSclass, getStyle, getTooltiptext, getTop, getWidth, getZclass, getZindex, getZIndex, setFocus, setHeight, setLeft, setSclass, setStyle, setTooltiptext, setTop, setWidth, setZclass, setZindex, setZIndex

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

addEventListener, addForward, addForward, addForward, addForward, appendChild, applyProperties, containsVariable, detach, getAttribute, getAttribute, getAttributes, getAttributes, getChildren, getDefinition, getDesktop, getFellow, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNamespace, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getSpaceOwner, getUuid, getVariable, isChildable, isInvalidated, isListenerAvailable, isVisible, redraw, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, setAttribute, setAttribute, setId, setMold, setPage, setPageBefore, setVariable, unsetVariable

Constructor Detail

Treeitem

public Treeitem()

Treeitem

public Treeitem(java.lang.String label)

Treeitem

public Treeitem(java.lang.String label,
                java.lang.Object value)

Method Detail

isCheckable

public boolean isCheckable()

Returns whether it is checkable.

Default: true.

Specified by:

isCheckable in interface Treeitem

Since:

3.0.4

setCheckable

public void setCheckable(boolean checkable)

Sets whether it is checkable.

Default: true.

Specified by:

setCheckable in interface Treeitem

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)

Specified by:

unload in interface Treeitem

Since:

3.0.4

setDisabled

public void setDisabled(boolean disabled)

Sets whether it is disabled.

Specified by:

setDisabled in interface Treeitem

Since:

3.0.1

isDisabled

public boolean isDisabled()

Returns whether it is disabled.

Default: false.

Specified by:

isDisabled in interface Treeitem

Since:

3.0.1

isLoaded

public boolean isLoaded()

Return true whether all children of this tree item, if any, is loaded

Specified by:

isLoaded in interface Treeitem

Returns:

true whether all children of this tree item is loaded

Since:

3.0.0

indexOf

public int indexOf()

return the index of this container

Specified by:

indexOf in interface Treeitem

Returns:

the index of this container

Since:

3.0.0

getTreerow

public Treerow getTreerow()

Returns the treerow that this tree item owns (might null). Each tree items has exactly one tree row.

getTreerowApi

public Treerow getTreerowApi()

Returns the treerow that this tree item owns (might null). Each tree items has exactly one tree row.

Specified by:

getTreerowApi in interface Treeitem

Since:

3.5.2

getTreechildren

public Treechildren getTreechildren()

Returns the treechildren that this tree item owns, or null if doesn't have any child.

getTreechildrenApi

public Treechildren getTreechildrenApi()

Returns the treechildren that this tree item owns, or null if

Specified by:

getTreechildrenApi in interface Treeitem

Since:

3.5.2

isContainer

public boolean isContainer()

Returns whether the element is to act as a container which can have child elements.

Specified by:

isContainer in interface Treeitem

isEmpty

public boolean isEmpty()

Returns whether this element contains no child elements.

Specified by:

isEmpty in interface Treeitem

getValue

public java.lang.Object 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.

Specified by:

getValue in interface Treeitem

setValue

public void setValue(java.lang.Object value)

Sets the value.

Specified by:

setValue in interface Treeitem

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.

Specified by:

isOpen in interface Treeitem

setOpen

public void setOpen(boolean open)

Sets whether this container is open.

Specified by:

setOpen in interface Treeitem

isSelected

public boolean isSelected()

Returns whether this item is selected.

Specified by:

isSelected in interface Treeitem

setSelected

public void setSelected(boolean selected)

Returns whether this item is selected.

Specified by:

setSelected in interface Treeitem

getLevel

public int getLevel()

Returns the level this cell is. The root is level 0.

Specified by:

getLevel in interface Treeitem

getLabel

public java.lang.String getLabel()

Returns the label of the Treecell it contains, or null if no such cell.

Specified by:

getLabel in interface Treeitem

setLabel

public void setLabel(java.lang.String label)

Sets the label of the Treecell it contains.

If it is not created, we automatically create it.

Specified by:

setLabel in interface Treeitem

getSrc

public java.lang.String getSrc()

Deprecated. As of release 3.5.0, it is redundant since it the same as getImage().

setSrc

public void setSrc(java.lang.String src)

Deprecated. As of release 3.5.0, it is redundant since it the same as setImage(java.lang.String).

getImage

public java.lang.String getImage()

Returns the image of the Treecell it contains.

Specified by:

getImage in interface Treeitem

setImage

public void setImage(java.lang.String image)

Sets the image of the Treecell it contains.

If it is not created, we automatically create it.

Specified by:

setImage in interface Treeitem

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

getParentItemApi

public Treeitem getParentItemApi()

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.

Specified by:

getParentItemApi in interface Treeitem

Since:

3.5.2

getTree

public Tree getTree()

Returns the tree owning this item.

getTreeApi

public Tree getTreeApi()

Returns the tree owning this item.

Specified by:

getTreeApi in interface Treeitem

Since:

3.5.2

isAsapRequired

protected boolean isAsapRequired(java.lang.String evtnm)

Description copied from class: AbstractComponent

Returns if any non-deferrable (ASAP) event listener is registered for the specified event. Returns true if you want the component (on the server) to process the event immediately.

Default: return true if any non-deferable event listener of the specified event is found. In other words, it returns Events.isListened(org.zkoss.zk.ui.Component, java.lang.String, boolean) with asap = true.

This method is moved from HtmlBasedComponent to AbstractComponent since 3.0.0.

Overrides:

isAsapRequired in class AbstractComponent

Parameters:

evtnm - the event name, such as onClick

smartUpdate

public void smartUpdate(java.lang.String attr,
                        java.lang.String value)

Description copied from interface: ComponentCtrl

Smart-updates a property with the specified value. Called by component developers to do precise-update.

The second invocation with the same property will replace the previous call. In other words, the same property will be set only once in each execution.

This method has no effect if Component.invalidate() is ever invoked (in the same execution), since Component.invalidate() assumes the whole content shall be redrawn and all smart updates to this components can be ignored,

Once this method is called, all invocations to ComponentCtrl.smartUpdate(java.lang.String, java.lang.String) will then be ignored, and Component.redraw(java.io.Writer) will be invoked later.

It can be called only in the request-processing and event-processing phases; excluding the redrawing phase.

There are two ways to draw a component, one is to invoke Component.invalidate(), and the other is ComponentCtrl.smartUpdate(java.lang.String, java.lang.String). While Component.invalidate() causes the whole content to redraw, ComponentCtrl.smartUpdate(java.lang.String, java.lang.String) let component developer control which part to redraw.

Specified by:

smartUpdate in interface ComponentCtrl

Overrides:

smartUpdate in class AbstractComponent

value - the new value. If null, it means removing the property.

See Also:

ComponentCtrl.smartUpdateDeferred(java.lang.String, org.zkoss.zk.ui.util.DeferredValue), ComponentCtrl.smartUpdateValues(java.lang.String, java.lang.Object[])

setDraggable

public void setDraggable(java.lang.String draggable)

No callable. Use HtmlBasedComponent.setDraggable(java.lang.String) isntead.

Specified by:

setDraggable in interface HtmlBasedComponent

Overrides:

setDraggable in class HtmlBasedComponent

Parameters:

draggable - "false", null or "" to denote non-draggable; "true" for draggable with anonymous identifier; others for an identifier of draggable.

setDroppable

public void setDroppable(java.lang.String dropable)

No callable. Use HtmlBasedComponent.setDroppable(java.lang.String) isntead.

Specified by:

setDroppable in interface HtmlBasedComponent

Overrides:

setDroppable in class HtmlBasedComponent

Parameters:

dropable - "false", null or "" to denote not-droppable; "true" for accepting any draggable types; a list of identifiers, separated by comma for identifiers of draggables this component accept (to be dropped in).

setAction

public void setAction(java.lang.String action)

Not callable. Use XulElement.setAction(java.lang.String) instead.

Specified by:

setAction in interface XulElement

Overrides:

setAction in class XulElement

setVisible

public boolean setVisible(boolean visible)

Description copied from interface: Component

Sets whether this component is visible.

Specified by:

setVisible in interface Component

Overrides:

setVisible in class AbstractComponent

Returns:

the previous visibility

getVisibleItemCount

public int getVisibleItemCount()

Returns the number of visible descendant Treechildren. Descendants include direct children, grand children and so on.

Since:

3.6.1

beforeParentChanged

public void beforeParentChanged(Component parent)

Description copied from class: AbstractComponent

Default: does nothing.

Specified by:

beforeParentChanged in interface ComponentCtrl

Overrides:

beforeParentChanged in class AbstractComponent

Parameters:

parent - the new parent. If null, it means detachment.

See Also:

ComponentCtrl.beforeParentChanged(org.zkoss.zk.ui.Component)

setParent

public void setParent(Component parent)

Description copied from interface: Component

Sets the parent component.

Note: Component.setParent(org.zkoss.zk.ui.Component) always calls back Component.insertBefore(org.zkoss.zk.ui.Component, org.zkoss.zk.ui.Component) and/or Component.removeChild(org.zkoss.zk.ui.Component), while Component.insertBefore(org.zkoss.zk.ui.Component, org.zkoss.zk.ui.Component) and Component.removeChild(org.zkoss.zk.ui.Component) always calls back Component.setParent(org.zkoss.zk.ui.Component), if the parent is changed. Thus, you don't need to override both Component.insertBefore(org.zkoss.zk.ui.Component, org.zkoss.zk.ui.Component) and Component.setParent(org.zkoss.zk.ui.Component), if you want to customize the behavior.

Specified by:

setParent in interface Component

Overrides:

setParent in class AbstractComponent

beforeChildAdded

public void beforeChildAdded(Component child,
                             Component refChild)

Description copied from class: AbstractComponent

Default: does nothing.

Specified by:

beforeChildAdded in interface ComponentCtrl

Overrides:

beforeChildAdded in class AbstractComponent

Parameters:

child - the child to be added (never null).

refChild - another child component that the new child will be inserted before it. If null, the new child will be the last child.

See Also:

ComponentCtrl.beforeChildAdded(org.zkoss.zk.ui.Component, org.zkoss.zk.ui.Component)

insertBefore

public boolean insertBefore(Component child,
                            Component refChild)

Description copied from interface: Component

Inserts a child before the reference child.

You could use Component.setParent(org.zkoss.zk.ui.Component) or Component.appendChild(org.zkoss.zk.ui.Component) instead of this method, unless you want to control where to put the child.

Note: Component.setParent(org.zkoss.zk.ui.Component) always calls back Component.insertBefore(org.zkoss.zk.ui.Component, org.zkoss.zk.ui.Component) and/or Component.removeChild(org.zkoss.zk.ui.Component), while Component.insertBefore(org.zkoss.zk.ui.Component, org.zkoss.zk.ui.Component) and Component.removeChild(org.zkoss.zk.ui.Component) always calls back Component.setParent(org.zkoss.zk.ui.Component), if the parent is changed. Thus, you don't need to override both Component.insertBefore(org.zkoss.zk.ui.Component, org.zkoss.zk.ui.Component) and Component.setParent(org.zkoss.zk.ui.Component), if you want to customize the behavior.

Specified by:

insertBefore in interface Component

Overrides:

insertBefore in class AbstractComponent

Parameters:

child - the new child to be inserted.

refChild - the child before which you want the new child being inserted. If null, the new child is append to the end.

Returns:

true if newChild is added successfully or moved; false if it already has the specified child and the order doesn't change.

onChildAdded

public void onChildAdded(Component child)

Description copied from class: AbstractComponent

Default: does nothing.

Specified by:

onChildAdded in interface ComponentCtrl

Overrides:

onChildAdded in class AbstractComponent

See Also:

ComponentCtrl.onChildAdded(org.zkoss.zk.ui.Component)

onChildRemoved

public void onChildRemoved(Component child)

Description copied from class: AbstractComponent

Default: does nothing.

Specified by:

onChildRemoved in interface ComponentCtrl

Overrides:

onChildRemoved in class AbstractComponent

See Also:

ComponentCtrl.onChildRemoved(org.zkoss.zk.ui.Component)

invalidate

public void invalidate()

Description copied from interface: Component

Invalidates this component by setting the dirty flag such that it will be redraw the whole content later.

It can be called only in the request-processing and event-processing phases; excluding the redrawing phase.

Specified by:

invalidate in interface Component

Overrides:

invalidate in class AbstractComponent

clone

public java.lang.Object clone()

Description copied from interface: Component

Clones the component. All of its children is cloned. Notice that the cloned component doesn't belong to any page, nor desktop. It doesn't have parent, either.

Specified by:

clone in interface Component

Overrides:

clone in class AbstractComponent

newExtraCtrl

protected java.lang.Object newExtraCtrl()

Description copied from class: HtmlBasedComponent

Used by AbstractComponent.getExtraCtrl() to create a client control. It is used only by component developers.

Defaut: creates an instance of HtmlBasedComponent.ExtraCtrl.

Overrides:

newExtraCtrl in class HtmlBasedComponent