org.zkoss.zul

Class Listgroup

java.lang.Object

org.zkoss.zk.ui.AbstractComponent

org.zkoss.zk.ui.HtmlBasedComponent

org.zkoss.zul.impl.XulElement

org.zkoss.zul.Listitem

org.zkoss.zul.Listgroup

All Implemented Interfaces:

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

public class Listgroup
extends Listitem

Adds the ability for single level grouping to the Listbox.

Available in ZK PE and EE.

Event:

1. onOpen is sent when this listgroup is opened or closed by user.

Default getZclass(): z-listgroup (since 5.0.0)

Since:

3.5.0

Author:

jumperchen

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.zkoss.zul.Listitem

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

CE_BUSY_IGNORE, CE_DUPLICATE_IGNORE, CE_IMPORTANT, CE_NON_DEFERRABLE, CE_REPEAT_IGNORE

Constructor Summary

Constructors

Constructor and Description
Listgroup()
Listgroup(String label)
Listgroup(String label, T value)

Method Summary

Methods

Modifier and Type	Method and Description
Object	clone()
int	getItemCount() Returns the number of items.
List<Listitem>	getItems() Returns a list of all Listitem are grouped by this listgroup.
Listfoot	getListfoot() Returns the Listfoot, if any.
Listgroup	getListgroup() Returns the listgroup that this item belongs to, or null.
int	getListgroupfootIndex() Returns the index of Listgroupfoot -1: no Listgroupfoot
int	getVisibleItemCount() Returns the number of visible descendant Listitem.
String	getZclass()
boolean	isOpen() Returns whether this container is open.
protected void	renderProperties(org.zkoss.zk.ui.sys.ContentRenderer renderer)
void	service(org.zkoss.zk.au.AuRequest request, boolean everError) Processes an AU request.
void	setOpen(boolean open) Sets whether this container is open.

Methods inherited from class org.zkoss.zul.Listitem

addMoved, beforeChildAdded, beforeParentChanged, getExtraCtrl, getImage, getIndex, getLabel, getListbox, getMaxlength, getMold, getSrc, getValue, isCheckable, isDisabled, isLoaded, isSelectable, isSelected, setCheckable, setDisabled, setHflex, setImage, setIndex, setLabel, setSelectable, setSelected, setSrc, setStubonly, setStubonly, setValue, setVisible, setWidth, smartUpdate, smartUpdate, smartUpdate

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

getContext, getCtrlKeys, getPopup, getPropertyAccess, getTooltip, setContext, setContext, setCtrlKeys, setPopup, setPopup, setTooltip, setTooltip

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

focus, getAction, getDraggable, getDroppable, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getStyle, getTooltiptext, getTop, getVflex, getWidth, getZindex, getZIndex, setAction, setClass, setDraggable, setDroppable, setFocus, setHeight, setHeightDirectly, setHflexDirectly, setLeft, setLeftDirectly, setRenderdefer, setSclass, setStyle, setTooltiptext, setTop, setTopDirectly, setVflex, setWidthDirectly, setZclass, setZindex, setZIndex, setZIndexDirectly

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

addAnnotation, addAnnotation, addClientEvent, addEventHandler, addEventListener, addEventListener, addForward, addForward, addForward, addForward, 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, getChildren, getClientAttribute, getClientDataAttribute, getClientEvents, getDefaultMold, getDefinition, getDesktop, getEventHandler, getEventHandlerNames, getEventListenerMap, getEventListeners, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getNextSibling, getPage, getParent, getPreviousSibling, getRedrawCallback, getRoot, getShadowRoots, getShadowVariable, getShadowVariable0, getSpaceOwner, getSpecialRendererOutput, getStubonly, getSubBindingAnnotationCount, getTemplate, getTemplateNames, getUuid, getWidgetAttribute, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttribute, hasAttributeOrFellow, hasBindingAnnotation, hasFellow, hasFellow, hasSubBindingAnnotation, insertBefore, invalidate, isChildable, isInvalidated, isListenerAvailable, isVisible, onChildAdded, onChildRemoved, onPageAttached, onPageDetached, onWrongValue, query, queryAll, redraw, redrawChildren, removeAttribute, removeAttribute, removeAttribute, 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, setParent, setSubBindingAnnotationCount, setTemplate, setVisibleDirectly, setWidgetAttribute, setWidgetClass, setWidgetListener, setWidgetOverride, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdateWidgetListener, smartUpdateWidgetOverride, toString, updateByClient, updateSubBindingAnnotationCount, willPassivate, willPassivate, willSerialize, willSerialize

Methods inherited from class java.lang.Object

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

Constructor Detail

Listgroup

public Listgroup()

Listgroup

public Listgroup(String label)

Listgroup

public Listgroup(String label,
         T value)

Method Detail

getItems

public List<Listitem> getItems()

Returns a list of all Listitem are grouped by this listgroup.

getItemCount

public int getItemCount()

Returns the number of items.

getListgroup

public Listgroup getListgroup()

Description copied from class: Listitem

Returns the listgroup that this item belongs to, or null.

Overrides:

getListgroup in class Listitem

getVisibleItemCount

public int getVisibleItemCount()

Returns the number of visible descendant Listitem.

Since:

3.5.1

getListgroupfootIndex

public int getListgroupfootIndex()

Returns the index of Listgroupfoot

-1: no Listgroupfoot

getListfoot

public Listfoot getListfoot()

Returns the Listfoot, if any. Otherwise, null is returned.

isOpen

public boolean isOpen()

Returns whether this container is open.

Default: true.

setOpen

public void setOpen(boolean open)

Sets whether this container is open.

getZclass

public String getZclass()

Overrides:

getZclass in class Listitem

clone

public Object clone()

Specified by:

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

Overrides:

clone in class Listitem

renderProperties

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

Overrides:

renderProperties in class Listitem

Throws:

IOException

service

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

Processes an AU request.

Default: in addition to what are handled by HtmlBasedComponent.service(org.zkoss.zk.au.AuRequest, boolean), it also handles onOpen.

Specified by:

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

Overrides:

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

Since:

5.0.0