org.zkoss.zul.api
Interface Group

All Superinterfaces:
java.lang.Cloneable, Component, HtmlBasedComponent, Row, Scope, java.io.Serializable, XulElement
All Known Implementing Classes:
Group

public interface Group
extends Row

Adds the ability for single level grouping to the Grid.

Event:

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

Default HtmlBasedComponent.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.2
Author:
jumperchen

Field Summary
 
Fields inherited from interface org.zkoss.zk.ui.Component
APPLICATION_SCOPE, COMPONENT_SCOPE, DESKTOP_SCOPE, PAGE_SCOPE, REQUEST_SCOPE, SESSION_SCOPE, SPACE_SCOPE
 
Method Summary
 Groupfoot getGroupfootApi()
          Returns the Groupfoot, if any.
 int getGroupfootIndex()
          Returns the index of Groupfoot -1: no Groupfoot
 int getItemCount()
          Returns the number of items.
 java.util.List 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.
 boolean isOpen()
          Returns whether this container is open.
 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 interface org.zkoss.zul.api.Row
getAlign, getDetailChildApi, getGridApi, getGroupApi, getSpans, getValign, getValue, isNowrap, setAlign, setNowrap, setSpans, setValign, setValue
 
Methods inherited from interface org.zkoss.zul.impl.api.XulElement
getAction, getContext, getCtrlKeys, getPopup, getTooltip, setAction, setContext, setContext, setCtrlKeys, setPopup, setPopup, setTooltip, setTooltip
 
Methods inherited from interface org.zkoss.zk.ui.api.HtmlBasedComponent
focus, getHeight, getLeft, getSclass, getStyle, getTooltiptext, getTop, getWidth, getZclass, getZindex, getZIndex, setDraggable, setDroppable, setFocus, setHeight, setLeft, setSclass, setStyle, setTooltiptext, setTop, setWidth, setZclass, setZindex, setZIndex
 
Methods inherited from interface org.zkoss.zk.ui.Component
addEventListener, addForward, addForward, addForward, addForward, appendChild, applyProperties, clone, containsVariable, detach, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getChildren, getDefinition, getDesktop, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNamespace, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getSpaceOwner, getUuid, getVariable, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttributeOrFellow, hasFellow, hasFellow, insertBefore, invalidate, isInvalidated, isListenerAvailable, isVisible, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, setAttribute, setAttribute, setAuService, setId, setMold, setPage, setPageBefore, setParent, setVariable, setVisible, setWidgetListener, setWidgetOverride, unsetVariable
 
Methods inherited from interface org.zkoss.zk.ui.ext.Scope
addScopeListener, getAttribute, hasAttribute, removeAttribute, removeScopeListener, setAttribute
 

Method Detail

getItems

java.util.List getItems()
Returns a list of all Row are grouped by this group.


getItemCount

int getItemCount()
Returns the number of items.


getVisibleItemCount

int getVisibleItemCount()
Returns the number of visible descendant Row.


getGroupfootIndex

int getGroupfootIndex()
Returns the index of Groupfoot

-1: no Groupfoot


getGroupfootApi

Groupfoot getGroupfootApi()
Returns the Groupfoot, if any. Otherwise, null is returned.


isOpen

boolean isOpen()
Returns whether this container is open.

Default: true.


setOpen

void setOpen(boolean open)
Sets whether this container is open.


getLabel

java.lang.String getLabel()
Returns the value of the Label it contains, or null if no such cell.


setLabel

void setLabel(java.lang.String label)
Sets the value of the Label it contains.

If it is not created, we automatically create it.



Copyright © 2005-2009 Potix Corporation. All Rights Reserved. SourceForge.net Logo