Class CopyToClipboardButton

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.button.Button

org.vaadin.firitin.components.button.VButton

org.vaadin.firitin.util.clipboard.CopyToClipboardButton

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.orderedlayout.ThemableLayout, 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, FluentAttachNotifier<VButton>, FluentBlurNotifier<com.vaadin.flow.component.button.Button, VButton>, FluentClickNotifier<com.vaadin.flow.component.button.Button, VButton>, FluentComponent<VButton>, FluentDetachNotifier<VButton>, FluentFocusable<com.vaadin.flow.component.button.Button, VButton>, FluentFocusNotifier<com.vaadin.flow.component.button.Button, VButton>, FluentHasEnabled<VButton>, FluentHasSize<VButton>, FluentHasStyle<VButton>, FluentHasText<VButton>, FluentHasTooltip<VButton>, FluentThemableLayout<VButton>, HasPadding<VButton>

public class CopyToClipboardButton
extends VButton

A helper button to copy certain text to the clipboard. Works asynchronously so that the text can be generated when the button is clicked or provided statically. As opposed to the current implementation of the Clipboard class, which could be used to implement this functionality as well, this class also supports Safari.

Currently only basic text is supported, not HTML or other formats (would be fairly easy to add though).

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class VButton

VButton.BasicClickListener, VButton.ButtonColor, VButton.ButtonSize, VButton.ButtonType

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

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

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

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

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

com.vaadin.flow.component.HasText.WhiteSpace

Constructor Summary

Constructors

Constructor	Description
CopyToClipboardButton(com.vaadin.flow.function.SerializableSupplier<String> textSupplier)
CopyToClipboardButton(String string)

Method Summary

Methods inherited from class VButton

addClickListener, getColor, getSize, getType, onClick, setColor, setSize, setType, withAutofocus, withClickShortcut, withColor, withIcon, withIconAfterText, withSize, withThemeVariants, withType

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

addBlurListener, addFocusListener, addFocusShortcut, click, clickInClient, getIcon, isAutofocus, isDisableOnClick, isIconAfterText, remove, setAutofocus, setDisableOnClick, setEnabled, setIcon, 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 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, addDoubleClickListener, addSingleClickListener

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

addDetachListener

Methods inherited from interface FluentAttachNotifier

withAttachListener

Methods inherited from interface FluentBlurNotifier

withBlurListener

Methods inherited from interface FluentClickNotifier

withClickListener

Methods inherited from interface FluentComponent

navigate, setId, setVisible, withId, withVisible

Methods inherited from interface FluentDetachNotifier

withDetachListener

Methods inherited from interface FluentFocusable

withTabIndex

Methods inherited from interface FluentFocusNotifier

withFocusListener

Methods inherited from interface FluentHasEnabled

withEnabled

Methods inherited from interface FluentHasSize

addResizeListener, withFullHeight, withFullWidth, withHeight, withMaxHeight, withMaxSize, withMaxWidth, withMinHeight, withMinSize, withMinWidth, withSize, withSizeFull, withSizeUndefined, withWidth

Methods inherited from interface FluentHasStyle

getStyle, withAddedClassName, withClassName, withStyle

Methods inherited from interface FluentHasText

withText

Methods inherited from interface FluentHasTooltip

withTooltip

Methods inherited from interface FluentThemableLayout

withBoxSizing, withMargin, withPadding, withSpacing

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

Methods inherited from interface HasPadding

setPadding, setPadding, setPadding, withPadding, withPadding, withPadding

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

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.shared.HasThemeVariant

addThemeVariants, removeThemeVariants

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

getTooltip, setTooltipText

Methods inherited from interface com.vaadin.flow.component.orderedlayout.ThemableLayout

getBoxSizing, getSpacing, getThemeList, isMargin, isPadding, isSpacing, isWrap, setBoxSizing, setMargin, setPadding, setSpacing, setSpacing, setSpacing, setWrap

Constructor Details

CopyToClipboardButton

public CopyToClipboardButton(String string)

CopyToClipboardButton

public CopyToClipboardButton(com.vaadin.flow.function.SerializableSupplier<String> textSupplier)