public class Treecol extends HeaderElement
Default getZclass(): z-treecol (since 5.0.0)
LabelImageElement.ExtraCtrl| Constructor and Description |
|---|
Treecol() |
Treecol(String label) |
Treecol(String label,
String src) |
Treecol(String label,
String src,
String width) |
| Modifier and Type | Method and Description |
|---|---|
void |
beforeParentChanged(org.zkoss.zk.ui.Component parent) |
Object |
clone() |
int |
getColumnIndex()
Returns the column index, starting from 0.
|
int |
getMaxlength()
Returns the maximal length of each item's label.
|
Comparator<?> |
getSortAscending()
Returns the ascending sorter, or null if not available.
|
Comparator<?> |
getSortDescending()
Returns the descending sorter, or null if not available.
|
String |
getSortDirection()
Returns the sort direction.
|
Tree |
getTree()
Returns the tree that it belongs to.
|
String |
getZclass() |
void |
onSort()
It invokes
sort(boolean) to sort list items and maintain
getSortDirection(). |
protected void |
renderProperties(org.zkoss.zk.ui.sys.ContentRenderer renderer) |
void |
setMaxlength(int maxlength)
Sets the maximal length of each item's label.
|
void |
setSort(String type)
Sets the type of the sorter.
|
void |
setSortAscending(Comparator<?> sorter)
Sets the ascending sorter, or null for no sorter for
the ascending order.
|
void |
setSortAscending(String clsnm)
Sets the ascending sorter with the class name, or null for
no sorter for the ascending order.
|
void |
setSortDescending(Comparator<?> sorter)
Sets the descending sorter, or null for no sorter for the
descending order.
|
void |
setSortDescending(String clsnm)
Sets the descending sorter with the class name, or null for
no sorter for the descending order.
|
void |
setSortDirection(String sortDir)
Sets the sort direction.
|
boolean |
sort(boolean ascending)
Sorts the treechildren (
Treeitem) based on getSortAscending()
and getSortDescending(), if getSortDirection() doesn't
matches the ascending argument. |
boolean |
sort(boolean ascending,
boolean force)
|
getAlign, getValign, setAlign, setValigngetExtraCtrl, getHoverImage, getHoverImageContent, getIconSclass, getImage, getImageContent, getPropertyAccess, getSrc, isImageAssigned, setHoverImage, setHoverImageContent, setHoverImageContent, setIconSclass, setImage, setImageContent, setImageContent, setSrcgetLabel, renderCrawlable, setLabelgetContext, getCtrlKeys, getPopup, getTooltip, setContext, setContext, setCtrlKeys, setPopup, setPopup, setTooltip, setTooltipfocus, getAction, getDraggable, getDroppable, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getStyle, getTooltiptext, getTop, getVflex, getWidth, getZindex, getZIndex, service, setAction, setClass, setDraggable, setDroppable, setFocus, setHeight, setHeightDirectly, setHflex, setHflexDirectly, setLeft, setLeftDirectly, setRenderdefer, setSclass, setStyle, setTooltiptext, setTop, setTopDirectly, setVflex, setWidth, setWidthDirectly, setZclass, setZindex, setZIndex, setZIndexDirectlyaddAnnotation, addAnnotation, addClientEvent, addEventHandler, addEventListener, addEventListener, addForward, addForward, addForward, addForward, addMoved, addRedrawCallback, addScopeListener, addShadowRoot, addShadowRootBefore, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildAdded, beforeChildRemoved, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableBindingAnnotation, disableClientUpdate, enableBindingAnnotation, equals, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAnnotations, getAttribute, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getAutag, getChildren, getClientAttribute, getClientDataAttribute, getClientEvents, getDefaultMold, getDefinition, getDesktop, getEventHandler, getEventHandlerNames, getEventListenerMap, getEventListeners, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNextSibling, getPage, getParent, getPreviousSibling, getRedrawCallback, getRoot, getShadowRoots, getShadowVariable, getShadowVariable0, getSpaceOwner, getSpecialRendererOutput, getStubonly, getSubBindingAnnotationCount, getTemplate, getTemplateNames, getUuid, getWidgetAttribute, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttribute, hasAttributeOrFellow, hasBindingAnnotation, hasFellow, hasFellow, hasSubBindingAnnotation, insertBefore, invalidate, isChildable, isInvalidated, isListenerAvailable, isVisible, onChildAdded, onChildRemoved, onPageAttached, onPageDetached, onWrongValue, query, queryAll, redraw, redrawChildren, removeAttribute, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, removeRedrawCallback, removeScopeListener, removeShadowRoot, render, render, render, replace, response, response, response, service, sessionDidActivate, sessionWillPassivate, setAttribute, setAttribute, setAttribute, setAuService, setAutag, setClientAttribute, setClientDataAttribute, setDefinition, setDefinition, setId, setMold, setPage, setPageBefore, setParent, setStubonly, setStubonly, setSubBindingAnnotationCount, setTemplate, setVisible, setVisibleDirectly, setWidgetAttribute, setWidgetClass, setWidgetListener, setWidgetOverride, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdateWidgetListener, smartUpdateWidgetOverride, toString, updateByClient, updateSubBindingAnnotationCount, willPassivate, willPassivate, willSerialize, willSerializepublic Treecol()
public Treecol(String label)
public Tree getTree()
public String getSortDirection()
Default: "natural".
public void setSortDirection(String sortDir) throws org.zkoss.zk.ui.WrongValueException
If you use sort(boolean) to sort treechildren (Treeitem),
the sort direction is maintained automatically.
If you want to sort it in customized way, you have to set the
sort direction manually.
sortDir - one of "ascending", "descending" and "natural"org.zkoss.zk.ui.WrongValueExceptionpublic void setSort(String type) throws ClassNotFoundException, InstantiationException, IllegalAccessException
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.
Note: client sorting cannot work in model case.
If "auto" is specified,
setSortAscending(java.util.Comparator<?>) and/or setSortDescending(java.util.Comparator<?>)
are called with TreeitemComparator, if
getSortDescending() and/or getSortAscending() are null.
If you assigned a comparator to them, it won't be affected.
The auto created comparator is case-insensitive.
If "auto(FIELD_NAME1, FIELD_NAME2, ...)" is specified,
setSortAscending(java.util.Comparator<?>) and/or setSortDescending(java.util.Comparator<?>)
are called with FieldComparator, if
getSortDescending() and/or getSortAscending() are null.
If you assigned a comparator to them, it won't be affected.
The auto created comparator is case-sensitive.
If "auto(LOWER(FIELD_NAME))" or "auto(UPPER(FIELD_NAME))" is specified,
setSortAscending(java.util.Comparator<?>) and/or setSortDescending(java.util.Comparator<?>)
are called with FieldComparator, if
getSortDescending() and/or getSortAscending() are null.
If you assigned a comparator to them, it won't be affected.
The auto created comparator is case-insensitive.
If "auto(number)" is specified,
setSortAscending(java.util.Comparator<?>) and/or setSortDescending(java.util.Comparator<?>)
are called with ArrayComparator. Notice that the data must
be an array and the number-th element must be comparable (Comparable).
If "none" is specified, both setSortAscending(java.util.Comparator<?>) and
setSortDescending(java.util.Comparator<?>) are called with null.
Therefore, no more sorting is available to users for this column.
IllegalAccessExceptionInstantiationExceptionClassNotFoundExceptionpublic Comparator<?> getSortAscending()
public void setSortAscending(Comparator<?> sorter)
sorter - the comparator used to sort the ascending order.public void setSortAscending(String clsnm) throws ClassNotFoundException, InstantiationException, IllegalAccessException
ClassNotFoundExceptionInstantiationExceptionIllegalAccessExceptionpublic Comparator<?> getSortDescending()
public void setSortDescending(Comparator<?> sorter)
sorter - the comparator used to sort the ascending order.public void setSortDescending(String clsnm) throws ClassNotFoundException, InstantiationException, IllegalAccessException
ClassNotFoundExceptionInstantiationExceptionIllegalAccessExceptionpublic int getMaxlength()
Default: 0 (no limit).
public void setMaxlength(int maxlength)
Default: 0 (no limit).
Notice that maxlength will be applied to this header and all listcell of the same column.
public int getColumnIndex()
public boolean sort(boolean ascending)
Treeitem) based on getSortAscending()
and getSortDescending(), if getSortDirection() doesn't
matches the ascending argument.
It checks getSortDirection() to see whether sorting
is required, and update setSortDirection(java.lang.String) after sorted.
For example, if getSortDirection() returns "ascending" and
the ascending argument is false, nothing happens.
To enforce the sorting, you can invoke setSortDirection(java.lang.String)
with "natural" before invoking this method.
Alternatively, you can invoke sort(boolean, boolean) instead.
It sorts the rows by use of Components.sort(java.util.List<? extends org.zkoss.zk.ui.Component>, java.util.Comparator<? super org.zkoss.zk.ui.Component>), if not live
data (i.e., Tree.getModel() is null).
On the other hand, it invokes Sortable.sort(java.util.Comparator<T>, boolean) to sort
the treechildren, if live data (i.e., Tree.getModel() is not null).
In other words, if you use the live data, you have to implement
Sortable to sort the live data explicitly.
ascending - whether to use getSortAscending().
If the corresponding comparator is not set, it returns false
and does nothing.org.zkoss.zk.ui.UiException - if Tree.getModel() is not
null but Sortable is not implemented.public boolean sort(boolean ascending,
boolean force)
ascending - whether to use getSortAscending().
If the corresponding comparator is not set, it returns false
and does nothing.force - whether to enforce the sorting no matter what the sort
direction (getSortDirection()) is.
If false, this method is the same as sort(boolean).public void onSort()
sort(boolean) to sort list items and maintain
getSortDirection().public String getZclass()
getZclass in class org.zkoss.zk.ui.HtmlBasedComponentprotected void renderProperties(org.zkoss.zk.ui.sys.ContentRenderer renderer)
throws IOException
renderProperties in class HeaderElementIOExceptionpublic void beforeParentChanged(org.zkoss.zk.ui.Component parent)
beforeParentChanged in interface org.zkoss.zk.ui.sys.ComponentCtrlbeforeParentChanged in class org.zkoss.zk.ui.AbstractComponentpublic Object clone()
clone in interface org.zkoss.zk.ui.Componentclone in class LabelImageElementCopyright © 2015. All rights reserved.