Package io.jmix.flowui.kit.component.button

Class JmixButton

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.button.Button

io.jmix.flowui.kit.component.button.JmixButton

All Implemented Interfaces:

com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.BlurNotifier<com.vaadin.flow.component.button.Button>, com.vaadin.flow.component.ClickNotifier<com.vaadin.flow.component.button.Button>, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.Focusable<com.vaadin.flow.component.button.Button>, com.vaadin.flow.component.FocusNotifier<com.vaadin.flow.component.button.Button>, com.vaadin.flow.component.HasAriaLabel, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasEnabled, com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasStyle, com.vaadin.flow.component.HasText, com.vaadin.flow.component.HasTheme, com.vaadin.flow.component.shared.HasPrefix, com.vaadin.flow.component.shared.HasSuffix, com.vaadin.flow.component.shared.HasThemeVariant<com.vaadin.flow.component.button.ButtonVariant>, com.vaadin.flow.component.shared.HasTooltip, HasAction, HasShortcutCombination, HasTitle, Serializable

Direct Known Subclasses:

BreadCrumbsPresenter.NavigationButton

public class JmixButton
extends com.vaadin.flow.component.button.Button
implements HasTitle, HasAction, HasShortcutCombination

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.vaadin.flow.component.BlurNotifier

com.vaadin.flow.component.BlurNotifier.BlurEvent<C extends com.vaadin.flow.component.Component>

Nested classes/interfaces inherited from interface com.vaadin.flow.component.FocusNotifier

com.vaadin.flow.component.FocusNotifier.FocusEvent<C extends com.vaadin.flow.component.Component>

Nested classes/interfaces inherited from interface com.vaadin.flow.component.HasText

com.vaadin.flow.component.HasText.WhiteSpace

Field Summary

Fields

Modifier and Type	Field	Description
protected JmixButtonActionSupport	actionSupport
protected KeyCombination	shortcutCombination
protected com.vaadin.flow.component.ShortcutRegistration	shortcutRegistration

Constructor Summary

Constructors

Constructor	Description
JmixButton()

Method Summary

Modifier and Type	Method	Description
@Nullable Action	getAction()
protected JmixButtonActionSupport	getActionSupport()
@Nullable KeyCombination	getShortcutCombination()
void	setAction(@Nullable Action action, boolean overrideComponentProperties)	Sets the action to the component.
void	setShortcutCombination(@Nullable KeyCombination shortcutCombination)	Sets object that stores information about keys, modifiers and additional settings that describe shortcut combinations.

Methods inherited from class com.vaadin.flow.component.button.Button

addBlurListener, addFocusListener, addFocusShortcut, bindEnabled, bindText, click, clickInClient, getIcon, getText, isAutofocus, isDisableOnClick, isIconAfterText, remove, setAutofocus, setDisableOnClick, setEnabled, setIcon, setIconAfterText, setText

Methods inherited from class com.vaadin.flow.component.Component

addListener, bindVisible, findAncestor, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getListeners, getLocale, getParent, getTestId, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, setId, setTestId, setVisible

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.vaadin.flow.component.AttachNotifier

addAttachListener

Methods inherited from interface com.vaadin.flow.component.ClickNotifier

addClickListener, addClickShortcut, addDoubleClickListener, addSingleClickListener

Methods inherited from interface com.vaadin.flow.component.DetachNotifier

addDetachListener

Methods inherited from interface com.vaadin.flow.component.Focusable

blur, focus, focus, getTabIndex, setTabIndex

Methods inherited from interface io.jmix.flowui.kit.component.HasAction

setAction

Methods inherited from interface com.vaadin.flow.component.HasAriaLabel

getAriaLabel, getAriaLabelledBy, setAriaLabel, setAriaLabelledBy

Methods inherited from interface com.vaadin.flow.component.HasElement

getElement

Methods inherited from interface com.vaadin.flow.component.HasEnabled

isEnabled

Methods inherited from interface com.vaadin.flow.component.shared.HasPrefix

getPrefixComponent, setPrefixComponent

Methods inherited from interface com.vaadin.flow.component.HasSize

bindHeight, bindWidth, getHeight, getHeightUnit, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getWidth, getWidthUnit, setHeight, setHeight, setHeightFull, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull

Methods inherited from interface com.vaadin.flow.component.HasStyle

addClassName, addClassNames, bindClassName, bindClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

Methods inherited from interface com.vaadin.flow.component.shared.HasSuffix

getSuffixComponent, setSuffixComponent

Methods inherited from interface com.vaadin.flow.component.HasText

getWhiteSpace, setWhiteSpace

Methods inherited from interface com.vaadin.flow.component.HasTheme

addThemeName, addThemeNames, bindThemeName, bindThemeNames, getThemeName, getThemeNames, hasThemeName, removeThemeName, removeThemeNames, setThemeName, setThemeName

Methods inherited from interface com.vaadin.flow.component.shared.HasThemeVariant

addThemeVariants, bindThemeVariant, removeThemeVariants, setThemeVariant, setThemeVariants, setThemeVariants

Methods inherited from interface io.jmix.flowui.kit.component.HasTitle

getTitle, setTitle

Methods inherited from interface com.vaadin.flow.component.shared.HasTooltip

getTooltip, setTooltipMarkdown, setTooltipText

Field Details

actionSupport

protected JmixButtonActionSupport actionSupport

shortcutRegistration

protected com.vaadin.flow.component.ShortcutRegistration shortcutRegistration

shortcutCombination

protected KeyCombination shortcutCombination

Constructor Details

JmixButton

public JmixButton()

Method Details

setAction

public void setAction(@Nullable Action action,
 boolean overrideComponentProperties)

Description copied from interface: HasAction

Sets the action to the component. If overrideComponentProperties is true then the action properties will override component's properties, otherwise the component's properties will be overridden if they are null.

List of properties that the action and the component have and which can be overridden:

• text
• description
• shortcutCombination
• enabled
• visible
• icon
• variant

Specified by:

setAction in interface HasAction

Parameters:

action - an action to set

overrideComponentProperties - whether action properties override component properties

getAction

public @Nullable Action getAction()

Specified by:

getAction in interface HasAction

Returns:

an action or null

getActionSupport

protected JmixButtonActionSupport getActionSupport()

getShortcutCombination

public @Nullable KeyCombination getShortcutCombination()

Specified by:

getShortcutCombination in interface HasShortcutCombination

Returns:

object that stores information about keys, modifiers and additional settings that describe shortcut combinations or null if not set

setShortcutCombination

public void setShortcutCombination(@Nullable KeyCombination shortcutCombination)

Description copied from interface: HasShortcutCombination

Sets object that stores information about keys, modifiers and additional settings that describe shortcut combinations.

Specified by:

setShortcutCombination in interface HasShortcutCombination

Parameters:

shortcutCombination - key combination to set or null to remove