Package org.zkoss.stateless.sul

Interface IListgroup

All Superinterfaces:

IChildable<IListgroup,IListcell<IAnyGroup>>, IComponent<IListgroup>, IHtmlBasedComponent<IListgroup>, IListboxComposite<IListgroup>, IListgroupChild<IListgroup>, IListitemBase<IListgroup>, IMeshComposite<IListgroup>, IXulElement<IListgroup>

public interface IListgroup
extends IListgroupChild<IListgroup>

Immutable Listgroup component

Adds the ability for single level grouping to the Listbox.

Support @Action

Name	Action Type
onOpen	ActionData: OpenData Denotes user has opened or closed a component. It is useful to implement load-on-demand by listening to the onOpen action, and creating components when the first time the component is opened.

Author:

katherine

See Also:

Listgroup

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	IListgroup.Builder	Builds instances of type IListgroup.
static class	IListgroup.Updater	Builds an updater of type IListgroup for UiAgent.smartUpdate(Locator, SmartUpdater).

Field Summary

Fields

Modifier and Type	Field	Description
static IListgroup	DEFAULT	Constant for default attributes of this immutable component.

Method Summary

Modifier and Type	Method	Description
default java.lang.String	getLabel()	Returns the label of the first IListcell it contains.
default java.lang.String	getWidgetClass()	Returns the client widget class.
default boolean	isOpen()	Returns whether this container is open.
static IListgroup	of(java.lang.Iterable<? extends IListcell<IAnyGroup>> children)	Returns the instance with the given IListcell children.
static IListgroup	of(java.lang.String label)	Returns the instance with the given label.
static IListgroup	of(IListcell<IAnyGroup>... children)	Returns the instance with the given IListcell children.
static IListgroup	ofId(java.lang.String id)	Returns the instance with the given id.
IListgroup	withLabel(java.lang.String label)	Returns a copy of this immutable component with the specified label.
IListgroup	withOpen(boolean open)	Returns a copy of this immutable component with the specified open.

Methods inherited from interface org.zkoss.stateless.sul.IChildable

getChildren, withChildren, withChildren

Methods inherited from interface org.zkoss.stateless.sul.IComponent

getAction, getActions, getClientAttributes, getId, getMold, getWidgetListeners, getWidgetOverrides, isVisible, withAction, withAction, withAction, withAction, withAction, withAction, withAction, withAction, withAction, withAction, withAction, withActions, withActions, withClientAttribute, withClientAttributes, withId, withMold, withVisible, withWidgetClass, withWidgetListener, withWidgetListeners, withWidgetOverride, withWidgetOverrides

Methods inherited from interface org.zkoss.stateless.sul.IHtmlBasedComponent

getClientAction, getDraggable, getDroppable, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getStyle, getTabindex, getTooltiptext, getTop, getVflex, getWidth, getZclass, getZIndex, isFocus, withClientAction, withDraggable, withDroppable, withFocus, withHeight, withHflex, withLeft, withRenderdefer, withSclass, withStyle, withTabindex, withTabindex, withTooltiptext, withTop, withVflex, withWidth, withZclass, withZIndex

Methods inherited from interface org.zkoss.stateless.sul.IListitemBase

checkHflex, checkWidth, getImage, getIndex, isDisabled, isLoaded, isSelectable, isSelected, withDisabled, withImage, withIndex, withLoaded, withSelectable, withSelected

Methods inherited from interface org.zkoss.stateless.sul.IXulElement

getContext, getCtrlKeys, getPopup, getTooltip, withContext, withCtrlKeys, withPopup, withTooltip

Field Detail

DEFAULT

static final IListgroup DEFAULT

Constant for default attributes of this immutable component.

Method Detail

getWidgetClass

default java.lang.String getWidgetClass()

Returns the client widget class.

Default: "zkex.sel.Listgroup"

Specified by:

getWidgetClass in interface IComponent<IListgroup>

getLabel

@Nullable
default java.lang.String getLabel()

Returns the label of the first IListcell it contains.

Default: null

withLabel

IListgroup withLabel(@Nullable
                     java.lang.String label)

Returns a copy of this immutable component with the specified label.

Sets the label of the first IListcell it contains.

If it is not created, we automatically create it.

Parameters:

label - The label of the first IListcell it contains.

Default: null.

Returns:

A modified copy of the this object

isOpen

default boolean isOpen()

Returns whether this container is open.

Default: true.

withOpen

IListgroup withOpen(boolean open)

Returns a copy of this immutable component with the specified open.

Sets whether this container is open.

Parameters:

open - false to hide all sublevel items.

Default: true.

Returns:

A modified copy of the this object

of

static IListgroup of(java.lang.String label)

Returns the instance with the given label.

Parameters:

label - The label that the first cell holds.

of

static IListgroup of(java.lang.Iterable<? extends IListcell<IAnyGroup>> children)

Returns the instance with the given IListcell children.

Parameters:

children - The children for each IListcell

of

static IListgroup of(IListcell<IAnyGroup>... children)

Returns the instance with the given IListcell children.

Parameters:

children - The children for each IListcell

ofId

static IListgroup ofId(java.lang.String id)

Returns the instance with the given id.

Parameters:

id - The id to identify this component