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:

java.io.Serializable, java.lang.Cloneable, Component, Scope, 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

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(java.lang.String label)

Group(java.lang.String label, T value)

Method Summary

java.lang.Object	clone() Clones the component.
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
java.lang.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.
java.util.List<Row>	getItems() Returns a list of all Row are grouped by this group.
java.lang.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.
java.lang.String	getZclass() Returns the ZK Cascading Style class(es) for this component.
boolean	isOpen() Returns whether this container is open.
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	setLabel(java.lang.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(java.lang.String label)

Group

public Group(java.lang.String label,
             T value)

Method Detail

getItems

public java.util.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 java.lang.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 java.lang.String getLabel()

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

setLabel

public void setLabel(java.lang.String label)

Sets the value of the Label it contains.

If it is not created, we automatically create it.

getZclass

public java.lang.String getZclass()

Description copied from class: HtmlBasedComponent

Returns the ZK Cascading Style class(es) 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 Row

See Also:

HtmlBasedComponent.getSclass()

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 Row

Throws:

java.io.IOException

service

public void service(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 ComponentCtrl

Overrides:

service in class HtmlBasedComponent

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

Since:

5.0.0

See Also:

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

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 Row

Returns:

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