Package io.jmix.ui.component

Interface ClipboardTrigger

All Superinterfaces:

Facet

All Known Implementing Classes:

ClipboardTriggerImpl

@StudioFacet(xmlElement="clipboardTrigger",
             caption="ClipboardTrigger",
             description="Copies the text content of the input to the clipboard on button click",
             category="Facets",
             defaultProperty="input",
             icon="io/jmix/ui/icon/facet/clipboardTrigger.svg",
             documentationURL="https://docs.jmix.io/jmix/%VERSION%/ui/facets/clipboard-trigger.html")
public interface ClipboardTrigger
extends Facet

Client-side component that connects a Button and TextField or TextArea input. Copies the text content to the clipboard on button click.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ClipboardTrigger.CopyEvent	Event that is fired when the text content of the input has been copied to the clipboard.

Method Summary

Modifier and Type	Method	Description
Subscription	addCopyListener(Consumer<ClipboardTrigger.CopyEvent> listener)	Adds ClipboardTrigger.CopyEvent listener.
Button	getButton()
TextInputField<?>	getInput()
boolean	isSupportedByWebBrowser()
void	setButton(Button button)	Sets target button component.
void	setInput(TextInputField<?> input)	Sets input field: TextField or TextArea.

Methods inherited from interface io.jmix.ui.component.Facet

getId, getOwner, setId, setOwner

Method Details

setInput

@StudioProperty(type=COMPONENT_REF,
                options="io.jmix.ui.component.TextInputField")
void setInput(@Nullable
 TextInputField<?> input)

Sets input field: TextField or TextArea.

Parameters:

input - input field

getInput

@Nullable
TextInputField<?> getInput()

Returns:

input field

setButton

@StudioProperty(type=COMPONENT_REF,
                options="io.jmix.ui.component.Button")
void setButton(@Nullable
 Button button)

Sets target button component.

Parameters:

button - button

getButton

@Nullable
Button getButton()

Returns:

button

isSupportedByWebBrowser

boolean isSupportedByWebBrowser()

Returns:

true if clipboard copying is supported by web browser

addCopyListener

Subscription addCopyListener(Consumer<ClipboardTrigger.CopyEvent> listener)

Adds ClipboardTrigger.CopyEvent listener.

Parameters:

listener - listener

Returns:

subscription