Package org.zkoss.stateless.sul

Interface IToolbar<I extends IAnyGroup>

All Superinterfaces:

IAnyGroup<IToolbar<I>>, IChildable<IToolbar<I>,I>, IChildrenOfPanel<IToolbar<I>>, IComponent<IToolbar<I>>, IHtmlBasedComponent<IToolbar<I>>, ITabboxComposite<IToolbar<I>>, IXulElement<IToolbar<I>>

public interface IToolbar<I extends IAnyGroup>
extends IXulElement<IToolbar<I>>, IChildable<IToolbar<I>,I>, IChildrenOfPanel<IToolbar<I>>, IAnyGroup<IToolbar<I>>, ITabboxComposite<IToolbar<I>>

Immutable Toolbar component

A toolbar is used to place a series of buttons, such as toolbarbutton or button. The toolbar buttons could be used without toolbars, so a toolbar could be used without tool buttons. However, the tool buttons change their appearance if they are placed inside a toolbar.

The toolbar has two orientation: horizontal and vertical. It controls how the buttons are placed.

Support Molds

Name	Snapshot
"default"
"panel"

Author:

katherine

See Also:

• Toolbar

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final IToolbar<IAnyGroup>	DEFAULT	Constant for default attributes of this immutable component.
static final IToolbar<IAnyGroup>	PANEL	Constant for pnael mold attributes of this immutable component.

Method Summary

Modifier and Type	Method	Description
default String	getAlign()	Returns the alignment of any children added to this toolbar.
default String	getOrient()	Returns the orient.
default String	getOverflowPopupIconSclass()	Returns the overflow sclass name of overflow popup icon of this toolbar.
default String	getWidgetClass()	Returns the client widget class.
default boolean	isOverflowPopup()	Return whether toolbar has a button that shows a popup which contains those content weren't able to fit in the toolbar.
static <I extends IAnyGroup> IToolbar<I>	of(I... children)	Returns the instance with the given any group children.
static <I extends IAnyGroup> IToolbar<I>	of(Iterable<? extends I> children)	Returns the instance with the given any group children.
static <I extends IAnyGroup> IToolbar<I>	ofId(String id)	Returns the instance with the given id.
IToolbar<I>	withAlign(String align)	Returns a copy of this immutable component with the specified align.
IToolbar<I>	withOrient(String orient)	Returns a copy of this immutable component with the specified orient.
default IToolbar<I>	withOrient(IToolbar.Orient orient)	Returns a copy of this immutable component with the specified orient.
IToolbar<I>	withOverflowPopup(boolean overflowPopup)	Returns a copy of this immutable component with the specified overflowPopup.
IToolbar<I>	withOverflowPopupIconSclass(String overflowPopupIconSclass)	Returns a copy of this immutable component with the specified overflowPopupIconSclass.

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 IToolbar<IAnyGroup> DEFAULT

Constant for default attributes of this immutable component.

PANEL

static final IToolbar<IAnyGroup> PANEL

Constant for pnael mold attributes of this immutable component.

Method Details

getWidgetClass

default String getWidgetClass()

Returns the client widget class.

Default: "zul.wgt.Toolbar"

Specified by:

getWidgetClass in interface IComponent<I extends IAnyGroup>

getOrient

default String getOrient()

Returns the orient.

Default: "horizontal".

withOrient

IToolbar<I> withOrient(String orient)

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

Sets the orient.

Parameters:

orient - Either "horizontal" or "vertical"

Default: "horizontal".

Returns:

A modified copy of the this object

withOrient

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

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

Sets the orient.

Parameters:

orient - Either "horizontal" or "vertical"

Default: "horizontal".

Returns:

A modified copy of the this object

getAlign

default String getAlign()

Returns the alignment of any children added to this toolbar. Valid values are "start", "end" and "center".

Default: "start"

withAlign

IToolbar<I> withAlign(String align)

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

Sets the alignment of any children added to this toolbar.

Parameters:

align - Valid values are "start", "end" and "center"

Default: "start".

Returns:

A modified copy of the this object

isOverflowPopup

default boolean isOverflowPopup()

Return whether toolbar has a button that shows a popup which contains those content weren't able to fit in the toolbar. If overflowPopup is false, toolbar will display multiple rows when content is wider than toolbar.

Default: false.

withOverflowPopup

IToolbar<I> withOverflowPopup(boolean overflowPopup)

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

Sets whether toolbar has a button that shows a popup

Parameters:

overflowPopup - Whether toolbar has a button that shows a popup

Default: false.

Returns:

A modified copy of the this object

getOverflowPopupIconSclass

default String getOverflowPopupIconSclass()

Returns the overflow sclass name of overflow popup icon of this toolbar. Default: "z-icon-ellipsis-h".

withOverflowPopupIconSclass

IToolbar<I> withOverflowPopupIconSclass(String overflowPopupIconSclass)

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

Sets the overflow sclass name of overflow popup icon of this toolbar.

Parameters:

overflowPopupIconSclass - The overflow sclass name of overflow popup icon of this toolbar.

Default: "z-icon-ellipsis-h".

Returns:

A modified copy of the this object

of

static <I extends IAnyGroup> IToolbar<I> of(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> IToolbar<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> IToolbar<I> ofId(String id)

Returns the instance with the given id.

Parameters:

id - The id to identify this component