Package org.zkoss.stateless.sul

Interface ICardlayout<I extends IAnyGroup>

All Superinterfaces:

IAnyGroup<ICardlayout<I>>, IChildable<ICardlayout<I>,I>, IComponent<ICardlayout<I>>, IHtmlBasedComponent<ICardlayout<I>>, IXulElement<ICardlayout<I>>

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

Immutable Cardlayout component

A layout allow end user change view like change card.

Author:

katherine

See Also:

Cardlayout

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
default java.lang.String	getOrient()	Returns the orient.
default java.lang.String	getWidgetClass()	Returns the client widget class.
static <I extends IAnyGroup> ICardlayout<I>	of(I... children)	Returns the instance with the given any group children.
static <I extends IAnyGroup> ICardlayout<I>	of(java.lang.Iterable<? extends I> children)	Returns the instance with the given any group children.
static <I extends IAnyGroup> ICardlayout<I>	ofId(java.lang.String id)	Returns the instance with the given id.
static <I extends IAnyGroup> ICardlayout<I>	ofOrient(ICardlayout.Orient orient)	Returns the instance with the given orient.
static <I extends IAnyGroup> ICardlayout<I>	ofSize(java.lang.String width, java.lang.String height)	Returns the instance with the given size, width and height
static <I extends IAnyGroup> ICardlayout<I>	ofVflex(java.lang.String vflex)	Returns the instance with the given vflex.
ICardlayout<I>	withOrient(java.lang.String orient)	Returns a copy of this immutable component with the specified orient.
default ICardlayout<I>	withOrient(ICardlayout.Orient orient)	Returns a copy of this immutable component with the specified orient.

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 ICardlayout<IAnyGroup> 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.Cardlayout"

Specified by:

getWidgetClass in interface IComponent<I extends IAnyGroup>

getOrient

default java.lang.String getOrient()

Returns the orient.

Default: "horizontal".

withOrient

ICardlayout<I> withOrient(java.lang.String orient)

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

Sets the orient of component

Parameters:

orient - Either "horizontal" or "vertical"

Default: "horizontal".

Returns:

A modified copy of the this object

withOrient

default ICardlayout<I> withOrient(ICardlayout.Orient orient)

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

Sets the orient of component

Parameters:

orient - The orient

Default: "horizontal".

Returns:

A modified copy of the this object

of

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

Returns the instance with the given any group children.

Parameters:

children - The children belong to any group

See Also:

IAnyGroup

ofSize

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

ofVflex

static <I extends IAnyGroup> ICardlayout<I> ofVflex(java.lang.String vflex)

Returns the instance with the given vflex.

Parameters:

vflex - The vertical flex hint.

ofOrient

static <I extends IAnyGroup> ICardlayout<I> ofOrient(ICardlayout.Orient orient)

Returns the instance with the given orient.

Parameters:

orient - The orient of this component.

ofId

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

Returns the instance with the given id.

Parameters:

id - The id to identify this component