org.zkoss.zul
Class Treechildren

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

All Implemented Interfaces:

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

public class Treechildren
extends XulElement
implements Treechildren

A treechildren.

Author:

tomyeh

See Also:

Serialized Form

Nested Class Summary

protected class

Treechildren.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

Treechildren()

Method Summary

void	beforeChildAdded(Component child, Component refChild) Default: does nothing.
void	beforeParentChanged(Component parent) Default: does nothing.
int	getActivePage() Deprecated. As of release 3.0.7, the page size is controlled by Tree.getPageSize() rather than this method. It always return 0 since 3.0.7.
int	getItemCount() Returns the number of child Treeitem including all descendants.
java.util.Collection	getItems() Returns a readonly list of all descending Treeitem (children's children and so on).
Treerow	getLinkedTreerow() Returns the Treerow that is associated with this treechildren, or null if no such treerow.
Treerow	getLinkedTreerowApi() Returns the Treerow that is associated with this treechildren, or null if no such treerow.
int	getPageCount() Deprecated. As of release 3.0.7, the page size is controlled by Tree.getPageSize() rather than this method. It always return 1 since 3.0.7.
int	getPageSize() Deprecated. As of release 3.0.7, the page size is controlled by Tree.getPageSize() rather than this method. It always return -1 since 3.0.7.
Tree	getTree() Returns the Tree instance containing this element.
Tree	getTreeApi() Returns the Tree instance containing this element.
int	getVisibleBegin() Deprecated. As of release 3.0.7, the page size is controlled by Tree.setPageSize(int) rather than this method. It always returns 0 since 3.0.7
java.util.Iterator	getVisibleChildrenIterator() Returns an iterator to iterate thru all visible children.
int	getVisibleEnd() Deprecated. As of release 3.0.7, the page size is controlled by Tree.setPageSize(int) rather than this method. It always returns Integer.MAX_VALUE since 3.0.7
int	getVisibleItemCount() Returns the number of visible descendant Treeitem.
java.lang.String	getZclass() Returns the ZK Cascading Style class(es) for this component.
void	invalidate() Invalidates this component by setting the dirty flag such that it will be redraw the whole content later.
boolean	isVisible() Returns whether this is visible.
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	setActivePage(int pg) Deprecated. As of release 3.0.7, the page size is controlled by Tree.setPageSize(int) rather than this method. It always does nothing since 3.0.7
void	setPageSize(int size) Deprecated. As of release 3.0.7, the page size is controlled by Tree.setPageSize(int) rather than this method. It always does nothing since 3.0.7
void	setParent(Component parent) Sets the parent component.
void	smartUpdate(java.lang.String name, java.lang.String value) Smart-updates a property with the specified value.

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

getAction, getActionAttrs, getAllOnClickAttrs, getContext, getCtrlKeys, getInnerAttrs, getOuterAttrs, getPopup, getTooltip, setAction, 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, getZindex, getZIndex, redraw, setClass, setDraggable, setDroppable, 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, clone, 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, insertBefore, isAsapRequired, isChildable, isInvalidated, isListenerAvailable, newChildren, onDrawNewChild, onPageAttached, onPageDetached, onWrongValue, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, response, sessionDidActivate, sessionWillPassivate, setAttribute, setAttribute, setComponentDefinition, setId, setMold, setPage, setPageBefore, setVariable, setVisible, 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, 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, getWidth, getZindex, getZIndex, setDraggable, setDroppable, 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, clone, 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, insertBefore, isChildable, isInvalidated, isListenerAvailable, redraw, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, setAttribute, setAttribute, setId, setMold, setPage, setPageBefore, setVariable, setVisible, unsetVariable

Constructor Detail

Treechildren

public Treechildren()

Method Detail

getTree

public Tree getTree()

Returns the Tree instance containing this element.

getTreeApi

public Tree getTreeApi()

Returns the Tree instance containing this element.

Specified by:

getTreeApi in interface Treechildren

Since:

3.5.2

getLinkedTreerow

public Treerow getLinkedTreerow()

Returns the Treerow that is associated with this treechildren, or null if no such treerow. In other words, it is Treeitem.getTreerow() of AbstractComponent.getParent().

Since:

2.4.1

See Also:

Treerow.getLinkedTreechildren()

getLinkedTreerowApi

public Treerow getLinkedTreerowApi()

Returns the Treerow that is associated with this treechildren, or null if no such treerow. In other words, it is Treeitem.getTreerow() of AbstractComponent.getParent().

Specified by:

getLinkedTreerowApi in interface Treechildren

Since:

3.5.2

See Also:

Treerow.getLinkedTreechildren()

isVisible

public boolean isVisible()

Returns whether this is visible.

Besides depends on AbstractComponent.setVisible(boolean), it also depends on whether all its ancestors is open.

Specified by:

isVisible in interface Component

Overrides:

isVisible in class AbstractComponent

See Also:

Components.isRealVisible(org.zkoss.zk.ui.Component)

getItems

public java.util.Collection getItems()

Returns a readonly list of all descending Treeitem (children's children and so on).

Note: the performance of the size method of returned collection is no good.

Specified by:

getItems in interface Treechildren

getItemCount

public int getItemCount()

Returns the number of child Treeitem including all descendants. The same as getItems().size().

Note: the performance is no good.

Specified by:

getItemCount in interface Treechildren

getVisibleItemCount

public int getVisibleItemCount()

Returns the number of visible descendant Treeitem. Descendants include direct children, gran children and so on.

Specified by:

getVisibleItemCount in interface Treechildren

Since:

3.0.7

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)

getPageSize

public int getPageSize()

Deprecated. As of release 3.0.7, the page size is controlled by Tree.getPageSize() rather than this method. It always return -1 since 3.0.7.

setPageSize

public void setPageSize(int size)
                 throws WrongValueException

Deprecated. As of release 3.0.7, the page size is controlled by Tree.setPageSize(int) rather than this method. It always does nothing since 3.0.7

Throws:

WrongValueException

getPageCount

public int getPageCount()

Deprecated. As of release 3.0.7, the page size is controlled by Tree.getPageSize() rather than this method. It always return 1 since 3.0.7.

getActivePage

public int getActivePage()

Deprecated. As of release 3.0.7, the page size is controlled by Tree.getPageSize() rather than this method. It always return 0 since 3.0.7.

setActivePage

public void setActivePage(int pg)
                   throws WrongValueException

Deprecated. As of release 3.0.7, the page size is controlled by Tree.setPageSize(int) rather than this method. It always does nothing since 3.0.7

Throws:

WrongValueException

getVisibleBegin

public int getVisibleBegin()

Deprecated. As of release 3.0.7, the page size is controlled by Tree.setPageSize(int) rather than this method. It always returns 0 since 3.0.7

getVisibleEnd

public int getVisibleEnd()

Deprecated. As of release 3.0.7, the page size is controlled by Tree.setPageSize(int) rather than this method. It always returns Integer.MAX_VALUE since 3.0.7

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)

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

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(), HtmlBasedComponent.getRealSclass()

smartUpdate

public void smartUpdate(java.lang.String name,
                        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[])

getVisibleChildrenIterator

public java.util.Iterator getVisibleChildrenIterator()

Returns an iterator to iterate thru all visible children. Unlike getVisibleItemCount(), it handles only the direct children. Component developer only.

Since:

3.0.7

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