public class Treeitem extends XulElement implements Disable
Event:
HtmlBasedComponent.ExtraCtrl
AbstractComponent.Children
_zclass
APPLICATION_SCOPE, COMPONENT_SCOPE, DESKTOP_SCOPE, PAGE_SCOPE, REQUEST_SCOPE, SESSION_SCOPE, SPACE_SCOPE
AFTER_CHILD_ADDED, AFTER_CHILD_REMOVED, AFTER_PAGE_ATTACHED, AFTER_PAGE_DETACHED, CE_BUSY_IGNORE, CE_DUPLICATE_IGNORE, CE_IMPORTANT, CE_NON_DEFERRABLE, CE_REPEAT_IGNORE
Constructor and Description |
---|
Treeitem() |
Treeitem(java.lang.String label) |
Treeitem(java.lang.String label,
java.lang.Object value) |
Modifier and Type | Method and Description |
---|---|
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. |
int |
getIndex()
return the index of this item
|
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.
|
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.
|
Treechildren |
getTreechildren()
Returns the treechildren that this tree item owns, or null if
doesn't have any child.
|
Treerow |
getTreerow()
Returns the treerow that this tree item owns (might null).
|
<T> T |
getValue()
Returns the value.
|
int |
getVisibleItemCount()
Returns the number of visible descendant
Treechildren . |
int |
indexOf()
Deprecated.
As of release 5.0.9, replaced with
getIndex() . |
boolean |
insertBefore(Component child,
Component refChild)
Inserts a child before the reference child.
|
boolean |
isCheckable()
Deprecated.
As of release 8.0.0, please use
isSelectable() |
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 |
isRendered()
Returns true whether this tree item is rendered.
|
boolean |
isSelectable()
Returns whether it is selectable.
|
boolean |
isSelected()
Returns whether this item is selected.
|
void |
onChildAdded(Component child)
Default: handles special event listeners.
|
void |
onChildRemoved(Component child)
Default: handles special event listeners.
|
protected void |
redrawChildren(java.io.Writer out)
Redraws children (and then recursively descendants).
|
protected void |
renderProperties(ContentRenderer renderer)
Renders the content of this component, excluding the enclosing
tags and children.
|
void |
service(AuRequest request,
boolean everError)
Processes an AU request.
|
void |
setCheckable(boolean checkable)
Deprecated.
As of release 8.0.0, please use
setSelectable(boolean) |
void |
setDisabled(boolean disabled)
Sets whether it is disabled.
|
void |
setHflex(java.lang.String flex)
|
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 |
setSelectable(boolean selectable)
Sets whether it is selectable.
|
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 |
setStubonly(boolean stubonly)
Deprecated.
as of release 7.0.3.
|
void |
setStubonly(java.lang.String stubonly)
Deprecated.
as of release 7.0.3.
|
<T> void |
setValue(T value)
Sets the value.
|
boolean |
setVisible(boolean visible)
Sets whether this component is visible.
|
void |
setWidth(java.lang.String width)
|
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) |
getContext, getCtrlKeys, getPopup, getPropertyAccess, getTooltip, setContext, setContext, setContextAttributes, setCtrlKeys, setPopup, setPopup, setPopupAttributes, setTooltip, setTooltip, setTooltipAttributes
focus, getAction, getDraggable, getDroppable, getExtraCtrl, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getStyle, getTabindex, getTabindexInteger, getTooltiptext, getTop, getVflex, getWidth, getZclass, getZindex, getZIndex, setAction, setClass, setDraggable, setDroppable, setFocus, setHeight, setHeight0, setHeightDirectly, setHflex0, setHflexDirectly, setLeft, setLeftDirectly, setRenderdefer, setSclass, setStyle, setTabindex, setTabindex, setTooltiptext, setTop, setTopDirectly, setVflex, setVflex0, setVflexDirectly, setWidth0, setWidthDirectly, setZclass, setZindex, setZIndex, setZIndexDirectly
addAnnotation, addAnnotation, addCallback, addClientEvent, addEventHandler, addEventListener, addEventListener, addForward, addForward, addForward, addForward, addMoved, addRedrawCallback, addScopeListener, addShadowRoot, addShadowRootBefore, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildRemoved, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableBindingAnnotation, disableClientUpdate, enableBindingAnnotation, equals, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAnnotations, getAttribute, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getAutag, getCallback, getChildren, getClientAttribute, getClientDataAttribute, getClientEvents, getDefaultMold, getDefinition, getDesktop, getEventHandler, getEventHandlerNames, getEventListenerMap, getEventListeners, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNextSibling, getPage, getParent, getPreviousSibling, getRedrawCallback, getRoot, getShadowFellowIfAny, getShadowRoots, getShadowVariable, getShadowVariable, getShadowVariable0, getSpaceOwner, getSpecialRendererOutput, getStubonly, getSubBindingAnnotationCount, getTemplate, getTemplateNames, getUuid, getWidgetAttribute, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttribute, hasAttributeOrFellow, hasBindingAnnotation, hasFellow, hasFellow, hasSubBindingAnnotation, invalidate, isChildable, isInvalidated, isListenerAvailable, isVisible, onPageAttached, onPageDetached, onWrongValue, query, queryAll, redraw, removeAttribute, removeAttribute, removeAttribute, removeCallback, removeChild, removeEventListener, removeForward, removeForward, removeRedrawCallback, removeScopeListener, removeShadowRoot, render, render, render, replace, response, response, response, service, sessionDidActivate, sessionWillPassivate, setAttribute, setAttribute, setAttribute, setAuService, setAutag, setClientAttribute, setClientDataAttribute, setDefinition, setDefinition, setId, setMold, setPage, setPageBefore, setSubBindingAnnotationCount, setTemplate, setVisibleDirectly, setWidgetAttribute, setWidgetClass, setWidgetListener, setWidgetOverride, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdateWidgetListener, smartUpdateWidgetOverride, toString, updateByClient, updateSubBindingAnnotationCount, willPassivate, willPassivate, willSerialize, willSerialize
public Treeitem()
public Treeitem(java.lang.String label)
public Treeitem(java.lang.String label, java.lang.Object value)
public boolean isCheckable()
isSelectable()
public void setCheckable(boolean checkable)
setSelectable(boolean)
public boolean isSelectable()
Default: true.
public void setSelectable(boolean selectable)
If the listbox is in a checkmark mode, the selectable state will affect the checkable icon to display or not.
Default: true.
selectable
- public void unload()
To load the tree item, with
Tree.renderItem(Treeitem)
, Tree.renderItem(Treeitem, Object)
, or Tree.renderItems(java.util.Set)
public void setDisabled(boolean disabled)
setDisabled
in interface Disable
public boolean isDisabled()
Default: false.
isDisabled
in interface Disable
public boolean isRendered()
isLoaded()
which is used to check whether all children of this tree item are loaded.
Default: false
public boolean isLoaded()
public void setStubonly(java.lang.String stubonly)
setStubonly
in interface Component
setStubonly
in class AbstractComponent
stubonly
- whether it is stub-only. The allowed values include
"true", "false" and "inherit".public void setStubonly(boolean stubonly)
setStubonly
in interface Component
setStubonly
in class AbstractComponent
public int getIndex()
public int indexOf()
getIndex()
.public Treerow getTreerow()
public Treechildren getTreechildren()
public boolean isContainer()
public boolean isEmpty()
public <T> T getValue()
Default: null.
Note: the value is not sent to the browser, so it is OK to be anything.
public <T> void setValue(T value)
value
- the value.
Note: the value is not sent to the browser, so it is OK to be
anything.public boolean isOpen()
Default: true.
public void setOpen(boolean open)
public boolean isSelected()
public void setSelected(boolean selected)
public int getLevel()
public java.lang.String getLabel()
Treecell
it contains, or null
if no such cell.public void setLabel(java.lang.String label)
Treecell
it contains.
If treerow and treecell are not created, we automatically create it.
Notice that this method will create a treerow and treecell automatically if they don't exist. Thus, you cannot attach a treerow to it again if set an image or a label.
public java.lang.String getSrc()
getImage()
.public void setSrc(java.lang.String src)
setImage(java.lang.String)
.public java.lang.String getImage()
Treecell
it contains.public void setImage(java.lang.String image)
Treecell
it contains.
If treerow and treecell are not created, we automatically create it.
Notice that this method will create a treerow and treecell automatically if they don't exist. Thus, you cannot attach a treerow to it again if set an image or a label.
public Treeitem getParentItem()
public Tree getTree()
public boolean setVisible(boolean visible)
Component
setVisible
in interface Component
setVisible
in class AbstractComponent
public int getVisibleItemCount()
Treechildren
.
Descendants include direct children, grand children and so on.public void setWidth(java.lang.String width)
Tree
and Treecol
instead.HtmlBasedComponent
setWidth
in class HtmlBasedComponent
HtmlBasedComponent.setWidthDirectly(java.lang.String)
,
AbstractComponent.disableClientUpdate(boolean)
public void setHflex(java.lang.String flex)
Tree
and Treecol
instead.HtmlBasedComponent
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.
setHflex
in class HtmlBasedComponent
flex
- horizontal flex hint of this component.HtmlBasedComponent.setVflex(java.lang.String)
,
HtmlBasedComponent.getHflex()
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 boolean insertBefore(Component child, Component refChild)
Component
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.
If you would like to monitor if a component is attached or detached
from a page, you could register a desktop listener implementing
UiLifeCycle
.
insertBefore
in interface Component
insertBefore
in class AbstractComponent
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.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)
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)
public java.lang.Object clone()
Component
clone
in interface Component
clone
in class XulElement
protected void renderProperties(ContentRenderer renderer) throws java.io.IOException
HtmlBasedComponent
renderProperties
in class XulElement
java.io.IOException
public void service(AuRequest request, boolean everError)
Default: in addition to what are handled by HtmlBasedComponent.service(org.zkoss.zk.au.AuRequest, boolean)
,
it also handles onOpen.
service
in interface ComponentCtrl
service
in class HtmlBasedComponent
everError
- whether any error ever occurred before
processing this request.AbstractComponent.setAuService(org.zkoss.zk.au.AuService)
Copyright © 2005-2018 Potix Corporation. All Rights Reserved.