org.zkoss.zul
Class Treecell

java.lang.Object
  org.zkoss.zk.ui.AbstractComponent
      org.zkoss.zk.ui.HtmlBasedComponent
          org.zkoss.zul.impl.XulElement
              org.zkoss.zul.impl.LabelElement
                  org.zkoss.zul.impl.LabelImageElement
                      org.zkoss.zul.Treecell

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, Component, Scope, ComponentCtrl

public class Treecell
extends LabelImageElement

A treecell.

In XUL, treecell cannot have any child, but ZUL allows it. Thus, you could place any kind of children in it. They will be placed right after the image and label.

Default getZclass(): z-treecell (since 5.0.0)

Author:

tomyeh

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.zkoss.zul.impl.LabelImageElement

LabelImageElement.ExtraCtrl

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

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

Treecell()

Treecell(java.lang.String label)

Treecell(java.lang.String label, java.lang.String src)

Method Summary

void	beforeParentChanged(Component parent) Default: does nothing.
java.lang.Object	clone() Clones the component.
int	getColumnIndex() Returns the column index of this cell, starting from 0.
int	getLevel() Returns the level this cell is.
int	getMaxlength() Returns the maximal length for this cell, which is decided by the corresponding getTreecol()'s Treecol.getMaxlength().
int	getSpan() Returns number of columns to span this cell.
Tree	getTree() Return the tree that owns this cell.
Treecol	getTreecol() Returns the tree col associated with this cell, or null if not available.
java.lang.String	getWidth() Returns the width which the same as getTreecol()'s width.
java.lang.String	getZclass() Returns the ZK Cascading Style class(es) for this component.
protected void	renderProperties(ContentRenderer renderer) Renders the content of this component, excluding the enclosing tags and children.
void	setHflex(java.lang.String flex) Deprecated. as of release 6.0.0. To control the hflex of Treecell, please use HtmlBasedComponent.setHflex(String) instead.
void	setSpan(int span) Sets the number of columns to span this cell.
void	setWidth(java.lang.String width) Deprecated. as of release 6.0.0. To control the width of Treecell, please use HtmlBasedComponent.setWidth(String) instead.

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

getExtraCtrl, getHoverImage, getHoverImageContent, getImage, getImageContent, getSrc, isImageAssigned, setHoverImage, setHoverImageContent, setHoverImageContent, setImage, setImageContent, setImageContent, setSrc

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

getLabel, renderCrawlable, setLabel

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, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getStyle, getTooltiptext, getTop, getVflex, getZindex, getZIndex, service, 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, beforeChildAdded, 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, insertBefore, invalidate, isChildable, isInvalidated, isListenerAvailable, isVisible, onChildAdded, onChildRemoved, onPageAttached, onPageDetached, onWrongValue, query, queryAll, redraw, redrawChildren, 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, setParent, setStubonly, setStubonly, setTemplate, setVisible, 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

Treecell

public Treecell()

Treecell

public Treecell(java.lang.String label)

Treecell

public Treecell(java.lang.String label,
                java.lang.String src)

Method Detail

getTree

public Tree getTree()

Return the tree that owns this cell.

getTreecol

public Treecol getTreecol()

Returns the tree col associated with this cell, or null if not available.

getColumnIndex

public int getColumnIndex()

Returns the column index of this cell, starting from 0.

getMaxlength

public int getMaxlength()

Returns the maximal length for this cell, which is decided by the corresponding getTreecol()'s Treecol.getMaxlength().

getLevel

public int getLevel()

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

getSpan

public int getSpan()

Returns number of columns to span this cell. Default: 1.

setSpan

public void setSpan(int span)

Sets the number of columns to span this cell.

It is the same as the colspan attribute of HTML TD tag.

getZclass

public java.lang.String getZclass()

Description copied from class: HtmlBasedComponent

Returns the ZK Cascading Style class(es) for this component. It usually depends on the implementation of the mold (@{link #getMold}).

Default: null (the default value depends on element).

HtmlBasedComponent.setZclass(java.lang.String)) will completely replace the default style of a component. In other words, the default style of a component is associated with the default value of HtmlBasedComponent.getZclass(). Once it is changed, the default style won't be applied at all. If you want to perform small adjustments, use HtmlBasedComponent.setSclass(java.lang.String) instead.

Overrides:

getZclass in class HtmlBasedComponent

See Also:

HtmlBasedComponent.getSclass()

clone

public java.lang.Object clone()

Description copied from interface: Component

Clones the component. All of its children and descendants are cloned. Also, ID are preserved.

Specified by:

clone in interface Component

Overrides:

clone in class LabelImageElement

Returns:

the new component. Notice that it doesn't belong to any page, nor desktop. It doesn't have a parent, either.

getWidth

public java.lang.String getWidth()

Returns the width which the same as getTreecol()'s width.

Overrides:

getWidth in class HtmlBasedComponent

setWidth

public void setWidth(java.lang.String width)

Deprecated. as of release 6.0.0. To control the width of Treecell, please use HtmlBasedComponent.setWidth(String) instead.

Description copied from class: HtmlBasedComponent

Sets the width. If null, the best fit is used.

Overrides:

setWidth in class HtmlBasedComponent

See Also:

HtmlBasedComponent.setWidthDirectly(java.lang.String), AbstractComponent.disableClientUpdate(boolean)

setHflex

public void setHflex(java.lang.String flex)

Deprecated. as of release 6.0.0. To control the hflex of Treecell, please use HtmlBasedComponent.setHflex(String) instead.

Description copied from class: HtmlBasedComponent

Sets horizontal flex hint of this component.

Number flex indicates how this component's container distributes remaining empty space among its children horizontally. Flexible component grow and shrink to fit their given space. Flexible components with larger flex values will be made larger than components with lower flex values, at the ratio determined by all flexible components. The actual flex value is not relevant unless there are other flexible components within the same container. Once the default sizes of components in a container are calculated, the remaining space in the container is divided among the flexible components, according to their flex ratios.

Specify a flex value of negative value, 0, or "false" has the same effect as leaving the flex attribute out entirely. Specify a flex value of "true" has the same effect as a flex value of 1.

Special flex hint, "min", indicates that the minimum space shall be given to this flexible component to enclose all of its children components. That is, the flexible component grow and shrink to fit its children components.

Overrides:

setHflex in class HtmlBasedComponent

Parameters:

flex - horizontal flex hint of this component.

See Also:

HtmlBasedComponent.setVflex(java.lang.String), HtmlBasedComponent.getHflex()

renderProperties

protected void renderProperties(ContentRenderer renderer)
                         throws java.io.IOException

Description copied from class: HtmlBasedComponent

Renders the content of this component, excluding the enclosing tags and children.

See also ZK Client-side Reference: Property Rendering

Overrides:

renderProperties in class LabelImageElement

Throws:

java.io.IOException

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)