zul.mesh

Class SortWidget

java.lang.Object

zk.Object

zk.Widget

zul.Widget

zul.LabelImageWidget

zul.mesh.HeaderWidget

zul.mesh.SortWidget

Direct Known Subclasses:

Column, Listheader, Treecol

public class SortWidget
extends HeaderWidget

A skeletal implementation for a sortable widget.

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

Modifier and Type	Method and Description
protected boolean	checkClientSort_(String ascending) Check the status whether can be sort in client side.
String	getSortAscending() Returns the ascending sorter, or null if not available.
String	getSortDescending() Returns the descending sorter, or null if not available.
String	getSortDirection() Returns the sort direction.
protected void	replaceCavedChildrenInOrder_(String ascending) Replaced the child widgets with the specified order.
void	setSort(String type) Sets the type of the sorter.
void	setSortAscending(String sortAscending) Sets the ascending sorter with "client", "auto", or null for no sorter for the ascending order.
void	setSortDescending(String sortDescending) Sets the descending sorter with "client", "auto", or null for no sorter for the descending order.
void	setSortDirection(String sortDir) Sets the sort direction.
boolean	sort(String ascending, Event evt) Sorts the data.
int	sorting(java.lang.Object o1, java.lang.Object o2, boolean isNumber) The default implementation to compare the data.

Methods inherited from class zul.mesh.HeaderWidget

fixFaker_, 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, $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

Method Detail

setSortDirection

public void setSortDirection(String sortDir)

Sets the sort direction. This does not sort the data, it only serves as an indicator as to how the widget is sorted.

If you use sort(String, jq.Event) to sort rows, the sort direction is maintained automatically. If you want to sort it in customized way, you have to set the sort direction manually.

Parameters:

sortDir - one of "ascending", "descending" and "natural"

getSortDirection

public String getSortDirection()

Returns the sort direction.

Default: "natural".

Returns:

String

setSortAscending

public void setSortAscending(String sortAscending)

Sets the ascending sorter with "client", "auto", or null for no sorter for the ascending order.

Parameters:

sortAscending -

getSortAscending

public String getSortAscending()

Returns the ascending sorter, or null if not available.

Returns:

String

setSortDescending

public void setSortDescending(String sortDescending)

Sets the descending sorter with "client", "auto", or null for no sorter for the descending order.

Parameters:

sortDescending -

getSortDescending

public String getSortDescending()

Returns the descending sorter, or null if not available.

Returns:

String

setSort

public void setSort(String type)

Sets the type of the sorter. You might specify either "auto", "client", or "none".

If "client" or "client(number)" is specified, the sort functionality will be done by Javascript at client without notifying to server, that is, the order of the component in the row is out of sync.

• "client" : it is treated by a string
• "client(number)" : it is treated by a number

Note: client sorting cannot work in model case.

Parameters:

type -

sort

public boolean sort(String ascending,
                    Event evt)

Sorts the data.

Parameters:

ascending -

evt -

Returns:

boolean

checkClientSort_

protected boolean checkClientSort_(String ascending)

Check the status whether can be sort in client side.

Parameters:

ascending -

Returns:

boolean

Since:

5.0.6

See Also:

sort(_global_.String, jq.Event)

replaceCavedChildrenInOrder_

protected void replaceCavedChildrenInOrder_(String ascending)

Replaced the child widgets with the specified order.

Parameters:

ascending -

Since:

5.0.6

See Also:

sort(_global_.String, jq.Event)

sorting

public int sorting(java.lang.Object o1,
                   java.lang.Object o2,
                   boolean isNumber)

The default implementation to compare the data.

Parameters:

o1 - the first object to be compared.

o2 - the second object to be compared.

isNumber -

Returns:

int