com.vaadin.fluent.api

Interface FluentButton<THIS extends FluentButton<THIS>>

Type Parameters:

THIS - Self-referential generic THIS

All Superinterfaces:

com.vaadin.server.ClientConnector, com.vaadin.ui.Component, com.vaadin.ui.Component.Focusable, com.vaadin.shared.Connector, com.vaadin.event.ContextClickEvent.ContextClickNotifier, com.vaadin.event.FieldEvents.BlurNotifier, com.vaadin.event.FieldEvents.FocusNotifier, FluentAbstractComponent<THIS>, FluentAbstractFocusable<THIS>, FluentClientConnector<THIS>, FluentComponent<THIS>, FluentComponent.FluentFocusable<THIS>, FluentContextClickNotifier<THIS>, FluentFieldEvents.FluentBlurNotifier<THIS>, FluentFieldEvents.FluentFocusNotifier<THIS>, FluentSizeable<THIS>, Serializable, com.vaadin.server.Sizeable

All Known Implementing Classes:

FButton, FNativeButton

public interface FluentButton<THIS extends FluentButton<THIS>>
extends FluentAbstractFocusable<THIS>

The base interface for fluent versions of Button

See Also:

Button

Nested Class Summary

Nested classes/interfaces inherited from interface com.vaadin.fluent.api.FluentComponent

FluentComponent.FluentFocusable<C extends FluentComponent.FluentFocusable<C>>

Nested classes/interfaces inherited from interface com.vaadin.ui.Component

com.vaadin.ui.Component.ErrorEvent, com.vaadin.ui.Component.Event, com.vaadin.ui.Component.Focusable, com.vaadin.ui.Component.Listener

Nested classes/interfaces inherited from interface com.vaadin.server.ClientConnector

com.vaadin.server.ClientConnector.AttachEvent, com.vaadin.server.ClientConnector.AttachListener, com.vaadin.server.ClientConnector.ConnectorErrorEvent, com.vaadin.server.ClientConnector.DetachEvent, com.vaadin.server.ClientConnector.DetachListener

Nested classes/interfaces inherited from interface com.vaadin.server.Sizeable

com.vaadin.server.Sizeable.Unit

Field Summary

Fields inherited from interface com.vaadin.server.Sizeable

SIZE_UNDEFINED, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS

Method Summary

Modifier and Type	Method and Description
default THIS	withClickListener(com.vaadin.ui.Button.ClickListener listener) Adds the button click listener.
default THIS	withClickShortcut(int keyCode, int... modifiers) Makes it possible to invoke a click on this button by pressing the given ShortcutAction.KeyCode and (optional) ShortcutAction.ModifierKeys.
default THIS	withDisableOnClick(boolean disableOnClick) Determines if a button is automatically disabled when clicked.
default THIS	withIconAlternateText(String iconAltText)

Methods inherited from interface com.vaadin.fluent.api.FluentAbstractFocusable

withTabIndex

Methods inherited from interface com.vaadin.fluent.api.FluentAbstractComponent

withCaption, withCaptionAsHtml, withComponentError, withData, withDescription, withDescription, withLocale, withResponsive, withShortcutListener, withStyleName

Methods inherited from interface com.vaadin.fluent.api.FluentClientConnector

withAttachListener, withDetachListener

Methods inherited from interface com.vaadin.fluent.api.FluentContextClickNotifier

withContextClickListener

Methods inherited from interface com.vaadin.event.ContextClickEvent.ContextClickNotifier

addContextClickListener, removeContextClickListener

Methods inherited from interface com.vaadin.ui.Component.Focusable

focus, getTabIndex, setTabIndex

Methods inherited from interface com.vaadin.fluent.api.FluentComponent

withCaption, withEnabled, withIcon, withId, withParent, withPrimaryStyleName, withStyleName, withStyleName, withVisible

Methods inherited from interface com.vaadin.ui.Component

addListener, addStyleName, addStyleNames, attach, getCaption, getDescription, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getUI, isEnabled, isVisible, readDesign, removeListener, removeStyleName, removeStyleNames, setCaption, setEnabled, setIcon, setId, setParent, setPrimaryStyleName, setStyleName, setVisible, writeDesign

Methods inherited from interface com.vaadin.server.ClientConnector

addAttachListener, addDetachListener, beforeClientResponse, detach, encodeState, getErrorHandler, getExtensions, getRpcManager, getStateType, handleConnectorRequest, isAttached, isConnectorEnabled, markAsDirty, markAsDirtyRecursive, removeAttachListener, removeDetachListener, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Methods inherited from interface com.vaadin.fluent.api.FluentSizeable

withFullHeight, withFullSize, withFullWidth, withHeight, withHeight, withSize, withUndefinedHeight, withUndefinedSize, withUndefinedWidth, withWidth, withWidth

Methods inherited from interface com.vaadin.server.Sizeable

getHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setHeight, setHeightUndefined, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthUndefined

Methods inherited from interface com.vaadin.fluent.api.FluentFieldEvents.FluentFocusNotifier

withFocusListener

Methods inherited from interface com.vaadin.event.FieldEvents.FocusNotifier

addFocusListener

Methods inherited from interface com.vaadin.fluent.api.FluentFieldEvents.FluentBlurNotifier

withBlurListener

Methods inherited from interface com.vaadin.event.FieldEvents.BlurNotifier

addBlurListener

Method Detail

withClickListener

default THIS withClickListener(com.vaadin.ui.Button.ClickListener listener)

Adds the button click listener.

Parameters:

listener - the Listener to be added.

Returns:

this for method chaining

See Also:

Button.addClickListener(ClickListener)

withClickShortcut

default THIS withClickShortcut(int keyCode,
                               int... modifiers)

Makes it possible to invoke a click on this button by pressing the given ShortcutAction.KeyCode and (optional) ShortcutAction.ModifierKeys.
The shortcut is global (bound to the containing Window).

Parameters:

keyCode - the keycode for invoking the shortcut

modifiers - the (optional) modifiers for invoking the shortcut, null for none

Returns:

this for method chaining

See Also:

Button.setClickShortcut(int, int...)

withDisableOnClick

default THIS withDisableOnClick(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.

Note that this is only used when the click comes from the user, not when calling Button.click() method programmatically. Also, if developer wants to re-enable the button, it needs to be done programmatically.

Parameters:

disableOnClick - true to disable button when it is clicked, false otherwise

Returns:

this for method chaining

See Also:

Button.setDisableOnClick(boolean)

withIconAlternateText

default THIS withIconAlternateText(String iconAltText)