Package org.zkoss.stateless.sul

Interface ITreecell<I extends IAnyGroup>

All Superinterfaces:

IChildable<ITreecell<I>,I>, IChildrenOfInputgroup<ITreecell<I>>, IComponent<ITreecell<I>>, IHtmlBasedComponent<ITreecell<I>>, ILabelElement<ITreecell<I>>, ILabelImageElement<ITreecell<I>>, IXulElement<ITreecell<I>>

public interface ITreecell<I extends IAnyGroup>
extends ILabelImageElement<ITreecell<I>>, IChildable<ITreecell<I>,I>

Immutable Treecell component

ITreecell represents one column in a treerow by sequential. Treecell can contain any components in it, such as label, image, textbox etc..

Author:

jumperchen

See Also:

Treecell

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static ITreecell<IAnyGroup>	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 int	getSpan()	Returns number of columns to span this cell.
default java.lang.String	getWidgetClass()	Returns the client widget class.
default java.lang.String	getWidth()	Returns the width of the component.
static <I extends IAnyGroup> ITreecell<I>	of(I... children)	Returns the instance with the given any group children.
static <I extends IAnyGroup> ITreecell<I>	of(java.lang.Iterable<? extends I> children)	Returns the instance with the given any group children.
static <I extends IAnyGroup> ITreecell<I>	of(java.lang.String label)	Returns the instance with the given label.
static <I extends IAnyGroup> ITreecell<I>	of(java.lang.String label, java.lang.String image)	Returns the instance with the given label and image.
static <I extends IAnyGroup> ITreecell<I>	ofId(java.lang.String id)	Returns the instance with the given id.
static <I extends IAnyGroup> ITreecell<I>	ofImage(java.lang.String image)	Returns the instance with the given image.
default ITreecell<I>	withHflex(java.lang.String hflex)	To control the size of Treecell related components, please refer to ITree and ITreecol instead.
ITreecell<I>	withSpan(int span)	Returns a copy of this immutable component with the specified span.
default ITreecell<I>	withWidth(java.lang.String width)	To control the size of Treecell related components, please refer to ITree and ITreecol 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.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.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

Field Detail

DEFAULT

static final ITreecell<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.sel.Treecell"

Specified by:

getWidgetClass in interface IComponent<I extends IAnyGroup>

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<I extends IAnyGroup>

withWidth

default ITreecell<I> withWidth(@Nullable
                               java.lang.String width)

To control the size of Treecell related components, please refer to ITree and ITreecol instead.

Specified by:

withWidth in interface IHtmlBasedComponent<I extends IAnyGroup>

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<I extends IAnyGroup>

withHflex

default ITreecell<I> withHflex(@Nullable
                               java.lang.String hflex)

To control the size of Treecell related components, please refer to ITree and ITreecol instead.

Specified by:

withHflex in interface IHtmlBasedComponent<I extends IAnyGroup>

Parameters:

hflex - The horizontal flex hint.

Default: null

Returns:

A modified copy of the this object

getSpan

default int getSpan()

Returns number of columns to span this cell.

Default: 1.

withSpan

ITreecell<I> withSpan(int span)

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

Sets the number of columns to span this cell. It is the same as the colspan attribute of HTML TD tag.

Parameters:

span - The number of columns to span this cell.

Default: 1.

Returns:

A modified copy of the this object

of

static <I extends IAnyGroup> ITreecell<I> of(java.lang.String label)

Returns the instance with the given label.

Parameters:

label - The label that the cell holds.

of

static <I extends IAnyGroup> ITreecell<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 cell holds.

image - The image that the cell holds.

of

static <I extends IAnyGroup> ITreecell<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> ITreecell<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> ITreecell<I> ofId(java.lang.String id)

Returns the instance with the given id.

Parameters:

id - The id to identify this component

ofImage

static <I extends IAnyGroup> ITreecell<I> ofImage(java.lang.String image)

Returns the instance with the given image.

Parameters:

image - The image that the cell holds.