org.zkoss.zul
Class Treecell

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.impl.LabelElement
                  extended by org.zkoss.zul.impl.LabelImageElement
                      extended by org.zkoss.zul.Treecell
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, HtmlBasedComponent, Component, Scope, ComponentCtrl, Treecell, LabelElement, LabelImageElement, XulElement

public class Treecell
extends LabelImageElement
implements Treecell

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
_height, _left, _top, _width, _zclass
 
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
 
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.
 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.
 Tree getTreeApi()
          Return the tree that owns this cell.
 Treecol getTreecol()
          Returns the tree col associated with this cell, or null if not available.
 Treecol getTreecolApi()
          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.
static boolean isLastChild(Treeitem item)
          Returns whether an item is the last visible child.
protected  void renderProperties(ContentRenderer renderer)
          Renders the content of this component, excluding the enclosing tags and children.
 void setSpan(int span)
          Sets the number of columns to span this cell.
 void setWidth(java.lang.String width)
          Sets the width.
 
Methods inherited from class org.zkoss.zul.impl.LabelImageElement
getHoverImage, getImage, getImageContent, getSrc, isImageAssigned, newExtraCtrl, setHoverImage, setHoverImageContent, setHoverImageContent, setImage, setImageContent, setImageContent, setSrc
 
Methods inherited from class org.zkoss.zul.impl.LabelElement
getLabel, setLabel
 
Methods inherited from class org.zkoss.zul.impl.XulElement
getAction, getContext, getCtrlKeys, getPopup, getTooltip, setAction, setContext, setContext, setCtrlKeys, setPopup, setPopup, setTooltip, setTooltip
 
Methods inherited from class org.zkoss.zk.ui.HtmlBasedComponent
focus, getDraggable, getDroppable, getHeight, getHflex, getLeft, getSclass, getStyle, getTooltiptext, getTop, getVflex, getZindex, getZIndex, service, setClass, setDraggable, setDroppable, setFocus, setHeight, setHflex, setLeft, setSclass, setStyle, setTooltiptext, setTop, setVflex, setZclass, setZindex, setZIndex
 
Methods inherited from class org.zkoss.zk.ui.AbstractComponent
addAnnotation, addAnnotation, addClientEvent, addEventHandler, addEventListener, addForward, addForward, addForward, addForward, addMoved, addScopeListener, addSharedAnnotationMap, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildAdded, beforeChildRemoved, clone, containsVariable, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableClientUpdate, equals, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAttribute, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getChildren, getClientEvents, getDefinition, getDesktop, getEventHandler, getEventHandlerNames, getExtraCtrl, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNamespace, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getSpaceOwner, getUuid, getVariable, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttribute, hasAttributeOrFellow, hasFellow, hasFellow, insertBefore, invalidate, isChildable, isInvalidated, isListenerAvailable, isVisible, newChildren, onChildAdded, onChildRemoved, onPageAttached, onPageDetached, onWrongValue, redraw, redrawChildren, removeAttribute, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, removeScopeListener, render, render, render, response, sessionDidActivate, sessionWillPassivate, setAttribute, setAttribute, setAttribute, setAuService, setDefinition, setDefinition, setId, setMold, setPage, setPageBefore, setParent, setVariable, setVisible, setWidgetListener, setWidgetOverride, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdateWidgetListener, smartUpdateWidgetOverride, toString, unsetVariable, updateByClient, willPassivate, willPassivate, willSerialize, willSerialize
 
Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.zkoss.zul.impl.api.LabelImageElement
getHoverImage, getImage, getImageContent, setHoverImage, setHoverImageContent, setHoverImageContent, setImage, setImageContent, setImageContent
 
Methods inherited from interface org.zkoss.zul.impl.api.LabelElement
getLabel, setLabel
 
Methods inherited from interface org.zkoss.zul.impl.api.XulElement
getAction, getContext, getCtrlKeys, getPopup, getTooltip, setAction, setContext, setContext, setCtrlKeys, setPopup, setPopup, setTooltip, setTooltip
 
Methods inherited from interface org.zkoss.zk.ui.api.HtmlBasedComponent
focus, getHeight, getLeft, getSclass, getStyle, getTooltiptext, getTop, getZindex, getZIndex, setDraggable, setDroppable, setFocus, setHeight, setLeft, setSclass, setStyle, setTooltiptext, setTop, setZclass, setZindex, setZIndex
 
Methods inherited from interface org.zkoss.zk.ui.Component
addEventListener, addForward, addForward, addForward, addForward, appendChild, applyProperties, clone, containsVariable, detach, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getChildren, getDefinition, getDesktop, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNamespace, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getSpaceOwner, getUuid, getVariable, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttributeOrFellow, hasFellow, hasFellow, insertBefore, invalidate, isInvalidated, isListenerAvailable, isVisible, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, setAttribute, setAttribute, setAuService, setId, setMold, setPage, setPageBefore, setParent, setVariable, setVisible, setWidgetListener, setWidgetOverride, unsetVariable
 
Methods inherited from interface org.zkoss.zk.ui.ext.Scope
addScopeListener, getAttribute, hasAttribute, removeAttribute, removeScopeListener, setAttribute
 

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.


getTreeApi

public Tree getTreeApi()
Return the tree that owns this cell.

Specified by:
getTreeApi in interface Treecell
Since:
3.5.2

getTreecol

public Treecol getTreecol()
Returns the tree col associated with this cell, or null if not available.


getTreecolApi

public Treecol getTreecolApi()
Returns the tree col associated with this cell, or null if not available.

Specified by:
getTreecolApi in interface Treecell
Since:
3.5.2

getColumnIndex

public int getColumnIndex()
Returns the column index of this cell, starting from 0.

Specified by:
getColumnIndex in interface Treecell

getMaxlength

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

Specified by:
getMaxlength in interface Treecell

getLevel

public int getLevel()
Returns the level this cell is. The root is level 0.

Specified by:
getLevel in interface Treecell

getSpan

public int getSpan()
Returns number of columns to span this cell. Default: 1.

Specified by:
getSpan in interface Treecell

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.

Specified by:
setSpan in interface Treecell

isLastChild

public static boolean isLastChild(Treeitem item)
Returns whether an item is the last visible child.


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.

Specified by:
getZclass in interface HtmlBasedComponent
Overrides:
getZclass in class HtmlBasedComponent
See Also:
HtmlBasedComponent.getSclass()

getWidth

public java.lang.String getWidth()
Returns the width which the same as getTreecol()'s width.

Specified by:
getWidth in interface HtmlBasedComponent
Overrides:
getWidth in class HtmlBasedComponent

setWidth

public void setWidth(java.lang.String width)
Description copied from class: HtmlBasedComponent
Sets the width. If null, the best fit is used.

Specified by:
setWidth in interface HtmlBasedComponent
Overrides:
setWidth in class HtmlBasedComponent

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 Render Special Properties

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)


Copyright © 2005-2009 Potix Corporation. All Rights Reserved. SourceForge.net Logo