Package org.zkoss.stateless.sul

Interface IToolbarbutton

All Superinterfaces:

IAnyGroup<IToolbarbutton>, IButtonBase<IToolbarbutton>, IChildrenOfInputgroup<IToolbarbutton>, IComponent<IToolbarbutton>, IHtmlBasedComponent<IToolbarbutton>, ILabelElement<IToolbarbutton>, ILabelImageElement<IToolbarbutton>, IXulElement<IToolbarbutton>

public interface IToolbarbutton
extends IButtonBase<IToolbarbutton>, IAnyGroup<IToolbarbutton>

Immutable Toolbarbutton component

The behavior of Toolbarbutton is similar to the button except the appearance is different. The button component uses HTML BUTTON tag, while the toolbarbutton component uses HTML DIV tag.

A toolbarbutton could be placed outside a toolbar. However toolbarbuttons change their appearance if they are placed inside a toolbar.

Toolbarbutton supports getHref(). If getHref() is not null, the onClick handler is ignored and this element is degenerated to HTML's A tag.

Support @Action

Name	Action Type
onCheck	ActionData: CheckData Denotes when toolbarbutton is checked , only available in toggle mode.

Author:

katherine

See Also:

Toolbarbutton

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	IToolbarbutton.Builder	Builds instances of type IToolbarbutton.
static class	IToolbarbutton.Mode	Specifies the mode with withMode(Mode).
static class	IToolbarbutton.Updater	Builds an updater of type IToolbarbutton for UiAgent.smartUpdate(Locator, SmartUpdater).

Nested classes/interfaces inherited from interface org.zkoss.stateless.sul.IButtonBase

IButtonBase.Direction, IButtonBase.Orient, IButtonBase.Type

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
default java.lang.String	getMode()	Returns the current mode.
default java.lang.String	getWidgetClass()	Returns the client widget class.
default boolean	isChecked()	Returns whether it is checked.
static IToolbarbutton	of(java.lang.String label)	Returns the instance with the given label.
static IToolbarbutton	of(java.lang.String label, java.lang.String image)	Returns the instance with the given label and image.
static IToolbarbutton	ofDir(IButtonBase.Direction dir)	Returns the instance with the given dir.
static IToolbarbutton	ofId(java.lang.String id)	Returns the instance with the given id.
static IToolbarbutton	ofImage(java.lang.String image)	Returns the instance with the given image.
static IToolbarbutton	ofMode(IToolbarbutton.Mode mode)	Returns the instance with the given mode.
static IToolbarbutton	ofOrient(IButtonBase.Orient orient)	Returns the instance with the given orient.
IToolbarbutton	withAction(ActionHandler arg0)
IToolbarbutton	withActions(java.lang.Iterable<? extends ActionHandler> arg0)
IToolbarbutton	withActions(ActionHandler... arg0)
IToolbarbutton	withAutodisable(java.lang.String arg0)
IToolbarbutton	withChecked(boolean checked)	Returns a copy of this immutable component with the specified checked.
IToolbarbutton	withClientAction(java.lang.String arg0)
IToolbarbutton	withClientAttributes(java.util.Map<java.lang.String,? extends java.lang.String> arg0)
IToolbarbutton	withContext(java.lang.String arg0)
IToolbarbutton	withCtrlKeys(java.lang.String arg0)
IToolbarbutton	withDir(java.lang.String arg0)
IToolbarbutton	withDisabled(boolean arg0)
IToolbarbutton	withDraggable(java.lang.String arg0)
IToolbarbutton	withDroppable(java.lang.String arg0)
IToolbarbutton	withEventListenerMap(org.zkoss.zk.ui.sys.EventListenerMap arg0)
IToolbarbutton	withFocus(boolean arg0)
IToolbarbutton	withHeight(java.lang.String arg0)
IToolbarbutton	withHflex(java.lang.String arg0)
IToolbarbutton	withHoverImage(java.lang.String arg0)
IToolbarbutton	withHref(java.lang.String arg0)
IToolbarbutton	withIconSclass(java.lang.String arg0)
IToolbarbutton	withIconSclasses(java.lang.String... arg0)
IToolbarbutton	withIconTooltip(java.lang.String arg0)
IToolbarbutton	withIconTooltips(java.lang.String... arg0)
IToolbarbutton	withId(java.lang.String arg0)
IToolbarbutton	withImage(java.lang.String arg0)
IToolbarbutton	withLabel(java.lang.String arg0)
IToolbarbutton	withLeft(java.lang.String arg0)
IToolbarbutton	withMode(java.lang.String mode)	Returns a copy of this immutable component with the specified mode.
default IToolbarbutton	withMode(IToolbarbutton.Mode mode)	Returns a copy of this immutable component with the specified mode.
IToolbarbutton	withMold(java.lang.String arg0)
IToolbarbutton	withOrient(java.lang.String arg0)
IToolbarbutton	withPopup(java.lang.String arg0)
IToolbarbutton	withPreloadImage(boolean arg0)
IToolbarbutton	withRenderdefer(int arg0)
IToolbarbutton	withSclass(java.lang.String arg0)
IToolbarbutton	withStyle(java.lang.String arg0)
IToolbarbutton	withTabindex(java.lang.Integer arg0)
IToolbarbutton	withTarget(java.lang.String arg0)
IToolbarbutton	withTooltip(java.lang.String arg0)
IToolbarbutton	withTooltiptext(java.lang.String arg0)
IToolbarbutton	withTop(java.lang.String arg0)
IToolbarbutton	withType(java.lang.String arg0)
IToolbarbutton	withUpload(java.lang.String arg0)
IToolbarbutton	withVflex(java.lang.String arg0)
IToolbarbutton	withVisible(boolean arg0)
IToolbarbutton	withWidgetClass(java.lang.String arg0)
IToolbarbutton	withWidgetListeners(java.util.Map<java.lang.String,? extends java.lang.String> arg0)
IToolbarbutton	withWidgetOverrides(java.util.Map<java.lang.String,? extends java.lang.String> arg0)
IToolbarbutton	withWidth(java.lang.String arg0)
IToolbarbutton	withZclass(java.lang.String arg0)
IToolbarbutton	withZIndex(int arg0)

Methods inherited from interface org.zkoss.stateless.sul.IButtonBase

checkOrient, getAutodisable, getDir, getHref, getOrient, getTarget, getType, getUpload, isDisabled, withAutodisable, withDir, withDir, withDisabled, withHref, withOrient, withOrient, withTarget, withType, withType, withUpload

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.ILabelElement

getLabel, withLabel

Methods inherited from interface org.zkoss.stateless.sul.ILabelImageElement

getHoverImage, getIconSclass, getIconSclasses, getIconTooltip, getIconTooltips, getImage, isPreloadImage, withHoverImage, withIconSclass, withIconSclasses, withIconTooltip, withIconTooltips, withImage, withPreloadImage

Methods inherited from interface org.zkoss.stateless.sul.IXulElement

getContext, getCtrlKeys, getPopup, getTooltip, withContext, withCtrlKeys, withPopup, withTooltip

Field Detail

DEFAULT

static final IToolbarbutton DEFAULT

Constant for default attributes of this immutable component.

Method Detail

getWidgetClass

default java.lang.String getWidgetClass()

Returns the client widget class.

Default: "zul.wgt.Toolbarbutton"

Specified by:

getWidgetClass in interface IComponent<IToolbarbutton>

getMode

default java.lang.String getMode()

Returns the current mode.

Default: "default"

withMode

IToolbarbutton withMode(java.lang.String mode)

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

Sets the mode to "default" and "toggle"

Parameters:

mode - The mode of this component.

Default: "default".

Returns:

A modified copy of the this object

withMode

default IToolbarbutton withMode(IToolbarbutton.Mode mode)

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

Sets the mode to "default" and "toggle"

Parameters:

mode - The mode of this component.

Default: "default".

Returns:

A modified copy of the this object

isChecked

default boolean isChecked()

Returns whether it is checked.

Default: false.

withChecked

IToolbarbutton withChecked(boolean checked)

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

Sets whether it is checked.

Parameters:

checked - Whether it is checked.

Default: false.

Returns:

A modified copy of the this object

of

static IToolbarbutton of(java.lang.String label)

Returns the instance with the given label.

Parameters:

label - The label that the component

of

static IToolbarbutton of(java.lang.String label,
                         java.lang.String image)

Returns the instance with the given label and image.

Parameters:

label - The label that the button holds.

image - The image that the button holds.

ofImage

static IToolbarbutton ofImage(java.lang.String image)

Returns the instance with the given image.

Parameters:

image - The image that the button holds.

ofMode

static IToolbarbutton ofMode(IToolbarbutton.Mode mode)

Returns the instance with the given mode.

Parameters:

mode - The button mode

ofOrient

static IToolbarbutton ofOrient(IButtonBase.Orient orient)

Returns the instance with the given orient.

Parameters:

orient - The button orient

ofDir

static IToolbarbutton ofDir(IButtonBase.Direction dir)

Returns the instance with the given dir.

Parameters:

dir - The button dir

ofId

static IToolbarbutton ofId(java.lang.String id)

Returns the instance with the given id.

Parameters:

id - The id to identify this component

withId

IToolbarbutton withId(java.lang.String arg0)

withAction

IToolbarbutton withAction(@Nullable
                          ActionHandler arg0)

withActions

IToolbarbutton withActions(ActionHandler... arg0)

withActions

IToolbarbutton withActions(java.lang.Iterable<? extends ActionHandler> arg0)

withVisible

IToolbarbutton withVisible(boolean arg0)

withMold

IToolbarbutton withMold(java.lang.String arg0)

withEventListenerMap

IToolbarbutton withEventListenerMap(@Nullable
                                    org.zkoss.zk.ui.sys.EventListenerMap arg0)

withWidgetListeners

IToolbarbutton withWidgetListeners(java.util.Map<java.lang.String,? extends java.lang.String> arg0)

withWidgetOverrides

IToolbarbutton withWidgetOverrides(java.util.Map<java.lang.String,? extends java.lang.String> arg0)

withClientAttributes

IToolbarbutton withClientAttributes(java.util.Map<java.lang.String,? extends java.lang.String> arg0)

withLeft

IToolbarbutton withLeft(@Nullable
                        java.lang.String arg0)

withTop

IToolbarbutton withTop(@Nullable
                       java.lang.String arg0)

withZIndex

IToolbarbutton withZIndex(int arg0)

withHeight

IToolbarbutton withHeight(@Nullable
                          java.lang.String arg0)

withWidth

IToolbarbutton withWidth(@Nullable
                         java.lang.String arg0)

withTooltiptext

IToolbarbutton withTooltiptext(@Nullable
                               java.lang.String arg0)

withZclass

IToolbarbutton withZclass(@Nullable
                          java.lang.String arg0)

withSclass

IToolbarbutton withSclass(@Nullable
                          java.lang.String arg0)

withStyle

IToolbarbutton withStyle(@Nullable
                         java.lang.String arg0)

withDraggable

IToolbarbutton withDraggable(java.lang.String arg0)

withFocus

IToolbarbutton withFocus(boolean arg0)

withDroppable

IToolbarbutton withDroppable(java.lang.String arg0)

withVflex

IToolbarbutton withVflex(@Nullable
                         java.lang.String arg0)

withHflex

IToolbarbutton withHflex(@Nullable
                         java.lang.String arg0)

withRenderdefer

IToolbarbutton withRenderdefer(int arg0)

withClientAction

IToolbarbutton withClientAction(@Nullable
                                java.lang.String arg0)

withTabindex

IToolbarbutton withTabindex(@Nullable
                            java.lang.Integer arg0)

withCtrlKeys

IToolbarbutton withCtrlKeys(@Nullable
                            java.lang.String arg0)

withContext

IToolbarbutton withContext(@Nullable
                           java.lang.String arg0)

withPopup

IToolbarbutton withPopup(@Nullable
                         java.lang.String arg0)

withTooltip

IToolbarbutton withTooltip(@Nullable
                           java.lang.String arg0)

withLabel

IToolbarbutton withLabel(java.lang.String arg0)

withIconSclass

IToolbarbutton withIconSclass(@Nullable
                              java.lang.String arg0)

withIconSclasses

IToolbarbutton withIconSclasses(java.lang.String... arg0)

withIconTooltip

IToolbarbutton withIconTooltip(@Nullable
                               java.lang.String arg0)

withIconTooltips

IToolbarbutton withIconTooltips(java.lang.String... arg0)

withImage

IToolbarbutton withImage(@Nullable
                         java.lang.String arg0)

withHoverImage

IToolbarbutton withHoverImage(@Nullable
                              java.lang.String arg0)

withPreloadImage

IToolbarbutton withPreloadImage(boolean arg0)

withDir

IToolbarbutton withDir(java.lang.String arg0)

withOrient

IToolbarbutton withOrient(java.lang.String arg0)

withType

IToolbarbutton withType(java.lang.String arg0)

withDisabled

IToolbarbutton withDisabled(boolean arg0)

withAutodisable

IToolbarbutton withAutodisable(@Nullable
                               java.lang.String arg0)

withTarget

IToolbarbutton withTarget(@Nullable
                          java.lang.String arg0)

withUpload

IToolbarbutton withUpload(@Nullable
                          java.lang.String arg0)

withHref

IToolbarbutton withHref(@Nullable
                        java.lang.String arg0)

withWidgetClass

IToolbarbutton withWidgetClass(java.lang.String arg0)