Package org.zkoss.stateless.sul

Interface ITreerow

All Superinterfaces:

IChildable<ITreerow,ITreecell<IAnyGroup>>, IComponent<ITreerow>, IHtmlBasedComponent<ITreerow>, ITreeitemComposite<ITreerow>, IXulElement<ITreerow>

public interface ITreerow
extends IXulElement<ITreerow>, IChildable<ITreerow,ITreecell<IAnyGroup>>, ITreeitemComposite<ITreerow>

Immutable Treerow component

Author:

jumperchen

See Also:

• Treerow

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
default String	getImage()	Returns the image of the first ITreecell it contains, or null if no such treecell.
default String	getLabel()	Returns the label of the first ITreecell it contains, or null if no such treecell.
default String	getWidgetClass()	Returns the client widget class.
static ITreerow	of(Iterable<? extends ITreecell<IAnyGroup>> children)	Returns the instance with the given treecells.
static ITreerow	of(String label)	Returns the instance with a ITreecell holding the given label.
static ITreerow	of(String label, String image)	Returns the instance with a ITreecell holding the given label and image.
static ITreerow	of(ITreecell<IAnyGroup>... children)	Returns the instance with the given treecells.
static ITreerow	ofImage(String image)	Returns the instance with a ITreecell holding the given image.
ITreerow	withImage(String image)	Returns a copy of this immutable component with the specified image.
ITreerow	withLabel(String label)	Returns a copy of this immutable component with the specified label.

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, 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 ITreerow DEFAULT

Constant for default attributes of this immutable component.

Method Details

getWidgetClass

default String getWidgetClass()

Returns the client widget class.

Default: "zul.sel.Treerow"

Specified by:

getWidgetClass in interface IComponent<ITreerow>

getImage

@Nullable
default String getImage()

Returns the image of the first ITreecell it contains, or null if no such treecell.

withImage

ITreerow withImage(@Nullable
 String image)

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

Sets the image of the first ITreecell it contains.

Note: if no any treecell exists, this method creates one automatically.

Parameters:

image - The image of the first ITreecell it contains.

Default: null.

Returns:

A modified copy of the this object

getLabel

@Nullable
default String getLabel()

Returns the label of the first ITreecell it contains, or null if no such treecell.

withLabel

ITreerow withLabel(@Nullable
 String label)

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

Sets the label of the first ITreecell it contains.

Note: if no any treecell exists, this method creates one automatically.

Parameters:

label - The label of the first ITreecell it contains.

Default: null.

Returns:

A modified copy of the this object

of

static ITreerow of(String label)

Returns the instance with a ITreecell holding the given label.

Parameters:

label - The label of the first ITreecell

of

static ITreerow of(String label,
 String image)

Returns the instance with a ITreecell holding the given label and image.

Parameters:

label - The label of the first ITreecell

image - The image of the first ITreecell

of

static ITreerow of(ITreecell<IAnyGroup>... children)

Returns the instance with the given treecells.

Parameters:

children - The tree cells of the component

of

static ITreerow of(Iterable<? extends ITreecell<IAnyGroup>> children)

Returns the instance with the given treecells.

Parameters:

children - The tree cells of the component

ofImage

static ITreerow ofImage(String image)

Returns the instance with a ITreecell holding the given image.

Parameters:

image - The image of the first ITreecell