Package org.zkoss.stateless.sul

Interface ILabel

All Superinterfaces:

IAnyGroup<ILabel>, IChildrenOfInputgroup<ILabel>, IComponent<ILabel>, IHtmlBasedComponent<ILabel>, IXulElement<ILabel>

public interface ILabel
extends IXulElement<ILabel>, IAnyGroup<ILabel>, IChildrenOfInputgroup<ILabel>

Immutable Label component

A label component represents a piece of text.

Author:

jumperchen

See Also:

• Label

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
default int	getMaxlength()	Returns the maximal length of the label.
default String	getValue()	Returns the value.
default String	getWidgetClass()	Returns the client widget class.
default boolean	isMultiline()	Returns whether to preserve the new line and the white spaces at the beginning of each line.
default boolean	isPre()	Returns whether to preserve the white spaces, such as space, tab and new line.
static ILabel	of(String value)	Returns the instance with the given value.
static ILabel	ofId(String id)	Returns the instance with the given id.
ILabel	withMaxlength(int maxlength)	Returns a copy of this immutable component with the specified maxlength.
ILabel	withMultiline(boolean multiline)	Returns a copy of this immutable component with the specified multiline.
ILabel	withPre(boolean pre)	Returns a copy of this immutable component with the specified pre.
ILabel	withValue(String value)	Returns a copy of this immutable component with the specified value.

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, getSkeleton, getStyle, getTabindex, getTooltiptext, getTop, getVflex, getWidth, getZclass, getZIndex, isFocus, withClientAction, withDraggable, withDroppable, withFocus, withHeight, withHflex, withLeft, withRenderdefer, withSclass, withSkeleton, 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 Details

DEFAULT

static final ILabel DEFAULT

Constant for default attributes of this immutable component.

Method Details

getWidgetClass

default String getWidgetClass()

Returns the client widget class.

Default: "zul.wgt.Label"

Specified by:

getWidgetClass in interface IComponent<ILabel>

getValue

default String getValue()

Returns the value.

Default: "".

withValue

ILabel withValue(String value)

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

Sets the value of the component

Parameters:

value - The value of the component

Default: "".

Returns:

A modified copy of the this object

getMaxlength

default int getMaxlength()

Returns the maximal length of the label.

Default: 0 (means no limitation)

withMaxlength

ILabel withMaxlength(int maxlength)

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

Sets the maximal length of the label.

Parameters:

maxlength - The maximal length of the label.

Default: 0.

Returns:

A modified copy of the this object

isMultiline

default boolean isMultiline()

Returns whether to preserve the new line and the white spaces at the beginning of each line.

Default: false

withMultiline

ILabel withMultiline(boolean multiline)

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

Sets whether to preserve the new line and the white spaces at the beginning of each line.

Parameters:

multiline - Whether to preserve the new line and the white spaces at the beginning of each line.

Default: false.

Returns:

A modified copy of the this object

isPre

default boolean isPre()

Returns whether to preserve the white spaces, such as space, tab and new line.

It is the same as style="white-space:pre".

Note: the new line is preserved either isPre() or isMultiline() returns true.

withPre

ILabel withPre(boolean pre)

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

Sets whether to preserve the white spaces, such as space, tab and new line.

Parameters:

pre - Whether to preserve the white spaces, such as space, tab and new line.

Default: false.

Returns:

A modified copy of the this object

of

static ILabel of(String value)

Returns the instance with the given value.

Parameters:

value - The value of the component.

ofId

static ILabel ofId(String id)

Returns the instance with the given id.

Parameters:

id - The id to identify this component