Package com.storedobject.vaadin

Class Button

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.button.Button

com.storedobject.vaadin.Button

All Implemented Interfaces:

HasThemeStyle, 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, Serializable

Direct Known Subclasses:

ConfirmButton, ObjectViewerButton, PopupButton

public class Button
extends com.vaadin.flow.component.button.Button
implements HasThemeStyle

Enhancements to Vaadin Button. Main features are: (1) A ClickHandler can e defined as the action when button is clicked. (2) From the text on the button, it will try to create an Icon (unless an icon is already specified), (3) Enable/disable display of icons on any newly created buttons via method setNoIcons(boolean).

Author:

Syam

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

Constructor Summary

Constructors

Constructor	Description
Button(com.vaadin.flow.component.Component icon, ClickHandler clickHandler)	Constructor.
Button(com.vaadin.flow.component.icon.VaadinIcon icon, ClickHandler clickHandler)	Constructor.
Button(String text, ClickHandler clickHandler)	Constructor.
Button(String text, com.vaadin.flow.component.Component icon, ClickHandler clickHandler)	Constructor.
Button(String text, com.vaadin.flow.component.icon.VaadinIcon icon, ClickHandler clickHandler)	Constructor.
Button(String text, String icon, ClickHandler clickHandler)	Constructor.

Method Summary

Modifier and Type	Method	Description
com.vaadin.flow.shared.Registration	addClickHandler(ClickHandler clickHandler)	Add a click handler.
Button	asPrimary()	Mark this Button as Primary.
Button	asSmall()	Make the button Small.
void	setIcon(com.vaadin.flow.component.Component icon)
void	setIcon(com.vaadin.flow.component.icon.VaadinIcon icon)	Set a Vaadin icon as the icon for this button.
void	setIcon(String icon)	Set icon for this button.
static void	setNoIcons(boolean noIcons)	Set "no icons" mode for buttons.

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

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

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

addListener, findAncestor, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, removeFromParent, scrollIntoView, scrollIntoView, 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 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, getTabIndex, setTabIndex

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

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, 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

getText, getWhiteSpace, setWhiteSpace

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

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

Methods inherited from interface com.storedobject.vaadin.HasThemeStyle

addTheme, clearThemes, getInternalElement, removeTheme, setTheme

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

addThemeVariants, removeThemeVariants

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

getTooltip, setTooltipText

Constructor Details

Button

public Button(String text,
 ClickHandler clickHandler)

Constructor.

Parameters:

text - Text label to display and the respective icon will be used (unless setNoIcons(boolean) was used to disable the display of icons.

clickHandler - Click handler

Button

public Button(com.vaadin.flow.component.Component icon,
 ClickHandler clickHandler)

Constructor.

Parameters:

icon - Icon

clickHandler - Click handler

Button

public Button(String text,
 String icon,
 ClickHandler clickHandler)

Constructor.

Parameters:

text - Text label to display

icon - Name of the icon to use

clickHandler - Click handler

Button

public Button(String text,
 com.vaadin.flow.component.Component icon,
 ClickHandler clickHandler)

Constructor.

Parameters:

text - Text label to display

icon - Icon to use

clickHandler - Click handler

Button

public Button(com.vaadin.flow.component.icon.VaadinIcon icon,
 ClickHandler clickHandler)

Constructor.

Parameters:

icon - Icon to use

clickHandler - Click handler

Button

public Button(String text,
 com.vaadin.flow.component.icon.VaadinIcon icon,
 ClickHandler clickHandler)

Constructor.

Parameters:

text - Text label to display

icon - Icon to use

clickHandler - Click handler

Method Details

addClickHandler

public com.vaadin.flow.shared.Registration addClickHandler(ClickHandler clickHandler)

Add a click handler.

Parameters:

clickHandler - Click handler to add

Returns:

Registration.

setIcon

public void setIcon(com.vaadin.flow.component.icon.VaadinIcon icon)

Set a Vaadin icon as the icon for this button.

Parameters:

icon - Vaadin icon

setIcon

public void setIcon(String icon)

Set icon for this button.

Parameters:

icon - Name of the icon

setIcon

public void setIcon(com.vaadin.flow.component.Component icon)

Overrides:

setIcon in class com.vaadin.flow.component.button.Button

asPrimary

public Button asPrimary()

Mark this Button as Primary.

Specified by:

asPrimary in interface HasThemeStyle

Returns:

Self reference.

asSmall

public Button asSmall()

Make the button Small.

Specified by:

asSmall in interface HasThemeStyle

Returns:

Self reference.

setNoIcons

public static void setNoIcons(boolean noIcons)

Set "no icons" mode for buttons. If this is "on", no icon will be displayed on buttons.

Parameters:

noIcons - True/false.