org.zkoss.zkmax.zul

Class Organigram

java.lang.Object

org.zkoss.zk.ui.AbstractComponent

org.zkoss.zk.ui.HtmlBasedComponent

org.zkoss.zul.impl.XulElement

org.zkoss.zkmax.zul.Organigram

All Implemented Interfaces:

Serializable, Cloneable, org.zkoss.zk.ui.Component, org.zkoss.zk.ui.ext.Scope, org.zkoss.zk.ui.sys.ComponentCtrl

public class Organigram
extends org.zkoss.zul.impl.XulElement

A container which can be used to draw a hierarchical organizational chart, you can specify a TreeModel to render the data.

Event:

1. SelectEvent is sent when user changes the selection.

To retrieve what is selected in Organigram with a TreeSelectableModel, you shall use TreeSelectableModel.isPathSelected(int[]) to check whether the current path is selected in TreeSelectableModel rather than using getSelectedItem(). That is, you shall operate on the item of the TreeSelectableModel rather than on the Orgitem of the Organigram if you use the TreeSelectableModel and TreeModel.

To retrieve what are opened nodes in Organigram with a TreeOpenableModel, you shall use TreeOpenableModel.isPathOpened(int[]) to check whether the current path is opened in TreeOpenableModel rather than using Orgitem.isOpen(). That is, you shall operate on the item of the TreeOpenableModel rather than on the Orgitem of the Organigram if you use the TreeOpenableModel and TreeModel.

Since:

8.6.0

See Also:

Serialized Form

Nested Class Summary

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

org.zkoss.zk.ui.HtmlBasedComponent.ExtraCtrl

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

org.zkoss.zk.ui.AbstractComponent.Children

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, CE_BUSY_IGNORE, CE_DUPLICATE_IGNORE, CE_IMPORTANT, CE_NON_DEFERRABLE, CE_REPEAT_IGNORE

Constructor Summary

Constructors

Constructor and Description
Organigram()

Method Summary

Modifier and Type	Method and Description
void	beforeChildAdded(org.zkoss.zk.ui.Component child, org.zkoss.zk.ui.Component insertBefore)
void	clear() Clears all child Orgitems (Orgitem.
Object	clone()
int	getItemCount() Returns the number of child Orgitem.
<T> OrgitemRenderer<T>	getItemRenderer() Returns the renderer to render each item, or null if the default renderer is used.
Collection<Orgitem>	getItems() Returns a readonly list of all descending Orgitem (children's children and so on).
<T> org.zkoss.zul.TreeModel<T>	getModel() Returns the tree model associated with this Organigram, or null if this Organigram is not associated with any tree data model.
Orgchildren	getOrgchildren() Returns the Orgchildren that this Organigram owns.
Orgitem	getSelectedItem() Returns the selected item.
int	getVisibleItemCount() Returns the number of visible descendant Orgitem.
String	getZclass()
boolean	insertBefore(org.zkoss.zk.ui.Component newChild, org.zkoss.zk.ui.Component refChild)
void	onChildRemoved(org.zkoss.zk.ui.Component child)
void	onInitRender() Handles a private event, onInitRender.
void	onPageAttached(org.zkoss.zk.ui.Page newpage, org.zkoss.zk.ui.Page oldpage)
void	onPageDetached(org.zkoss.zk.ui.Page page)
void	renderItem(Orgitem item) Renders the specified Orgitem, if not loaded yet, with getItemRenderer().
protected void	renderProperties(org.zkoss.zk.ui.sys.ContentRenderer renderer)
void	service(org.zkoss.zk.au.AuRequest request, boolean everError)
void	sessionDidActivate(org.zkoss.zk.ui.Page page)
void	sessionWillPassivate(org.zkoss.zk.ui.Page page)
void	setItemRenderer(OrgitemRenderer<?> renderer) Sets the renderer which is used to render each item if getModel() is not null.
void	setItemRenderer(String clsnm) Sets the renderer by use of a class name.
void	setModel(org.zkoss.zul.TreeModel<?> model) Sets the tree model associated with this Organigram.
void	setSelectedItem(Orgitem selectedItem) Deselects previous selected item and selects the given item.

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, getDraggable, getDroppable, getExtraCtrl, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getStyle, getTabindex, getTabindexInteger, getTooltiptext, getTop, getVflex, getWidth, getZindex, getZIndex, removeSclass, removeSclass, setAction, setClass, 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, addAnnotation, addCallback, addClientEvent, addEventHandler, addEventListener, addEventListener, addForward, addForward, addForward, addForward, addMoved, addRedrawCallback, addScopeListener, addShadowRoot, addShadowRootBefore, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildRemoved, beforeParentChanged, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableBindingAnnotation, disableClientUpdate, enableBindingAnnotation, 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, invalidatePartial, isChildable, isInitialized, isInvalidated, isListenerAvailable, isVisible, onChildAdded, onWrongValue, query, queryAll, redraw, redrawChildren, removeAttribute, removeAttribute, removeAttribute, removeCallback, removeChild, removeEventListener, removeForward, removeForward, removeRedrawCallback, removeScopeListener, removeShadowRoot, render, render, render, replace, response, response, response, service, setAttribute, setAttribute, setAttribute, setAuService, setAutag, setClientAttribute, setClientDataAttribute, setDefinition, setDefinition, setId, setMold, setPage, setPageBefore, setParent, setStubonly, setStubonly, setSubBindingAnnotationCount, setTemplate, setVisible, setVisibleDirectly, setWidgetAttribute, 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

Methods inherited from interface org.zkoss.zk.ui.sys.ComponentCtrl

invalidatePartial

Constructor Detail

Organigram

public Organigram()

Method Detail

getOrgchildren

public Orgchildren getOrgchildren()

Returns the Orgchildren that this Organigram owns.

Returns:

Orgchildren

getItems

public Collection<Orgitem> getItems()

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

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

Returns:

readonly list of all descending Orgitem

getItemCount

public int getItemCount()

Returns the number of child Orgitem. The same as getItems().size().

Note: the performance of this method is no good.

Returns:

the number of child Orgitem.

getVisibleItemCount

public int getVisibleItemCount()

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

Returns:

the number of visible descendant Orgitem.

getSelectedItem

public Orgitem getSelectedItem()

Returns the selected item. Note: Organigram only accepts one selected item.

Returns:

the selected item.

setSelectedItem

public void setSelectedItem(Orgitem selectedItem)

Deselects previous selected item and selects the given item. Note: Organigram only accepts one selected item.

Parameters:

selectedItem - the item will be selected

clear

public void clear()

Clears all child Orgitems (Orgitem.

Note: after clear, getOrgchildren() won't be null, but it has no child.

beforeChildAdded

public void beforeChildAdded(org.zkoss.zk.ui.Component child,
                             org.zkoss.zk.ui.Component insertBefore)

Specified by:

beforeChildAdded in interface org.zkoss.zk.ui.sys.ComponentCtrl

Overrides:

beforeChildAdded in class org.zkoss.zk.ui.AbstractComponent

insertBefore

public boolean insertBefore(org.zkoss.zk.ui.Component newChild,
                            org.zkoss.zk.ui.Component refChild)

Specified by:

insertBefore in interface org.zkoss.zk.ui.Component

Overrides:

insertBefore in class org.zkoss.zk.ui.AbstractComponent

onChildRemoved

public void onChildRemoved(org.zkoss.zk.ui.Component child)

Specified by:

onChildRemoved in interface org.zkoss.zk.ui.sys.ComponentCtrl

Overrides:

onChildRemoved in class org.zkoss.zk.ui.AbstractComponent

onPageAttached

public void onPageAttached(org.zkoss.zk.ui.Page newpage,
                           org.zkoss.zk.ui.Page oldpage)

Specified by:

onPageAttached in interface org.zkoss.zk.ui.sys.ComponentCtrl

Overrides:

onPageAttached in class org.zkoss.zk.ui.AbstractComponent

onPageDetached

public void onPageDetached(org.zkoss.zk.ui.Page page)

Specified by:

onPageDetached in interface org.zkoss.zk.ui.sys.ComponentCtrl

Overrides:

onPageDetached in class org.zkoss.zk.ui.AbstractComponent

clone

public Object clone()

Specified by:

clone in interface org.zkoss.zk.ui.Component

Overrides:

clone in class org.zkoss.zul.impl.XulElement

sessionWillPassivate

public void sessionWillPassivate(org.zkoss.zk.ui.Page page)

Specified by:

sessionWillPassivate in interface org.zkoss.zk.ui.sys.ComponentCtrl

Overrides:

sessionWillPassivate in class org.zkoss.zk.ui.AbstractComponent

sessionDidActivate

public void sessionDidActivate(org.zkoss.zk.ui.Page page)

Specified by:

sessionDidActivate in interface org.zkoss.zk.ui.sys.ComponentCtrl

Overrides:

sessionDidActivate in class org.zkoss.zk.ui.AbstractComponent

getModel

public <T> org.zkoss.zul.TreeModel<T> getModel()

Returns the tree model associated with this Organigram, or null if this Organigram is not associated with any tree data model.

Returns:

the tree model associated with this Organigram

setModel

public void setModel(org.zkoss.zul.TreeModel<?> model)

Sets the tree model associated with this Organigram.

Parameters:

model - the tree model to associate, or null to dissociate any previous model.

Throws:

org.zkoss.zk.ui.UiException - if failed to initialize with the model

onInitRender

public void onInitRender()

Handles a private event, onInitRender. It is used only for implementation, and you rarely need to invoke it explicitly.

getItemRenderer

public <T> OrgitemRenderer<T> getItemRenderer()

Returns the renderer to render each item, or null if the default renderer is used.

setItemRenderer

public void setItemRenderer(OrgitemRenderer<?> renderer)

Sets the renderer which is used to render each item if getModel() is not null.

Note: changing a render will cause the Organigram to re-render.

Parameters:

renderer - the renderer, or null to use the default.

setItemRenderer

public void setItemRenderer(String clsnm)
                     throws ClassNotFoundException,
                            NoSuchMethodException,
                            IllegalAccessException,
                            InstantiationException,
                            InvocationTargetException

Sets the renderer by use of a class name. It creates an instance automatically.

Parameters:

clsnm - the class name of renderer

Throws:

ClassNotFoundException

NoSuchMethodException

IllegalAccessException

InstantiationException

InvocationTargetException

renderItem

public void renderItem(Orgitem item)

Renders the specified Orgitem, if not loaded yet, with getItemRenderer().

It does nothing if getModel() returns null.

Parameters:

item - the item to be rendered

service

public void service(org.zkoss.zk.au.AuRequest request,
                    boolean everError)

Specified by:

service in interface org.zkoss.zk.ui.sys.ComponentCtrl

Overrides:

service in class org.zkoss.zk.ui.HtmlBasedComponent

renderProperties

protected void renderProperties(org.zkoss.zk.ui.sys.ContentRenderer renderer)
                         throws IOException

Overrides:

renderProperties in class org.zkoss.zul.impl.XulElement

Throws:

IOException

getZclass

public String getZclass()

Overrides:

getZclass in class org.zkoss.zk.ui.HtmlBasedComponent