com.haulmont.cuba.gui.components

Interface Button

All Superinterfaces:

ActionOwner, Component, Component.BelongToFrame, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer

All Known Subinterfaces:

LinkButton

public interface Button
extends Component, Component.HasCaption, Component.BelongToFrame, ActionOwner, Component.HasIcon, Component.Focusable, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Button.ClickEvent Event sent when the button is clicked.

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.Component

Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.OptionsStyleProvider, Component.Wrapper

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Fields inherited from interface com.haulmont.cuba.gui.components.Component

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE, UNITS_PERCENTAGE, UNITS_PIXELS

Method Summary

Modifier and Type	Method and Description
Subscription	addClickListener(java.util.function.Consumer<Button.ClickEvent> listener)
KeyCombination	getShortcutCombination()
boolean	isCaptionAsHtml()
boolean	isDisableOnClick()
boolean	isUseResponsePending()
void	setCaptionAsHtml(boolean captionAsHtml) Enable or disable HTML mode for caption.
void	setDisableOnClick(boolean disableOnClick) Determines if a button is automatically disabled when clicked.
void	setShortcut(java.lang.String shortcut) Sets shortcut from string representation.
void	setShortcutCombination(KeyCombination shortcut) Sets shortcut combination.
void	setUseResponsePending(boolean useResponsePending) Determines if button will ignore subsequent clicks on client side when it is waiting for server response.

Methods inherited from interface com.haulmont.cuba.gui.components.Component.BelongToFrame

getFrame, setFrame

Methods inherited from interface com.haulmont.cuba.gui.components.ActionOwner

getAction, setAction

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasIcon

getIcon, setIcon, setIconFromSet

Methods inherited from interface com.haulmont.cuba.gui.components.Component.Focusable

focus, getTabIndex, isFocusable, setFocusable, setTabIndex

Methods inherited from interface com.haulmont.cuba.gui.components.Component

addStyleName, getAlignment, getHeight, getHeightSizeUnit, getHeightUnits, getId, getParent, getStyleName, getWidth, getWidthSizeUnit, getWidthUnits, isEnabled, isEnabledItself, isEnabledRecursive, isResponsive, isVisible, isVisibleItself, isVisibleRecursive, removeStyleName, requestFocus, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasCaption

getCaption, setCaption

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasDescription

getDescription, setDescription

Methods inherited from interface com.haulmont.cuba.gui.components.HasHtmlDescription

isDescriptionAsHtml, setDescriptionAsHtml

Methods inherited from interface com.haulmont.cuba.gui.components.HasHtmlSanitizer

isHtmlSanitizerEnabled, setHtmlSanitizerEnabled

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

setDisableOnClick

void setDisableOnClick(boolean disableOnClick)

Determines if a button is automatically disabled when clicked. If this is set to true the button will be automatically disabled when clicked, typically to prevent (accidental) extra clicks on a button.

Parameters:

disableOnClick - disable on click option.

isDisableOnClick

boolean isDisableOnClick()

Returns:

true if the button is disabled when clicked.

isUseResponsePending

boolean isUseResponsePending()

Returns:

true if button will ignore subsequent clicks on client side when it is waiting for server response

setUseResponsePending

void setUseResponsePending(boolean useResponsePending)

Determines if button will ignore subsequent clicks on client side when it is waiting for server response.

Parameters:

useResponsePending - whether to use response pending

setCaptionAsHtml

void setCaptionAsHtml(boolean captionAsHtml)

Enable or disable HTML mode for caption.

Specified by:

setCaptionAsHtml in interface HasHtmlCaption

Parameters:

captionAsHtml - pass true to enable HTML mode for caption.

See Also:

Component.HasCaption.setCaption(String)

isCaptionAsHtml

boolean isCaptionAsHtml()

Specified by:

isCaptionAsHtml in interface HasHtmlCaption

Returns:

true if caption is inserted to DOM as HTML

getShortcutCombination

KeyCombination getShortcutCombination()

Returns:

action's shortcut

setShortcutCombination

void setShortcutCombination(KeyCombination shortcut)

Sets shortcut combination.

Parameters:

shortcut - key combination

setShortcut

void setShortcut(java.lang.String shortcut)

Sets shortcut from string representation.

Parameters:

shortcut - string of type "Modifiers-Key", e.g. "Alt-N". Case-insensitive.

addClickListener

Subscription addClickListener(java.util.function.Consumer<Button.ClickEvent> listener)