Package com.vaadin.flow.component.clipboard

Class ClipboardPasteStartEvent

java.lang.Object

com.vaadin.flow.component.clipboard.ClipboardPasteStartEvent

All Implemented Interfaces:

Serializable

public final class ClipboardPasteStartEvent
extends Object
implements Serializable

Fired by the server-side paste pipeline before any pasted file is uploaded. Carries the text/HTML payload and metadata for each pasted file (name, MIME type, size) but no bytes — file content is delivered later via the addPasteListener flow once uploads complete.

Use this hook to show a progress indicator the moment the user pastes, before the network round-trip for the file bytes finishes.

See Also:

• Serialized Form

Method Summary

Modifier and Type	Method	Description
List<ClipboardFileInfo>	getFiles()	Returns metadata for each pasted file in the order the browser reported them.
@Nullable String	getHtml()	Returns the HTML payload, or null if the paste carried none.
@Nullable String	getText()	Returns the plain-text payload, or null if the paste carried none.

Methods inherited from class java.lang.Object

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

Method Details

getText

public @Nullable String getText()

Returns the plain-text payload, or null if the paste carried none.

Returns:

the plain text, or null

getHtml

public @Nullable String getHtml()

Returns the HTML payload, or null if the paste carried none.

Returns:

the HTML, or null

getFiles

public List<ClipboardFileInfo> getFiles()

Returns metadata for each pasted file in the order the browser reported them. The list is empty for text-only pastes.

Returns:

an unmodifiable list of file metadata