org.zkoss.zul.api
Interface Listgroup

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

public interface Listgroup
extends Listitem

Adds the ability for single level grouping to the Listbox.

Event:

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

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

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
 int getItemCount()
          Returns the number of items.
 java.util.List getItems()
          Returns a list of all Listitem are grouped by this listgroup.
 Listfoot getListfootApi()
          Returns the Listfoot, if any.
 int getListgroupfootIndex()
          Returns the index of Listgroupfoot -1: no Listgroupfoot
 int getVisibleItemCount()
          Returns the number of visible descendant Listitem.
 boolean isOpen()
          Returns whether this container is open.
 void setOpen(boolean open)
          Sets whether this container is open.
 
Methods inherited from interface org.zkoss.zul.api.Listitem
getImage, getLabel, getListboxApi, getListgroupApi, getMaxlength, getValue, isCheckable, isLoaded, isSelected, setCheckable, setDisabled, setImage, setLabel, setSelected, 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 Listitem are grouped by this listgroup.


getItemCount

int getItemCount()
Returns the number of items.


getVisibleItemCount

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


getListgroupfootIndex

int getListgroupfootIndex()
Returns the index of Listgroupfoot

-1: no Listgroupfoot


getListfootApi

Listfoot getListfootApi()
Returns the Listfoot, 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.



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