We use cookies to serve our customers and website visitors in the best possible way. Cookies are used for the proper functioning of the website and for improving the user experience, monitoring visitor traffic and marketing purposes. By continuing to browse the site, you agree to our use of cookies. You can read more about cookies here.
com.vaadin.flow.component.button.
Class GeneratedVaadinButton<R extends GeneratedVaadinButton<R>>
- java.lang.Object
-
- com.vaadin.flow.component.Component
-
- com.vaadin.flow.component.button.GeneratedVaadinButton<R>
-
All Implemented Interfaces:
AttachNotifier,BlurNotifier<R>,ClickNotifier<R>,DetachNotifier,Focusable<R>,FocusNotifier<R>,HasElement,HasEnabled,HasStyle,HasText,HasTheme,SerializableDirect Known Subclasses:
@Tag("vaadin-button") @NpmPackage(value="@vaadin/polymer-legacy-adapter",version="23.1.15") @NpmPackage(value="@vaadin/button",version="23.1.15") @NpmPackage(value="@vaadin/vaadin-button",version="23.1.15") @JsModule("@vaadin/polymer-legacy-adapter/style-modules.js") @JsModule("@vaadin/button/src/vaadin-button.js") public abstract class GeneratedVaadinButton<R extends GeneratedVaadinButton<R>> extends Component implements HasStyle, ClickNotifier<R>, HasText, Focusable<R>, HasThemeDescription copied from corresponding location in WebComponent:
<vaadin-button>is a Web Component providing an accessible and customizable button.<vaadin-button> </vaadin-button>
document.querySelector('vaadin-button').addEventListener('click', () => alert('Hello World!'));Styling
The following shadow DOM parts are exposed for styling:
Part name Description labelThe label (text) inside the button prefixA slot for e.g. an icon before the label suffixA slot for e.g. an icon after the label The following attributes are exposed for styling:
Attribute Description activeSet when the button is pressed down, either with mouse, touch or the keyboard. disabledSet when the button is disabled. focus-ringSet when the button is focused using the keyboard. focusedSet when the button is focused. See ThemableMixin ? how to apply styles for shadow parts
See Also:
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface com.vaadin.flow.component.BlurNotifier
BlurNotifier.BlurEvent<C extends Component>
-
Nested classes/interfaces inherited from interface com.vaadin.flow.component.FocusNotifier
FocusNotifier.FocusEvent<C extends Component>
-
Nested classes/interfaces inherited from interface com.vaadin.flow.component.HasText
HasText.WhiteSpace
-
-
Constructor Summary
Constructors Constructor Description GeneratedVaadinButton()Default constructor.
GeneratedVaadinButton(String text)Sets the given string as the content of this component.
-
Method Summary
All Methods Modifier and Type Method Description voidaddThemeVariants(ButtonVariant... variants)Adds theme variants to the component.
protected voidaddToPrefix(Component... components)Adds the given components as children of this component at the slot 'prefix'.
protected voidaddToSuffix(Component... components)Adds the given components as children of this component at the slot 'suffix'.
protected booleanisAutofocusBoolean()Description copied from corresponding location in WebComponent:
protected booleanisDisabledBoolean()Description copied from corresponding location in WebComponent:
protected voidremove(Component... components)Removes the given child components from this component.
protected voidremoveAll()Removes all contents from this component, this includes child components, text content as well as child elements that have been added directly to this component using the
ElementAPI.voidremoveThemeVariants(ButtonVariant... variants)Removes theme variants from the component.
protected voidsetAutofocus(boolean autofocus)Description copied from corresponding location in WebComponent:
protected voidsetDisabled(boolean disabled)Deprecated.
Since 3.0, this API is deprecated in favor ofHasEnabled.setEnabled(boolean)-
Methods inherited from class com.vaadin.flow.component.Component
addListener, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getLocale, getParent, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, 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.BlurNotifier
addBlurListener
-
Methods inherited from interface com.vaadin.flow.component.ClickNotifier
addClickListener, addClickShortcut
-
Methods inherited from interface com.vaadin.flow.component.DetachNotifier
addDetachListener
-
Methods inherited from interface com.vaadin.flow.component.Focusable
addFocusShortcut, blur, focus, getTabIndex, setTabIndex
-
Methods inherited from interface com.vaadin.flow.component.FocusNotifier
addFocusListener
-
Methods inherited from interface com.vaadin.flow.component.HasElement
getElement
-
Methods inherited from interface com.vaadin.flow.component.HasEnabled
isEnabled, setEnabled
-
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.HasText
getText, getWhiteSpace, setText, setWhiteSpace
-
Methods inherited from interface com.vaadin.flow.component.HasTheme
addThemeName, addThemeNames, getThemeName, getThemeNames, hasThemeName, removeThemeName, removeThemeNames, setThemeName, setThemeName
-
-
-
-
Constructor Detail
-
GeneratedVaadinButton
public GeneratedVaadinButton(String text)Sets the given string as the content of this component.
Parameters:
text- the text content to setSee Also:
-
GeneratedVaadinButton
public GeneratedVaadinButton()Default constructor.
-
-
Method Detail
-
addThemeVariants
public void addThemeVariants(ButtonVariant... variants)Adds theme variants to the component.
Parameters:
variants- theme variants to add
-
removeThemeVariants
public void removeThemeVariants(ButtonVariant... variants)Removes theme variants from the component.
Parameters:
variants- theme variants to remove
-
isAutofocusBoolean
protected boolean isAutofocusBoolean()Description copied from corresponding location in WebComponent:
Specify that this control should have input focus when the page loads.
This property is not synchronized automatically from the client side, so the returned value may not be the same as in client side.
Returns:
the
autofocusproperty from the webcomponent
-
setAutofocus
protected void setAutofocus(boolean autofocus)Description copied from corresponding location in WebComponent:
Specify that this control should have input focus when the page loads.
Parameters:
autofocus- the boolean value to set
-
isDisabledBoolean
protected boolean isDisabledBoolean()Description copied from corresponding location in WebComponent:
If true, the user cannot interact with this element.
This property is not synchronized automatically from the client side, so the returned value may not be the same as in client side.
Returns:
the
disabledproperty from the webcomponent
-
setDisabled
@Deprecated protected void setDisabled(boolean disabled)Deprecated.Since 3.0, this API is deprecated in favor ofHasEnabled.setEnabled(boolean)Description copied from corresponding location in WebComponent:
If true, the user cannot interact with this element.
Parameters:
disabled- the boolean value to set
-
addToPrefix
protected void addToPrefix(Component... components)Adds the given components as children of this component at the slot 'prefix'.
Parameters:
components- The components to add.See Also:
-
addToSuffix
protected void addToSuffix(Component... components)Adds the given components as children of this component at the slot 'suffix'.
Parameters:
components- The components to add.See Also:
-
remove
protected void remove(Component... components)Removes the given child components from this component.
Parameters:
components- The components to remove.Throws:
IllegalArgumentException- if any of the components is not a child of this component.
-
removeAll
protected void removeAll()Removes all contents from this component, this includes child components, text content as well as child elements that have been added directly to this component using the
ElementAPI.
-
-