Package org.zkoss.stateless.sul

Interface ICell<I extends IAnyGroup>

All Superinterfaces:

IChildable<ICell<I>,I>, IComponent<ICell<I>>, IHtmlBasedComponent<ICell<I>>, IXulElement<ICell<I>>

public interface ICell<I extends IAnyGroup>
extends IXulElement<ICell<I>>, IChildable<ICell<I>,I>

Immutable Cell component

The generic cell component to be embedded into IRow

Author:

katherine

See Also:

Cell

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ICell.Builder<I extends IAnyGroup>	Builds instances of type ICell.
static class	ICell.Updater	Builds an updater of type ICell for UiAgent.smartUpdate(Locator, SmartUpdater).

Field Summary

Fields

Modifier and Type	Field	Description
static ICell<IAnyGroup>	DEFAULT	Constant for default attributes of this immutable component.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getAlign()	Returns the horizontal alignment.
default int	getColspan()	Returns number of columns to span.
default int	getRowspan()	Returns number of rows to span.
java.lang.String	getValign()	Returns the vertical alignment.
default java.lang.String	getWidgetClass()	Returns the client widget class.
static <I extends IAnyGroup> ICell<I>	of(I... children)	Returns the instance with the given any group children.
static <I extends IAnyGroup> ICell<I>	of(java.lang.Iterable<? extends I> children)	Returns the instance with the given any group children.
static <I extends IAnyGroup> ICell<I>	ofId(java.lang.String id)	Returns the instance with the given id.
ICell<I>	withAlign(java.lang.String align)	Returns a copy of this immutable component with the specified align.
ICell<I>	withColspan(int colspan)	Returns a copy of this immutable component with the specified colspan.
ICell<I>	withRowspan(int rowspan)	Returns a copy of this immutable component with the specified rowspan.
ICell<I>	withValign(java.lang.String valign)	Returns a copy of this immutable component with the specified valign.

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

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

Field Detail

DEFAULT

static final ICell<IAnyGroup> DEFAULT

Constant for default attributes of this immutable component.

Method Detail

getWidgetClass

default java.lang.String getWidgetClass()

Returns the client widget class.

Default: "zul.wgt.Cell"

Specified by:

getWidgetClass in interface IComponent<I extends IAnyGroup>

getAlign

@Nullable
java.lang.String getAlign()

Returns the horizontal alignment.

Default: null (system default: left unless CSS specified).

withAlign

ICell<I> withAlign(@Nullable
                   java.lang.String align)

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

Sets the horizontal alignment. Allowed values: "left", "right, "center", "justify", and "char".

Parameters:

align - the horizontal alignment.

Default: null.

Returns:

A modified copy of the this object

getValign

@Nullable
java.lang.String getValign()

Returns the vertical alignment.

Default: null (system default: top).

withValign

ICell<I> withValign(@Nullable
                    java.lang.String valign)

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

Sets the vertical alignment. Allowed values: "top", "middle, "bottom", and "baseline".

Parameters:

valign - the vertical alignment.

Default: null.

Returns:

A modified copy of the this object

getColspan

default int getColspan()

Returns number of columns to span. Default: 1.

withColspan

ICell<I> withColspan(int colspan)

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

Sets the number of columns to span.

It is the same as the colspan attribute of HTML TD tag.

Parameters:

colspan - The number of columns to span.

Default: 1.

Returns:

A modified copy of the this object

getRowspan

default int getRowspan()

Returns number of rows to span. Default: 1.

withRowspan

ICell<I> withRowspan(int rowspan)

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

Sets the number of rows to span.

It is the same as the rows attribute of HTML TD tag.

Parameters:

rowspan - The number of rows to span.

Default: 1.

Returns:

A modified copy of the this object

of

static <I extends IAnyGroup> ICell<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> ICell<I> of(I... children)

Returns the instance with the given any group children.

Parameters:

children - The children belong to any group

See Also:

IAnyGroup

ofId

static <I extends IAnyGroup> ICell<I> ofId(java.lang.String id)

Returns the instance with the given id.

Parameters:

id - The id to identify this component