org.vaadin.miki.superfields.buttons

Class IndexedButton

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.button.GeneratedVaadinButton<com.vaadin.flow.component.button.Button>

com.vaadin.flow.component.button.Button

org.vaadin.miki.superfields.buttons.IndexedButton

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.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, Serializable, Clickable, HasComponentAsIcon, HasId, HasIndex, HasTooltip, WithComponentAsIconMixin<IndexedButton>, WithIdMixin<IndexedButton>, WithIndexMixin<IndexedButton>, WithTextMixin<IndexedButton>, WithTooltipMixin<IndexedButton>

public class IndexedButton
extends com.vaadin.flow.component.button.Button
implements WithIndexMixin<IndexedButton>, WithIdMixin<IndexedButton>, WithComponentAsIconMixin<IndexedButton>, WithTextMixin<IndexedButton>, Clickable, WithTooltipMixin<IndexedButton>

An indexed Button, i.e. one that implements HasIndex.

Since:

2021-08-30

Author:

miki

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>

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_INDEX

Constructor Summary

Constructors

Constructor and Description
IndexedButton() Creates an indexed button with DEFAULT_INDEX as index.
IndexedButton(com.vaadin.flow.component.Component icon) Creates an indexed button with DEFAULT_INDEX as index and an icon.
IndexedButton(com.vaadin.flow.component.Component icon, com.vaadin.flow.component.ComponentEventListener<com.vaadin.flow.component.ClickEvent<com.vaadin.flow.component.button.Button>> clickListener) Creates an indexed button with DEFAULT_INDEX as index, given icon and a listener.
IndexedButton(com.vaadin.flow.component.Component icon, int startingIndex, com.vaadin.flow.component.ComponentEventListener<com.vaadin.flow.component.ClickEvent<com.vaadin.flow.component.button.Button>> listener) Creates the button with am icon, starting index and a click listener.
IndexedButton(int startingIndex) Creates the button with a given initial index.
IndexedButton(String text) Creates an indexed button with DEFAULT_INDEX as index and given text on the button.
IndexedButton(String text, com.vaadin.flow.component.Component icon) Creates an indexed button with DEFAULT_INDEX as index, given text and icon on the button.
IndexedButton(String text, com.vaadin.flow.component.Component icon, com.vaadin.flow.component.ComponentEventListener<com.vaadin.flow.component.ClickEvent<com.vaadin.flow.component.button.Button>> clickListener) Creates an indexed button with DEFAULT_INDEX as index, given text and icon, and a listener.
IndexedButton(String text, com.vaadin.flow.component.ComponentEventListener<com.vaadin.flow.component.ClickEvent<com.vaadin.flow.component.button.Button>> clickListener) Creates an indexed button with DEFAULT_INDEX as index, given text and a listener.
IndexedButton(String text, com.vaadin.flow.component.Component icon, int startingIndex, com.vaadin.flow.component.ComponentEventListener<com.vaadin.flow.component.ClickEvent<com.vaadin.flow.component.button.Button>> listener) Creates the button with a given text, icon, starting index and a click listener.
IndexedButton(String text, int startingIndex, com.vaadin.flow.component.ComponentEventListener<com.vaadin.flow.component.ClickEvent<com.vaadin.flow.component.button.Button>> listener) Creates the button with a given text, starting index and a click listener.

Method Summary

Modifier and Type	Method and Description
int	getIndex() Returns the current index of the object.
String	getText() Returns current text of this object.
String	getTooltipText() Returns the current tooltip text of the object.
void	setIndex(int index) Changes the index of the object.
void	setTooltipText(String title) Sets new tooltip text of the object.

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

click, clickInClient, getIcon, isAutofocus, isDisableOnClick, isIconAfterText, onAttach, setAutofocus, setDisableOnClick, setIcon, setIconAfterText, setText

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

addThemeVariants, addToPrefix, addToSuffix, isAutofocusBoolean, isDisabledBoolean, remove, removeAll, removeThemeVariants, setDisabled

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

addListener, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onDetach, onEnabledStateChanged, set, setElement, setId, setVisible

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.vaadin.miki.markers.WithIndexMixin

withIndex

Methods inherited from interface org.vaadin.miki.markers.WithIdMixin

withId

Methods inherited from interface org.vaadin.miki.markers.HasId

getId, setId

Methods inherited from interface org.vaadin.miki.markers.WithComponentAsIconMixin

withIcon

Methods inherited from interface org.vaadin.miki.markers.HasComponentAsIcon

getIcon, setIcon

Methods inherited from interface org.vaadin.miki.markers.WithTextMixin

withText

Methods inherited from interface org.vaadin.miki.markers.HasText

setText

Methods inherited from interface org.vaadin.miki.markers.Clickable

click

Methods inherited from interface org.vaadin.miki.markers.WithTooltipMixin

withTooltipText

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

getCssSize, 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.HasEnabled

isEnabled, setEnabled

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

getElement

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

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

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

addClickListener, addClickShortcut

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

addFocusShortcut, blur, focus, getTabIndex, setTabIndex

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

addBlurListener

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

addFocusListener

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

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

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

addAttachListener

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

addDetachListener

Field Detail

DEFAULT_INDEX

public static final int DEFAULT_INDEX

See Also:

Constant Field Values

Constructor Detail

IndexedButton

public IndexedButton()

Creates an indexed button with DEFAULT_INDEX as index.

IndexedButton

public IndexedButton(String text)

Creates an indexed button with DEFAULT_INDEX as index and given text on the button.

Parameters:

text - Text to show on the button.

IndexedButton

public IndexedButton(com.vaadin.flow.component.Component icon)

Creates an indexed button with DEFAULT_INDEX as index and an icon.

Parameters:

icon - Icon to put on the button.

IndexedButton

public IndexedButton(String text,
                     com.vaadin.flow.component.Component icon)

Creates an indexed button with DEFAULT_INDEX as index, given text and icon on the button.

Parameters:

text - Text on the button.

icon - Icon on the button.

IndexedButton

public IndexedButton(String text,
                     com.vaadin.flow.component.ComponentEventListener<com.vaadin.flow.component.ClickEvent<com.vaadin.flow.component.button.Button>> clickListener)

Creates an indexed button with DEFAULT_INDEX as index, given text and a listener.

Parameters:

text - Text on the button.

clickListener - Event listener.

IndexedButton

public IndexedButton(com.vaadin.flow.component.Component icon,
                     com.vaadin.flow.component.ComponentEventListener<com.vaadin.flow.component.ClickEvent<com.vaadin.flow.component.button.Button>> clickListener)

Creates an indexed button with DEFAULT_INDEX as index, given icon and a listener.

Parameters:

icon - Icon on the button.

clickListener - Event listener.

IndexedButton

public IndexedButton(String text,
                     com.vaadin.flow.component.Component icon,
                     com.vaadin.flow.component.ComponentEventListener<com.vaadin.flow.component.ClickEvent<com.vaadin.flow.component.button.Button>> clickListener)

Creates an indexed button with DEFAULT_INDEX as index, given text and icon, and a listener.

Parameters:

text - Text on the button.

icon - Icon on the button.

clickListener - Event listener.

IndexedButton

public IndexedButton(int startingIndex)

Creates the button with a given initial index.

Parameters:

startingIndex - Initial index of the button.

IndexedButton

public IndexedButton(String text,
                     int startingIndex,
                     com.vaadin.flow.component.ComponentEventListener<com.vaadin.flow.component.ClickEvent<com.vaadin.flow.component.button.Button>> listener)

Creates the button with a given text, starting index and a click listener.

Parameters:

text - Initial text.

startingIndex - Initial index of the button.

listener - Listener to be called on click.

IndexedButton

public IndexedButton(String text,
                     com.vaadin.flow.component.Component icon,
                     int startingIndex,
                     com.vaadin.flow.component.ComponentEventListener<com.vaadin.flow.component.ClickEvent<com.vaadin.flow.component.button.Button>> listener)

Creates the button with a given text, icon, starting index and a click listener.

Parameters:

text - Initial text.

icon - Icon.

startingIndex - Initial index of the button.

listener - Listener to be called on click.

IndexedButton

public IndexedButton(com.vaadin.flow.component.Component icon,
                     int startingIndex,
                     com.vaadin.flow.component.ComponentEventListener<com.vaadin.flow.component.ClickEvent<com.vaadin.flow.component.button.Button>> listener)

Creates the button with am icon, starting index and a click listener.

Parameters:

icon - Icon.

startingIndex - Initial index of the button.

listener - Listener to be called on click.

Method Detail

getIndex

public int getIndex()

Description copied from interface: HasIndex

Returns the current index of the object.

Specified by:

getIndex in interface HasIndex

Returns:

Current index.

setIndex

public final void setIndex(int index)

Description copied from interface: HasIndex

Changes the index of the object.

Specified by:

setIndex in interface HasIndex

Parameters:

index - New index.

getText

public String getText()

Description copied from interface: HasText

Returns current text of this object.

Specified by:

getText in interface com.vaadin.flow.component.HasText

Returns:

Current text.

setTooltipText

public void setTooltipText(String title)

Description copied from interface: HasTooltip

Sets new tooltip text of the object.

Specified by:

setTooltipText in interface HasTooltip

Parameters:

title - New tooltip text.

getTooltipText

public String getTooltipText()

Description copied from interface: HasTooltip

Returns the current tooltip text of the object.

Specified by:

getTooltipText in interface HasTooltip

Returns:

Current tooltip.