Package org.zkoss.zkmax.zul

Class Orgitem

java.lang.Object

org.zkoss.zk.ui.AbstractComponent

org.zkoss.zk.ui.HtmlBasedComponent

org.zkoss.zul.impl.XulElement

org.zkoss.zkmax.zul.Orgitem

All Implemented Interfaces:

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

public class Orgitem
extends XulElement
implements Disable

An orgitem.

Event:

1. onOpen is sent when an Orgitem is opened or closed by user.

Since:

8.6.0

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.zkoss.zk.ui.HtmlBasedComponent

HtmlBasedComponent.ExtraCtrl

Nested classes/interfaces inherited from class org.zkoss.zk.ui.AbstractComponent

AbstractComponent.Children, AbstractComponent.ForwardInfo, AbstractComponent.TargetInfo

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

AFTER_CHILD_ADDED, AFTER_CHILD_REMOVED, AFTER_PAGE_ATTACHED, AFTER_PAGE_DETACHED, AFTER_PARENT_CHANGED, CE_BUSY_IGNORE, CE_DUPLICATE_IGNORE, CE_IMPORTANT, CE_NON_DEFERRABLE, CE_REPEAT_IGNORE

Constructor Summary

Constructors

Constructor	Description
Orgitem()
Orgitem(java.lang.String label)
Orgitem(java.lang.String label, java.lang.Object value)

Method Summary

Modifier and Type	Method	Description
void	beforeChildAdded(Component child, Component insertBefore)	Default: does nothing.
void	beforeParentChanged(Component parent)	Default: If parent is null, execute the @Destroy method if any.
java.lang.Object	clone()	Clones the component.
java.lang.String	getImage()	Returns the image of the Orgnode it contains.
int	getIndex()	Return the index of this item.
java.lang.String	getLabel()	Returns the label of the Orgnode it contains, or null if no such node.
int	getLevel()	Returns the level this item is.
Organigram	getOrganigram()	Returns the Organigram owning this item.
Orgchildren	getOrgchildren()	Returns the Orgchildren that this Orgitem owns, or null if doesn't have any child.
Orgnode	getOrgnode()	Returns the Orgnode that this Orgitem owns, or null if doesn't have any child.
Orgitem	getParentItem()	Returns the parent Orgitem, or null if this item is already the top level of the Organigram.
<T> T	getValue()	Returns the value.
int	getVisibleItemCount()	Returns the number of visible descendant Orgchildren.
java.lang.String	getZclass()	Returns the ZK Cascading Style class for this component.
boolean	insertBefore(Component newChild, Component refChild)	Inserts a child before the reference child.
boolean	isContainer()	Returns whether the element is to act as a container which can have child elements.
boolean	isDisabled()	Returns whether it is disabled, Default: false.
boolean	isEmpty()	Returns whether this element contains no child elements.
boolean	isLoaded()	Return true if all children of this Orgitem, if any, is loaded.
boolean	isOpen()	Returns whether this container is open.
boolean	isRendered()	Returns true if this Orgitem 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	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	setDisabled(boolean disabled)	Sets whether it is disabled.
void	setImage(java.lang.String image)	Sets the image of the Orgnode it contains.
void	setLabel(java.lang.String label)	Sets the label of the Orgnode 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)	Sets whether this item is selected.
<T> void	setValue(T value)	Sets the value.
boolean	setVisible(boolean visible)	Sets whether this component is visible.

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

getContext, getCtrlKeys, getPopup, getPropertyAccess, getTooltip, setContext, setContext, setContextAttributes, setCtrlKeys, setPopup, setPopup, setPopupAttributes, setTooltip, setTooltip, setTooltipAttributes

Methods inherited from class org.zkoss.zk.ui.HtmlBasedComponent

addSclass, evalCSSFlex, focus, getAction, getClientAction, getDraggable, getDroppable, getExtraCtrl, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getStyle, getTabindex, getTabindexInteger, getTooltiptext, getTop, getVflex, getWidth, getZindex, getZIndex, removeSclass, removeSclass, setAction, setClass, setClientAction, setDraggable, setDroppable, setFocus, setHeight, setHeight0, setHeightDirectly, setHflex, setHflex0, setHflexDirectly, setLeft, setLeftDirectly, setRenderdefer, setSclass, setStyle, setTabindex, setTabindex, setTooltiptext, setTop, setTopDirectly, setVflex, setVflex0, setVflexDirectly, setWidth, setWidth0, setWidthDirectly, setZclass, setZindex, setZIndex, setZIndexDirectly

Methods inherited from class org.zkoss.zk.ui.AbstractComponent

addAnnotation, addCallback, addClientEvent, addEventHandler, addEventListener, addEventListener, addForward, addForward, addForward, addForward, addMoved, addRedrawCallback, addScopeListener, addShadowRoot, addShadowRootBefore, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildRemoved, destroyIndexCacheMap, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableBindingAnnotation, disableClientUpdate, disableHostChanged, enableBindingAnnotation, enableHostChanged, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, 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, getForwards, getId, getIndexCacheMap, getLastChild, getMold, getNextSibling, getPage, getParent, getPreviousSibling, getRedrawCallback, getRoot, getShadowFellowIfAny, getShadowRoots, getShadowVariable, getShadowVariable, getShadowVariable0, getSpaceOwner, getSpecialRendererOutput, getStubonly, getSubBindingAnnotationCount, getTemplate, getTemplateNames, getUuid, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttribute, hasAttributeOrFellow, hasBindingAnnotation, hasFellow, hasFellow, hasSubBindingAnnotation, initIndexCacheMap, invalidate, isChildable, isDisabledHostChanged, isInitialized, isInvalidated, isListenerAvailable, isVisible, onPageAttached, onPageDetached, onParentChanged, onWrongValue, query, queryAll, redraw, redrawChildren, removeAttribute, removeAttribute, removeAttribute, removeCallback, removeChild, removeEventListener, removeForward, removeForward, removeRedrawCallback, removeScopeListener, removeShadowRoot, render, render, render, renderPropertiesOnly, replace, response, response, response, service, sessionDidActivate, sessionWillPassivate, setAttribute, setAttribute, setAttribute, setAuService, setAutag, setClientAttribute, setClientDataAttribute, setDefinition, setDefinition, setId, setMold, setPage, setPageBefore, setStubonly, setStubonly, setSubBindingAnnotationCount, setTemplate, setVisibleDirectly, setWidgetClass, setWidgetListener, setWidgetOverride, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdateWidgetListener, smartUpdateWidgetOverride, toString, updateByClient, updateSubBindingAnnotationCount, willPassivate, willPassivate, willSerialize, willSerialize

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Orgitem

public Orgitem()

Orgitem

public Orgitem(java.lang.String label)

Orgitem

public Orgitem(java.lang.String label,
               java.lang.Object value)

Method Detail

isSelectable

public boolean isSelectable()

Returns whether it is selectable. Default: true.

Returns:

whether it is selectable.

setSelectable

public void setSelectable(boolean selectable)

Sets whether it is selectable. When selectable equals true, user can select this item by clicking it.

Parameters:

selectable - whether it is selectable.

isDisabled

public boolean isDisabled()

Returns whether it is disabled, Default: false.

Specified by:

isDisabled in interface Disable

Returns:

whether it is disabled.

setDisabled

public void setDisabled(boolean disabled)

Sets whether it is disabled. When disabled equals true, user can't select this item.

Specified by:

setDisabled in interface Disable

Parameters:

disabled - whether it is disabled.

isRendered

public boolean isRendered()

Returns true if this Orgitem is rendered. Unlike isLoaded() which is used to check whether all children of this Orgitem are loaded. Default: false

Returns:

whether this Orgitem is rendered

isLoaded

public boolean isLoaded()

Return true if all children of this Orgitem, if any, is loaded. Default: false

Returns:

whether all children of this Orgitem, if any, is loaded.

getIndex

public int getIndex()

Return the index of this item.

Returns:

index of this item

getOrgchildren

public Orgchildren getOrgchildren()

Returns the Orgchildren that this Orgitem owns, or null if doesn't have any child.

Returns:

the Orgchildren

getOrgnode

public Orgnode getOrgnode()

Returns the Orgnode that this Orgitem owns, or null if doesn't have any child.

Since:

10.0.0

isContainer

public boolean isContainer()

Returns whether the element is to act as a container which can have child elements.

Returns:

whether the element is a container

isEmpty

public boolean isEmpty()

Returns whether this element contains no child elements.

Returns:

whether this element contains no child elements

getLevel

public int getLevel()

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

Returns:

the level this item is

getValue

public <T> T getValue()

Returns the value. It could be anything you want. Default: null. Note: the value is not sent to the browser, so it is OK to be anything.

Returns:

the value, It could be anything you want.

setValue

public <T> void setValue(T value)

Sets the value. Note: the value is not sent to the browser, so it is OK to be anything.

Parameters:

value - the value, It could be anything you want.

isOpen

public boolean isOpen()

Returns whether this container is open. Default: true.

Returns:

whether this container is open

setOpen

public void setOpen(boolean open)

Sets whether this container is open.

Parameters:

open - whether this container is open

isSelected

public boolean isSelected()

Returns whether this item is selected. Note: Organigram only accepts one selected item Default: false.

Returns:

whether this item is selected

setSelected

public void setSelected(boolean selected)

Sets whether this item is selected. Note: Organigram only accepts one selected item

Parameters:

selected - whether this item is selected

getLabel

public java.lang.String getLabel()

Returns the label of the Orgnode it contains, or null if no such node.

Returns:

the label of the Orgnode it contains

setLabel

public void setLabel(java.lang.String label)

Sets the label of the Orgnode it contains.

If Orgnode is not created, we automatically create it.

Notice that this method will create an Orgnode automatically if it doesn't exist. Thus, you cannot attach a node to it again if set an image or a label.

Parameters:

label - the label of the Orgnode it contains

getImage

public java.lang.String getImage()

Returns the image of the Orgnode it contains.

Returns:

the image of the Orgnode it contains

setImage

public void setImage(java.lang.String image)

Sets the image of the Orgnode it contains.

If Orgnode is not created, we automatically create it.

Notice that this method will create an Orgnode automatically if it doesn't exist. Thus, you cannot attach a node to it again if set an image or a label.

Parameters:

image - the image of the Orgnode it contains

getOrganigram

public Organigram getOrganigram()

Returns the Organigram owning this item.

Returns:

the Organigram

getParentItem

public Orgitem getParentItem()

Returns the parent Orgitem, or null if this item is already the top level of the Organigram. The parent Orgitem is actually the grandparent if any.

Returns:

the parent Orgitem

setVisible

public boolean setVisible(boolean visible)

Description copied from interface: Component

Sets whether this component is visible. A component is visible by default. Both visible and invisible components are rendered in a browser's DOM. But an invisible component's DOM elements with CSS display:none. Since a DOM element will inherit its parent's CSS rules, a component is visible only if all of its parents are also visible.
To remove a component's DOM elements, use Component.detach().

Specified by:

setVisible in interface Component

Overrides:

setVisible in class AbstractComponent

Returns:

the previous visibility

getVisibleItemCount

public int getVisibleItemCount()

Returns the number of visible descendant Orgchildren. Descendants include direct children, grand children and so on.

Returns:

the number of visible descendant Orgchildren

beforeParentChanged

public void beforeParentChanged(Component parent)

Description copied from class: AbstractComponent

Default: If parent is null, execute the @Destroy method if any.

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 insertBefore)

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

insertBefore - 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)

insertBefore

public boolean insertBefore(Component newChild,
                            Component refChild)

Description copied from interface: Component

Inserts a child before the reference child.

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.

Specified by:

insertBefore in interface Component

Overrides:

insertBefore in class AbstractComponent

Parameters:

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

Returns:

true if newChild is added successfully or moved; false if it already has the specified child and the order doesn't change.

onChildAdded

public void onChildAdded(Component child)

Description copied from class: AbstractComponent

Default: handles special event listeners.

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: handles special event listeners.

Specified by:

onChildRemoved in interface ComponentCtrl

Overrides:

onChildRemoved in class AbstractComponent

See Also:

ComponentCtrl.onChildRemoved(org.zkoss.zk.ui.Component)

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 XulElement

Returns:

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

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 XulElement

Throws:

java.io.IOException

service

public void service(AuRequest request,
                    boolean everError)

Description copied from class: HtmlBasedComponent

Processes an AU request.

Default: it handles onClick, onDoubleClick, onRightClick onMove, onSize, onZIndex.

Specified by:

service in interface ComponentCtrl

Overrides:

service in class HtmlBasedComponent

everError - whether any error ever occurred before processing this request.

See Also:

AbstractComponent.setAuService(org.zkoss.zk.au.AuService)

getZclass

public java.lang.String getZclass()

Description copied from class: HtmlBasedComponent

Returns the ZK Cascading Style class for this component. It usually depends on the implementation of the mold (AbstractComponent.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()