Package com.vaadin.flow.component.clipboard

Class ClipboardEvent

java.lang.Object
com.vaadin.flow.component.clipboard.ClipboardEvent
All Implemented Interfaces:
Serializable
public final class ClipboardEvent extends Object implements Serializable
Payload delivered to listeners registered via Clipboard.addPasteListener(com.vaadin.flow.component.Component, com.vaadin.flow.function.SerializableConsumer<com.vaadin.flow.component.clipboard.ClipboardEvent>), Clipboard.addCopyListener(com.vaadin.flow.component.Component, com.vaadin.flow.function.SerializableConsumer<com.vaadin.flow.component.clipboard.ClipboardEvent>) or Clipboard.addCutListener(com.vaadin.flow.component.Component, com.vaadin.flow.function.SerializableConsumer<com.vaadin.flow.component.clipboard.ClipboardEvent>).

A paste event may carry plain text, HTML, files, or any combination. Copy and cut events typically carry only text and HTML — files are paste-only on the browser side.

See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    COPY
    Event type identifier for copy events.
    static final String
    CUT
    Event type identifier for cut events.
    static final String
    PASTE
    Event type identifier for paste events.

  • Method Summary

    Modifier and Type
    Method
    Description
    List<ClipboardFile>
    getFiles()
    Returns the files attached to this event.
    @Nullable String
    getHtml()
    Returns the HTML payload, or null if the event carried none.
    @Nullable String
    getText()
    Returns the plain-text payload, or null if the event carried none.
    String
    getType()
    Returns the event type — one of PASTE, COPY, CUT.
    boolean
    hasFiles()
    Returns whether the event carried at least one file.
    boolean
    hasHtml()
    Returns whether the event carried a non-empty HTML payload.
    boolean
    hasText()
    Returns whether the event carried a non-empty plain-text payload.

    Methods inherited from class java.lang.Object

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

  • Field Details

  • Method Details

    • getType

      public String getType()
      Returns the event type — one of PASTE, COPY, CUT.
      Returns:
      the event type

    • getText

      public @Nullable String getText()
      Returns the plain-text payload, or null if the event carried none.
      Returns:
      the plain text, or null

    • getHtml

      public @Nullable String getHtml()
      Returns the HTML payload, or null if the event carried none. Useful when the user pastes rich text from a web page or word processor.
      Returns:
      the HTML, or null

    • hasText

      public boolean hasText()
      Returns whether the event carried a non-empty plain-text payload.
      Returns:
      true if getText() is non-null and non-empty

    • hasHtml

      public boolean hasHtml()
      Returns whether the event carried a non-empty HTML payload.
      Returns:
      true if getHtml() is non-null and non-empty

    • hasFiles

      public boolean hasFiles()
      Returns whether the event carried at least one file.
      Returns:
      true if getFiles() is non-empty

    • getFiles

      public List<ClipboardFile> getFiles()
      Returns the files attached to this event. Empty for copy and cut events.
      Returns:
      an unmodifiable list of files, never null