Package org.zkoss.stateless.sul

Interface IColumns

All Superinterfaces:

IChildable<IColumns,IColumn<IAnyGroup>>, IComponent<IColumns>, IGridComposite<IColumns>, IHeadersElement<IColumns>, IHtmlBasedComponent<IColumns>, IMeshComposite<IColumns>, IXulElement<IColumns>

public interface IColumns
extends IHeadersElement<IColumns>, IChildable<IColumns,IColumn<IAnyGroup>>, IGridComposite<IColumns>

Immutable Columns component

Defines the columns of a grid. Each child of a columns element should be a IColumn element.

Author:

katherine

See Also:

Columns

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	IColumns.Builder	Builds instances of type IColumns.
static class	IColumns.Updater	Builds an updater of type IColumns for UiAgent.smartUpdate(Locator, SmartUpdater).

Field Summary

Fields

Modifier and Type	Field	Description
static IColumns	DEFAULT	Constant for default attributes of this immutable component.

Method Summary

Modifier and Type	Method	Description
default java.lang.String	getHflex()	Return horizontal flex hint of this component.
default java.lang.String	getMenupopup()	Returns the ID of the Menupopup (IMenupopup) that should appear when the user clicks on the element.
default java.lang.String	getWidgetClass()	Returns the client widget class.
default java.lang.String	getWidth()	Returns the width of the component.
default boolean	isColumnsgroup()	Returns whether to enable grouping of columns with the header context menu.
default boolean	isColumnshide()	Returns whether to enable hiding of columns with the header context menu.
static IColumns	of(java.lang.Iterable<? extends IColumn<IAnyGroup>> children)	Returns the instance with the given IColumn children.
static IColumns	of(IColumn<IAnyGroup>... children)	Returns the instance with the given IColumn children.
static IColumns	ofId(java.lang.String id)	Returns the instance with the given id.
default void	renderProperties(ContentRenderer renderer)	Internal use
IColumns	withColumnsgroup(boolean columnsgroup)	Returns a copy of this immutable component with the specified columnsgroup.
IColumns	withColumnshide(boolean columnshide)	Returns a copy of this immutable component with the specified columnshide.
default IColumns	withHflex(java.lang.String hflex)	To control the size of Foot related components, please refer to IGrid and IColumn instead.
IColumns	withMenupopup(java.lang.String menupopup)	Returns a copy of this immutable component with the specified menupopup.
default IColumns	withWidth(java.lang.String width)	To control the size of Foot related components, please refer to IGrid and IColumn instead.

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.IHeadersElement

isSizable, withSizable

Methods inherited from interface org.zkoss.stateless.sul.IHtmlBasedComponent

getClientAction, getDraggable, getDroppable, getHeight, getLeft, getRenderdefer, getSclass, getStyle, getTabindex, getTooltiptext, getTop, getVflex, getZclass, getZIndex, isFocus, withClientAction, withDraggable, withDroppable, withFocus, withHeight, withLeft, withRenderdefer, withSclass, withStyle, withTabindex, withTabindex, withTooltiptext, withTop, withVflex, withZclass, withZIndex

Methods inherited from interface org.zkoss.stateless.sul.IXulElement

getContext, getCtrlKeys, getPopup, getTooltip, withContext, withCtrlKeys, withPopup, withTooltip

Field Detail

DEFAULT

static final IColumns DEFAULT

Constant for default attributes of this immutable component.

Method Detail

getWidgetClass

default java.lang.String getWidgetClass()

Returns the client widget class.

Default: "zul.grid.Columns"

Specified by:

getWidgetClass in interface IComponent<IColumns>

getWidth

@Derived
@Nullable
default java.lang.String getWidth()

Description copied from interface: IHtmlBasedComponent

Returns the width of the component. If not specified, null is assumed.

Default: null

Specified by:

getWidth in interface IHtmlBasedComponent<IColumns>

withWidth

default IColumns withWidth(@Nullable
                           java.lang.String width)

To control the size of Foot related components, please refer to IGrid and IColumn instead.

Specified by:

withWidth in interface IHtmlBasedComponent<IColumns>

Parameters:

width - The width of the component.

Default: null

Returns:

A modified copy of the this object

getHflex

@Derived
@Nullable
default java.lang.String getHflex()

Description copied from interface: IHtmlBasedComponent

Return horizontal flex hint of this component.

Default: null

Specified by:

getHflex in interface IHtmlBasedComponent<IColumns>

withHflex

default IColumns withHflex(@Nullable
                           java.lang.String hflex)

To control the size of Foot related components, please refer to IGrid and IColumn instead.

Specified by:

withHflex in interface IHtmlBasedComponent<IColumns>

Parameters:

hflex - The horizontal flex hint.

Default: null

Returns:

A modified copy of the this object

isColumnshide

default boolean isColumnshide()

Returns whether to enable hiding of columns with the header context menu.

Default: true.

withColumnshide

IColumns withColumnshide(boolean columnshide)

Returns a copy of this immutable component with the specified columnshide.

Sets whether to enable hiding of columns with the header context menu.

Parameters:

columnshide - Whether to enable hiding of columns with the header context menu.

Default: true.

Returns:

A modified copy of the this object

isColumnsgroup

default boolean isColumnsgroup()

Returns whether to enable grouping of columns with the header context menu.

Default: true.

withColumnsgroup

IColumns withColumnsgroup(boolean columnsgroup)

Returns a copy of this immutable component with the specified columnsgroup.

Sets whether to enable grouping of columns with the header context menu.

Parameters:

columnsgroup - Whether to enable grouping of columns with the header context menu.

Default: true.

Returns:

A modified copy of the this object

getMenupopup

default java.lang.String getMenupopup()

Returns the ID of the Menupopup (IMenupopup) that should appear when the user clicks on the element.

Default: "none" (a default menupopup).

withMenupopup

IColumns withMenupopup(java.lang.String menupopup)

Returns a copy of this immutable component with the specified menupopup.

Sets the ID of the menupopup (IMenupopup) that should appear when the user clicks on the element of each column.

Parameters:

menupopup - The ID of the menupopup (IMenupopup) that should appear when the user clicks on the element of each column.

Default: "none".

Returns:

A modified copy of the this object

of

static IColumns of(java.lang.Iterable<? extends IColumn<IAnyGroup>> children)

Returns the instance with the given IColumn children.

Parameters:

children - The children of IColumn

of

static IColumns of(IColumn<IAnyGroup>... children)

Returns the instance with the given IColumn children.

Parameters:

children - The children of IColumn

ofId

static IColumns ofId(java.lang.String id)

Returns the instance with the given id.

Parameters:

id - The id to identify this component

renderProperties

default void renderProperties(ContentRenderer renderer)
                       throws java.io.IOException

Internal use

Specified by:

renderProperties in interface IComponent<IColumns>

Specified by:

renderProperties in interface IHeadersElement<IColumns>

Specified by:

renderProperties in interface IHtmlBasedComponent<IColumns>

Specified by:

renderProperties in interface IXulElement<IColumns>

Parameters:

renderer -

Throws:

java.io.IOException