zul.sel
Class Listheader

java.lang.Object
  zk.Object
      zk.Widget
          zul.Widget
              zul.LabelImageWidget
                  zul.mesh.HeaderWidget
                      zul.mesh.SortWidget
                          zul.sel.Listheader

public class Listheader
extends SortWidget

The list header which defines the attributes and header of a column of a list box. Its parent must be Listhead.

Difference from XUL:

1. There is no listcol in ZUL because it is merged into Listheader. Reason: easier to write Listbox.

Default Widget.getZclass(): z-listheader.

Field Summary

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

Listbox	getListbox() Returns the listbox that this belongs to.
int	getMaxlength() Returns the maximal length of each item's label.
Listbox	getMeshBody() Returns the mesh body that this belongs to.
boolean	group(boolean ascending, Event evt) Groups and sorts the items (Listitem) based on SortWidget.getSortAscending().
void	onGroup() It invokes group(boolean, zk.Event) to group list items and maintain SortWidget.getSortDirection().
void	setMaxlength(int maxlength) Sets the maximal length of each item's label.
protected void	updateCells_() Updates the cells according to the listheader

Methods inherited from class zul.mesh.SortWidget

checkClientSort_, getSortAscending, getSortDescending, getSortDirection, replaceCavedChildrenInOrder_, setSort, setSortAscending, setSortDescending, setSortDirection, sort, sorting

Methods inherited from class zul.mesh.HeaderWidget

getAlign, getMeshWidget, getValign, isSortable_, setAlign, setValign, updateMesh_

Methods inherited from class zul.LabelImageWidget

domContent_, domIcon_, domImage_, domLabel_, getHoverImage, getIconSclass, getImage, getImageNode, getLabel, setHoverImage, setIconSclass, setImage, setLabel, updateDomContent_

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, afterAnima_, afterParentChanged_, appendChild, appendChild, beforeParentChanged_, beforeSendAU_, bind_, bind, bindChildren_, bindDoubleTap_, bindSwipe_, bindTapHold_, canActivate, cleanDrag_, clear, clearCache, cloneDrag_, deferRedraw_, deferRedrawHTML_, detach, doBlur_, doClick_, doDoubleClick_, doFocus_, doKeyDown_, doKeyPress_, doKeyUp_, domAttrs_, domClass_, domListen_, doMouseDown_, doMouseEnter_, doMouseLeave_, doMouseMove_, doMouseOut_, doMouseOver_, doMouseUp_, domStyle_, domTextStyleAttr_, domTooltiptext_, domUnlisten_, doResizeScroll_, doRightClick_, doSelect_, doSwipe_, doTooltipOut_, doTooltipOver_, dropEffect_, extraBind_, fire, fireX, focus_, focus, forcerender, fromPageCoord, get, getAction, getCaveNode, getChildAt, getChildIndex, getClass, getDraggable, getDragMessage_, getDragNode, getDragOptions_, getDrop_, getDroppable, getElementsById, getElementsByName, getFirstNode_, getFloatZIndex_, getHeight, getHflex, getId, getLeft, getMold, getOldWidget_, getPage, getRenderdefer, getSclass, getScrollLeft, getScrollTop, getStyle, 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, scrollIntoView, sendAU_, set, set, setAction, setChildren, setDomVisible_, setDraggable, setDroppable, setFloating_, setFloatZIndex_, setHeight, setHflex, setId, setLeft, setListener, setListener, setListeners, setMold, setRenderdefer, setSclass, setScrollLeft, setScrollTop, setStyle, setTooltiptext, setTop, setTopmost, setVflex, setVisible, setWidth, setZclass, setZIndex, shallChildROD_, 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

Method Detail

setMaxlength

public void setMaxlength(int maxlength)

Sets the maximal length of each item's label.

Parameters:

maxlength -

getMaxlength

public int getMaxlength()

Returns the maximal length of each item's label. Default: 0 (no limit).

Returns:

int

group

public boolean group(boolean ascending,
                     Event evt)

Groups and sorts the items (Listitem) based on SortWidget.getSortAscending(). If the corresponding comparator is not set, it returns false and does nothing.

Parameters:

ascending - whether to use SortWidget.getSortAscending(). If the corresponding comparator is not set, it returns false and does nothing.

evt - the event causes the group

Returns:

boolean whether the items are grouped.

Since:

6.5.0

onGroup

public void onGroup()

It invokes group(boolean, zk.Event) to group list items and maintain SortWidget.getSortDirection().

Since:

6.5.0

updateCells_

protected void updateCells_()

Updates the cells according to the listheader

getListbox

public Listbox getListbox()

Returns the listbox that this belongs to.

Returns:

Listbox

getMeshBody

public Listbox getMeshBody()

Returns the mesh body that this belongs to.

Returns:

Listbox