Interface IColumn<I extends IAnyGroup>
-
- All Superinterfaces:
IChildable<IColumn<I>,I>
,IChildrenOfInputgroup<IColumn<I>>
,IComponent<IColumn<I>>
,IHeaderElement<IColumn<I>>
,IHtmlBasedComponent<IColumn<I>>
,ILabelElement<IColumn<I>>
,ILabelImageElement<IColumn<I>>
,IXulElement<IColumn<I>>
public interface IColumn<I extends IAnyGroup> extends IHeaderElement<IColumn<I>>, IChildable<IColumn<I>,I>
ImmutableColumn
componentA single column in a
IColumns
component. Each child of theIColumn
component is placed in each successive cell of the grid. The column with the most child elements determines the number of rows in each column.The use of column is mainly to define attributes for each cell in the grid.
Support @Action
Name Action Type onSort ActionData: SortData
Denotes user has sorted the row of this column.onGroup ActionData: SortData
Denotes user has grouped all the cells under a column. [ZK PE]onUngroup ActionData: SortData
Denotes user has ungrouped all the cells under a column. [ZK EE]- Author:
- katherine
- See Also:
Column
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
IColumn.Builder<I extends IAnyGroup>
Builds instances of typeIColumn
.static class
IColumn.SortDirection
Sets the sort direction.static class
IColumn.Updater
Builds an updater of typeIColumn
forUiAgent.smartUpdate(Locator, SmartUpdater)
.
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description java.util.Comparator<?>
getSortAscending()
Returns the ascending sorter, or null if not available.java.util.Comparator<?>
getSortDescending()
Returns the descending sorter, or null if not available.default java.lang.String
getSortDirection()
Returns the sort direction.default java.lang.String
getWidgetClass()
Returns the client widget class.static <I extends IAnyGroup>
IColumn<I>of(I... children)
Returns the instance with the given any group children.static <I extends IAnyGroup>
IColumn<I>of(java.lang.Iterable<? extends I> children)
Returns the instance with the given any group children.static <I extends IAnyGroup>
IColumn<I>of(java.lang.String label)
Returns the instance with the given label.static <I extends IAnyGroup>
IColumn<I>of(java.lang.String label, java.lang.String image)
Returns the instance with the given label and image.static <I extends IAnyGroup>
IColumn<I>ofId(java.lang.String id)
Returns the instance with the given id.static <I extends IAnyGroup>
IColumn<I>ofImage(java.lang.String image)
Returns the instance with the given image.default IColumn<I>
withSortAscending(java.lang.String sortAscending)
Returns a copy ofthis
immutable component with the specifiedsortAscending
class name.IColumn<I>
withSortAscending(java.util.Comparator<?> sortAscending)
Returns a copy ofthis
immutable component with the specifiedsortAscending
.default IColumn<I>
withSortDescending(java.lang.String sortDescending)
Returns a copy ofthis
immutable component with the specifiedsortDescending
class name.IColumn<I>
withSortDescending(java.util.Comparator<?> sortDescending)
Returns a copy ofthis
immutable component with the specifiedsortDescending
.IColumn<I>
withSortDirection(java.lang.String sortDirection)
Returns a copy ofthis
immutable component with the specifiedsortDirection
.default IColumn<I>
withSortDirection(IColumn.SortDirection sortDirection)
Returns a copy ofthis
immutable component with the specifiedsortDirection
.-
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.IHeaderElement
getAlign, getValign, withAlign, withValign
-
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.ILabelElement
getLabel, withLabel
-
Methods inherited from interface org.zkoss.stateless.sul.ILabelImageElement
getHoverImage, getIconSclass, getIconSclasses, getIconTooltip, getIconTooltips, getImage, isPreloadImage, withHoverImage, withIconSclass, withIconSclasses, withIconTooltip, withIconTooltips, withImage, withPreloadImage
-
Methods inherited from interface org.zkoss.stateless.sul.IXulElement
getContext, getCtrlKeys, getPopup, getTooltip, withContext, withCtrlKeys, withPopup, withTooltip
-
-
-
-
Method Detail
-
getWidgetClass
default java.lang.String getWidgetClass()
Returns the client widget class.Default:
"zul.grid.Column"
- Specified by:
getWidgetClass
in interfaceIComponent<I extends IAnyGroup>
- Returns:
-
getSortDirection
default java.lang.String getSortDirection()
Returns the sort direction.Default: "natural".
-
withSortDirection
IColumn<I> withSortDirection(java.lang.String sortDirection)
Returns a copy ofthis
immutable component with the specifiedsortDirection
.Sets the sort direction. This does not sort the data, it only serves as an indicator as to how the grid is sorted. (unless the grid has
IGrid.isAutosort()
attribute for model case)- Parameters:
sortDirection
- One of"ascending",
"descending"
and"natural"
Default:
"natural"
.- Returns:
- A modified copy of the
this
object
-
withSortDirection
default IColumn<I> withSortDirection(IColumn.SortDirection sortDirection)
Returns a copy ofthis
immutable component with the specifiedsortDirection
.Sets the sort direction. This does not sort the data, it only serves as an indicator as to how the grid is sorted. (unless the grid has
IGrid.isAutosort()
attribute for model case)- Parameters:
sortDirection
- One ofIColumn.SortDirection
Default:
IColumn.SortDirection.NATURAL
.- Returns:
- A modified copy of the
this
object
-
getSortAscending
@Nullable java.util.Comparator<?> getSortAscending()
Returns the ascending sorter, or null if not available.Default:
null
-
withSortAscending
IColumn<I> withSortAscending(@Nullable java.util.Comparator<?> sortAscending)
Returns a copy ofthis
immutable component with the specifiedsortAscending
.Sets the ascending sorter, or null for no sorter for the ascending order.
- Parameters:
sortAscending
- The comparator used to sort the ascending order.Default:
null
.- Returns:
- A modified copy of the
this
object
-
getSortDescending
@Nullable java.util.Comparator<?> getSortDescending()
Returns the descending sorter, or null if not available.Default:
null
-
withSortDescending
IColumn<I> withSortDescending(@Nullable java.util.Comparator<?> sortDescending)
Returns a copy ofthis
immutable component with the specifiedsortDescending
.Sets the descending sorter, or null for no sorter for the descending order.
- Parameters:
sortDescending
- The comparator used to sort the descending order.Default:
null
.- Returns:
- A modified copy of the
this
object
-
withSortAscending
default IColumn<I> withSortAscending(java.lang.String sortAscending) throws java.lang.ClassNotFoundException, java.lang.InstantiationException, java.lang.IllegalAccessException
Returns a copy ofthis
immutable component with the specifiedsortAscending
class name.Sets the ascending sorter with the class name, or null for no sorter for the ascending order.
- Parameters:
sortAscending
- The comparator used to sort the ascending order.Default:
null
.- Returns:
- A modified copy of the
this
object - Throws:
java.lang.ClassNotFoundException
java.lang.InstantiationException
java.lang.IllegalAccessException
-
withSortDescending
default IColumn<I> withSortDescending(java.lang.String sortDescending) throws java.lang.ClassNotFoundException, java.lang.InstantiationException, java.lang.IllegalAccessException
Returns a copy ofthis
immutable component with the specifiedsortDescending
class name.Sets the descending sorter with the class name, or null for no sorter for the descending order.
- Parameters:
sortDescending
- The comparator used to sort the descending order.Default:
null
.- Returns:
- A modified copy of the
this
object - Throws:
java.lang.ClassNotFoundException
java.lang.InstantiationException
java.lang.IllegalAccessException
-
of
static <I extends IAnyGroup> IColumn<I> of(java.lang.String label)
Returns the instance with the given label.- Parameters:
label
- The label belongs to this column.
-
of
static <I extends IAnyGroup> IColumn<I> of(java.lang.String label, java.lang.String image)
Returns the instance with the given label and image.- Parameters:
label
- The label that the column holds.image
- The image that the column holds.
-
ofImage
static <I extends IAnyGroup> IColumn<I> ofImage(java.lang.String image)
Returns the instance with the given image.- Parameters:
image
- The image that the column holds.
-
of
static <I extends IAnyGroup> IColumn<I> of(java.lang.Iterable<? extends I> children)
Returns the instance with the given any group children.- Parameters:
children
- The children belong to any group- See Also:
IAnyGroup
-
of
static <I extends IAnyGroup> IColumn<I> of(I... children)
Returns the instance with the given any group children.- Parameters:
children
- The children belong to any group- See Also:
IAnyGroup
-
-