zul.sel

Class Listbox

java.lang.Object

zk.Object

zk.Widget

zul.Widget

zul.mesh.MeshWidget

zul.sel.SelectWidget

zul.sel.Listbox

public class Listbox
extends SelectWidget

A listbox.

Event:

1. onSelect event is sent when user changes the selection.

Default Widget.getZclass(): z-listbox.

To have a list box without stripping, you can specify a non-existent style class to setOddRowSclass(_global_.String).

Field Summary

Fields

Modifier and Type	Field and Description
boolean	groupSelect Whether to allow Listgroup to be selected Default: false

Fields inherited from class zul.sel.SelectWidget

rightSelect

Fields inherited from class zk.Widget

$weave, auDelay, autag, bindLevel, className, desktop, effects_, firstChild, id, insertingBefore_, inServer, lastChild, nChildren, nextSibling, parent, previousSibling, uuid, widgetName

Fields inherited from class zk.Object

$class, $oid

Method Summary

Modifier and Type	Method and Description
ItemIter	getBodyWidgetIterator() Returns the list item iterator.
String	getEmptyMessage() Returns the message to display when there are no items
int	getGroupCount() Returns the number of listgroup
Array	getGroups() Returns a list of all Listgroup.
Listhead	getHeadWidgetClass() Returns the head widget class
String	getOddRowSclass() Returns the style class for the odd rows.
boolean	hasGroup() Returns whether listgroup exists.
boolean	inSelectMold() Returns whether the HTML's select tag is used.
ItemIter	itemIterator() Returns the list item iterator.
Listitem	nextItem(Widget item) Returns the next item.
Listitem	previousItem(Widget item) Returns the previous item.
protected void	redrawEmpty_(Array out) A redraw method for the empty message , if you want to customize the message , you could overwrite this.
void	scrollToIndex(int index, double scrollRatio) Scroll to the specified item by the given index.
void	setEmptyMessage(String msg) Sets the message to display when there are no items
Listbox	setOddRowSclass(String oddRowSclass) Sets the style class for the odd rows.
Listbox	stripe() Stripes the class for each item.

Methods inherited from class zul.sel.SelectWidget

clearSelection, fireOnSelect, fixAnchor_, getName, getSelectedIndex, getSelectedItem, getSelectedItems, indexOfItem, isCheckmark, isMultiple, selectAll, selectItem, setCheckmark, setMultiple, setName, setSelectAll, setSelectedIndex, setSelectedItem, shallIgnoreSelect_

Methods inherited from class zul.mesh.MeshWidget

calcSize, getActivePage, getFocusCell, getHeadWidget, getInnerWidth, getPageCount, getPageSize, getPaginal, getPagingPosition, getRows, getSpan, inPagingMold, isAutopaging, isModel, isSizedByContent, setActivePage, setAutopaging, setInnerWidth, setModel, setPageSize, setPaginal, setPagingPosition, setRows, setSizedByContent, setSpan, syncSize

Methods inherited from class zul.Widget

afterKeyDown_, beforeCtrlKeys_, getContext, getCtrlKeys, getOpenTooltip, getPopup, getTooltip, setContext, setContext, setCtrlKeys, setPopup, setPopup, setTooltip, setTooltip

Methods inherited from class zk.Widget

$, $f, $f, $f, $init, $n, $n, $o, $s, $service, afterAnima_, afterParentChanged_, appendChild, appendChild, beforeParentChanged_, beforeSendAU_, bind_, bind, bindChildren_, bindDoubleTap_, bindMissingAncestors, bindSwipe_, bindTapHold_, canActivate, cleanDrag_, clear, clearCache, cloneDrag_, deferRedraw_, deferRedrawHTML_, detach, doBlur_, doClick_, doDoubleClick_, doFocus_, doKeyDown_, doKeyPress_, doKeyUp_, domAttrs_, domClass_, domListen_, doMouseDown_, doMouseMove_, doMouseOut_, doMouseOver_, doMouseUp_, domStyle_, domTextStyleAttr_, domTooltiptext_, domUnlisten_, doPaste_, doResizeScroll_, doRightClick_, doSelect_, doSwipe_, doTooltipOut_, doTooltipOver_, dropEffect_, extraBind_, fire, fireX, focus_, focus, forcerender, fromPageCoord, get, getAction, getCaveNode, getChildAt, getChildIndex, getClass, getCssflex, getDraggable, getDragMessage_, getDragNode, getDragOptions_, getDrop_, getDroppable, getElementsById, getElementsByName, getFirstNode_, getFloatZIndex_, getHeight, getHflex, getId, getLeft, getMold, getOldWidget_, getPage, getRenderdefer, getSclass, getScrollLeft, getScrollTop, getStyle, getTabindex, getTextNode, getTooltiptext, getTop, getTopWidget, getVflex, getWidth, getZclass, getZIndex, hide, ignoreDescendantFloatUp_, ignoreDrag_, initDrag_, insertBefore, insertChildHTML_, isAutoId, isBinding, isFloating_, isListen, isRealElement, isRealVisible, isRealVisible, isVisible, isVisible, isWatchable_, listen, listenOnFitSize_, mimicMouseDown_, newInstance, nextUuid, onAfterSize, onChildAdded_, onChildRemoved_, onChildRenderDefer_, onChildReplaced_, onChildVisible_, onDrop_, redraw, redrawHTML_, register, removeChild, removeChild, removeChildHTML_, removeHTML_, replaceCavedChildren_, replaceChildHTML_, replaceHTML, replaceWidget, rerender, rerender, rerenderLater_, rerenderNow_, scrollIntoView, sendAU_, set, set, setAction, setChildren, setCssflex, setDomVisible_, setDraggable, setDroppable, setFloating_, setFloatZIndex_, setHeight, setHflex, setId, setLeft, setListener, setListener, setListeners, setMold, setRenderdefer, setSclass, setScrollLeft, setScrollTop, setStyle, setTabindex, setTooltiptext, setTop, setTopmost, setVflex, setVisible, setWidth, setZclass, setZIndex, shallChildROD_, shallFireSizedLaterWhenAddChd_, shallIgnoreClick_, show, smartUpdate, unbind_, unbind, unbindChildren_, unbindDoubleTap_, unbindSwipe_, unbindTapHold_, uncloneDrag_, unlisten, unlistenOnFitSize_, updateDomClass_, updateDomStyle_, uuid, zsync

Methods inherited from class zk.Object

$init, $instanceof, $super, $super, $supers, $supers, afterInit, isAssignableFrom, isInstance, proxy

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

groupSelect

public boolean groupSelect

Whether to allow Listgroup to be selected

Default: false

Since:

5.0.7

Method Detail

setEmptyMessage

public void setEmptyMessage(String msg)

Sets the message to display when there are no items

Parameters:

msg -

Since:

5.0.7

getEmptyMessage

public String getEmptyMessage()

Returns the message to display when there are no items

Returns:

String

Since:

5.0.7

getGroupCount

public int getGroupCount()

Returns the number of listgroup

Returns:

int

getGroups

public Array getGroups()

Returns a list of all Listgroup.

Returns:

Array

hasGroup

public boolean hasGroup()

Returns whether listgroup exists.

Returns:

boolean

nextItem

public Listitem nextItem(Widget item)

Returns the next item.

Parameters:

item -

Returns:

Listitem

previousItem

public Listitem previousItem(Widget item)

Returns the previous item.

Parameters:

item -

Returns:

Listitem

getOddRowSclass

public String getOddRowSclass()

Returns the style class for the odd rows.

Default: Widget.getZclass()-odd.

Returns:

String

setOddRowSclass

public Listbox setOddRowSclass(String oddRowSclass)

Sets the style class for the odd rows. If the style class doesn't exist, the striping effect disappears. You can provide different effects by providing the proper style classes.

Parameters:

oddRowSclass -

Returns:

Listbox

inSelectMold

public boolean inSelectMold()

Returns whether the HTML's select tag is used.

Returns:

boolean

stripe

public Listbox stripe()

Stripes the class for each item.

Returns:

Listbox

redrawEmpty_

protected void redrawEmpty_(Array out)

A redraw method for the empty message , if you want to customize the message , you could overwrite this.

Parameters:

out - A array that contains html structure , it usually come from mold(redraw_).

getHeadWidgetClass

public Listhead getHeadWidgetClass()

Returns the head widget class

Returns:

zul.sel.Listhead

scrollToIndex

public void scrollToIndex(int index,
                          double scrollRatio)

Scroll to the specified item by the given index.

Overrides:

scrollToIndex in class MeshWidget

Parameters:

index - the index of listitem

scrollRatio - the scroll ratio

Since:

8.5.2

itemIterator

public ItemIter itemIterator()

Returns the list item iterator.

Returns:

zul.sel.ItemIter

getBodyWidgetIterator

public ItemIter getBodyWidgetIterator()

Returns the list item iterator.

Returns:

zul.sel.ItemIter

See Also:

itemIterator()