org.zkoss.zul
Class Group

java.lang.Object
  org.zkoss.zk.ui.AbstractComponent
      org.zkoss.zk.ui.HtmlBasedComponent
          org.zkoss.zul.impl.XulElement
              org.zkoss.zul.Row
                  org.zkoss.zul.Group

All Implemented Interfaces:

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

public class Group
extends Row

Adds the ability for single level grouping to the Grid.

Available in ZK PE and EE.

Event:

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

Default getZclass(): z-group.

Note: All the child of this component are automatically applied the group-cell CSS, if you don't want this CSS, you can invoke the HtmlBasedComponent.setSclass(String) after the child added.

Since:

3.5.0

Author:

jumperchen

See Also:

Serialized Form

Nested Class Summary

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

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

Group()

Group(String label)

Group(String label, T value)

Method Summary

Object	clone()
Group	getGroup() Returns the group that this row belongs to, or null.
Groupfoot	getGroupfoot() Returns the Groupfoot, if any.
int	getGroupfootIndex() Returns the index of Groupfoot -1: no Groupfoot
String	getImgTag() Returns the HTML IMG tag for the image part, or null if no image is assigned.
int	getItemCount() Returns the number of items.
List<Row>	getItems() Returns a list of all Row are grouped by this group.
String	getLabel() Returns the value of the Label it contains, or null if no such cell.
int	getVisibleItemCount() Returns the number of visible descendant Row.
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	setLabel(String label) Sets the value of the Label it contains.
void	setOpen(boolean open) Sets whether this container is open.

Methods inherited from class org.zkoss.zul.Row

beforeChildAdded, beforeParentChanged, getAlign, getDetailChild, getExtraCtrl, getGrid, getIndex, getSclass, getSpans, getValign, getValue, insertBefore, isNowrap, onChildRemoved, setAlign, setHflex, setNowrap, setSpans, setValign, setValue, setVisible, setWidth

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

getContext, getCtrlKeys, getPopup, 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, 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, addMoved, addScopeListener, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildRemoved, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableClientUpdate, equals, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAnnotations, getAttribute, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getAutag, getChildren, getClientEvents, getDefaultMold, getDefinition, getDesktop, getEventHandler, getEventHandlerNames, getEventListenerMap, getEventListeners, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getSpaceOwner, getStubonly, getTemplate, getTemplateNames, getUuid, getWidgetAttribute, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttribute, hasAttributeOrFellow, hasFellow, hasFellow, invalidate, isChildable, isInvalidated, isListenerAvailable, isVisible, onChildAdded, onPageAttached, onPageDetached, onWrongValue, query, queryAll, redraw, redrawChildren, removeAttribute, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, removeScopeListener, render, render, render, replace, response, response, response, service, sessionDidActivate, sessionWillPassivate, setAttribute, setAttribute, setAttribute, setAuService, setAutag, setDefinition, setDefinition, setId, setMold, setPage, setPageBefore, setParent, setStubonly, setStubonly, setTemplate, setVisibleDirectly, setWidgetAttribute, setWidgetClass, setWidgetListener, setWidgetOverride, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdateWidgetListener, smartUpdateWidgetOverride, toString, updateByClient, willPassivate, willPassivate, willSerialize, willSerialize

Methods inherited from class java.lang.Object

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

Constructor Detail

Group

public Group()

Group

public Group(String label)

Group

public Group(String label,
             T value)

Method Detail

getItems

public List<Row> getItems()

Returns a list of all Row are grouped by this group.

getItemCount

public int getItemCount()

Returns the number of items.

getGroup

public Group getGroup()

Description copied from class: Row

Returns the group that this row belongs to, or null.

Overrides:

getGroup in class Row

getVisibleItemCount

public int getVisibleItemCount()

Returns the number of visible descendant Row.

Since:

3.5.1

getGroupfootIndex

public int getGroupfootIndex()

Returns the index of Groupfoot

-1: no Groupfoot

getGroupfoot

public Groupfoot getGroupfoot()

Returns the Groupfoot, 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.

Note: if you use a model as the data to render, don't use setOpen(). It'll tangle the lifecycle with model You should control the model directly. For example, you can use setClose() of GroupsModelArray

getImgTag

public String getImgTag()

Returns the HTML IMG tag for the image part, or null if no image is assigned.

Used only for component template, not for application developers.

getLabel

public String getLabel()

Returns the value of the Label it contains, or null if no such cell.

setLabel

public void setLabel(String label)

Sets the value of the Label it contains.

If it is not created, we automatically create it.

getZclass

public String getZclass()

Overrides:

getZclass in class Row

renderProperties

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

Overrides:

renderProperties in class Row

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

clone

public Object clone()

Specified by:

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

Overrides:

clone in class Row