|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.zkoss.zk.ui.AbstractComponent
org.zkoss.zk.ui.HtmlBasedComponent
org.zkoss.zul.impl.XulElement
org.zkoss.zul.Treechildren
public class Treechildren
A treechildren.
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 |
---|
_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 | |
---|---|
Treechildren()
|
Method Summary | |
---|---|
void |
beforeChildAdded(Component child,
Component refChild)
Default: does nothing. |
void |
beforeParentChanged(Component parent)
Default: does nothing. |
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. |
Tree |
getTree()
Returns the Tree instance containing this element. |
Tree |
getTreeApi()
Returns the Tree instance containing this element. |
java.util.Iterator |
getVisibleChildrenIterator()
Returns an iterator to iterate thru all visible children. |
int |
getVisibleItemCount()
Returns the number of visible descendant Treeitem . |
java.lang.String |
getZclass()
Returns the ZK Cascading Style class(es) for this component. |
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. |
protected void |
redrawChildren(java.io.Writer out)
Redraws childrens (and then recursively descandants). |
void |
setParent(Component parent)
Sets the parent component. |
protected void |
smartUpdate(java.lang.String name,
java.lang.Object value)
Smart-updates a property of the peer widget associated with the component, running at the client, with the specified value. |
Methods inherited from class org.zkoss.zul.impl.XulElement |
---|
getAction, getContext, getCtrlKeys, getPopup, getTooltip, renderProperties, 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, getWidth, getZindex, getZIndex, service, setClass, setDraggable, setDroppable, setFocus, setHeight, setHflex, setLeft, setSclass, setStyle, setTooltiptext, setTop, setVflex, setWidth, setZclass, setZindex, setZIndex |
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.ext.Scope |
---|
addScopeListener, getAttribute, hasAttribute, removeAttribute, removeScopeListener, setAttribute |
Constructor Detail |
---|
public Treechildren()
Method Detail |
---|
public Tree getTree()
Tree
instance containing this element.
public Tree getTreeApi()
Tree
instance containing this element.
getTreeApi
in interface Treechildren
public Treerow getLinkedTreerow()
Treerow
that is associated with
this treechildren, or null if no such treerow.
In other words, it is Treeitem.getTreerow()
of
AbstractComponent.getParent()
.
Treerow.getLinkedTreechildren()
public Treerow getLinkedTreerowApi()
Treerow
that is associated with
this treechildren, or null if no such treerow.
In other words, it is Treeitem.getTreerow()
of
AbstractComponent.getParent()
.
getLinkedTreerowApi
in interface Treechildren
Treerow.getLinkedTreechildren()
public boolean isVisible()
Besides depends on AbstractComponent.setVisible(boolean)
, it also depends on
whether all its ancestors is open.
isVisible
in interface Component
isVisible
in class AbstractComponent
Components.isRealVisible(org.zkoss.zk.ui.Component)
public java.util.Collection getItems()
Treeitem
(children's children and so on).
Note: the performance of the size method of returned collection is no good.
getItems
in interface Treechildren
public int getItemCount()
Treeitem
including all descendants. The same as getItems()
.size().
Note: the performance is no good.
getItemCount
in interface Treechildren
public int getVisibleItemCount()
Treeitem
.
Descendants include direct children, gran children and so on.
getVisibleItemCount
in interface Treechildren
public void onChildAdded(Component child)
AbstractComponent
onChildAdded
in interface ComponentCtrl
onChildAdded
in class AbstractComponent
ComponentCtrl.onChildAdded(org.zkoss.zk.ui.Component)
public void onChildRemoved(Component child)
AbstractComponent
onChildRemoved
in interface ComponentCtrl
onChildRemoved
in class AbstractComponent
ComponentCtrl.onChildRemoved(org.zkoss.zk.ui.Component)
public void beforeParentChanged(Component parent)
AbstractComponent
beforeParentChanged
in interface ComponentCtrl
beforeParentChanged
in class AbstractComponent
parent
- the new parent. If null, it means detachment.ComponentCtrl.beforeParentChanged(org.zkoss.zk.ui.Component)
public void setParent(Component 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.
setParent
in interface Component
setParent
in class AbstractComponent
public void beforeChildAdded(Component child, Component refChild)
AbstractComponent
beforeChildAdded
in interface ComponentCtrl
beforeChildAdded
in class AbstractComponent
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.ComponentCtrl.beforeChildAdded(org.zkoss.zk.ui.Component, org.zkoss.zk.ui.Component)
public java.lang.String getZclass()
HtmlBasedComponent
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.
getZclass
in interface HtmlBasedComponent
getZclass
in class HtmlBasedComponent
HtmlBasedComponent.getSclass()
protected void smartUpdate(java.lang.String name, java.lang.Object value)
AbstractComponent
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 AbstractComponent.invalidate()
is ever invoked
(in the same execution), since AbstractComponent.invalidate()
assumes
the whole content shall be redrawn and all smart updates to
this components can be ignored,
Once AbstractComponent.invalidate()
is called, all invocations to AbstractComponent.smartUpdate(java.lang.String, java.lang.Object)
will then be ignored, and AbstractComponent.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 AbstractComponent.smartUpdate(java.lang.String, java.lang.Object)
.
While Component.invalidate()
causes the whole content to redraw,
AbstractComponent.smartUpdate(java.lang.String, java.lang.Object)
let component developer control which part
to redraw.
smartUpdate
in class AbstractComponent
value
- the new value.
If it is DeferredValue
, the value
will be retrieved (by calling DeferredValue.getValue()
)
in the rendering phase. It is useful if the value can not be determined now.
For some old application servers (example, Webshpere 5.1),
Execution.encodeURL(java.lang.String)
cannot be called in the event processing
thread. So, the developers have to use DeferredValue
or disable the use of the event processing thread
(by use of disable-event-thread
in zk.xml).
In addition, the value can be any kind of objects that the client accepts (marshaled by JSON).
AbstractComponent.updateByClient(java.lang.String, java.lang.Object)
public java.util.Iterator getVisibleChildrenIterator()
getVisibleItemCount()
, it handles only the direct children.
Component developer only.
protected void redrawChildren(java.io.Writer out) throws java.io.IOException
AbstractComponent
Default: it invokes AbstractComponent.redraw(java.io.Writer)
for all its children.
If a derived class renders only a subset of its children
(such as paging/cropping), it could override AbstractComponent.redrawChildren(java.io.Writer)
.
redrawChildren
in class AbstractComponent
java.io.IOException
AbstractComponent.redraw(java.io.Writer)
protected java.lang.Object newExtraCtrl()
HtmlBasedComponent
AbstractComponent.getExtraCtrl()
to create a client control.
It is used only by component developers.
Defaut: creates an instance of HtmlBasedComponent.ExtraCtrl
.
newExtraCtrl
in class HtmlBasedComponent
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |