Package org.zkoss.stateless.sul

Interface IPortalchildren

All Superinterfaces:

IChildable<IPortalchildren,IPanel>, IComponent<IPortalchildren>, IHtmlBasedComponent<IPortalchildren>, IXulElement<IPortalchildren>

public interface IPortalchildren
extends IXulElement<IPortalchildren>, IChildable<IPortalchildren,IPanel>

Immutable Portalchildren component

The column of Portallayout.
Child of Portalchildren can only be Panel.

Author:

katherine

See Also:

Portalchildren

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
java.lang.String	getTitle()	Returns the title of this portalchildren.
default java.lang.String	getWidgetClass()	Returns the client widget class.
default boolean	isCounterVisible()	Returns whether the counter is visible.
static IPortalchildren	of(java.lang.Iterable<? extends IPanel> children)	Returns the instance with the given IPanel children.
static IPortalchildren	of(IPanel... children)	Returns the instance with the given IPanel children.
static IPortalchildren	ofId(java.lang.String id)	Returns the instance with the given id.
static IPortalchildren	ofSize(java.lang.String width, java.lang.String height)	Returns the instance with the given size, width and height.
IPortalchildren	withCounterVisible(boolean counterVisible)	Returns a copy of this immutable component with the specified counterVisible.
IPortalchildren	withTitle(java.lang.String title)	Returns a copy of this immutable component with the specified title.

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 IPortalchildren DEFAULT

Constant for default attributes of this immutable component.

Method Detail

getWidgetClass

default java.lang.String getWidgetClass()

Returns the client widget class.

Default: "zkmax.layout.Portalchildren"

Specified by:

getWidgetClass in interface IComponent<IPortalchildren>

getTitle

@Nullable
java.lang.String getTitle()

Returns the title of this portalchildren. null means no title.

Default: null.

withTitle

IPortalchildren withTitle(@Nullable
                          java.lang.String title)

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

Sets the title of this portalchildren. null means no title.

Parameters:

title - The title of the component.

Default: null.

Returns:

A modified copy of the this object

isCounterVisible

default boolean isCounterVisible()

Returns whether the counter is visible. Meaningful only if getTitle() is not null or not empty.

Default: true.

withCounterVisible

IPortalchildren withCounterVisible(boolean counterVisible)

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

Sets whether the counter is visible. Meaningful only if getTitle() is not null or not empty.

Parameters:

counterVisible - The title of the component.

Default: true.

Returns:

A modified copy of the this object

of

static IPortalchildren of(java.lang.Iterable<? extends IPanel> children)

Returns the instance with the given IPanel children.

Parameters:

children - The children of IPanel

of

static IPortalchildren of(IPanel... children)

Returns the instance with the given IPanel children.

Parameters:

children - The children of IPanel

ofSize

static IPortalchildren ofSize(java.lang.String width,
                              java.lang.String height)

Returns the instance with the given size, width and height.

Parameters:

width - The width of the component

height - The height of the component

ofId

static IPortalchildren ofId(java.lang.String id)

Returns the instance with the given id.

Parameters:

id - The id to identify this component