akasha.clipboard

Class Clipboard

java.lang.Object

akasha.core.JsObject

akasha.EventTarget

akasha.clipboard.Clipboard

@Generated(value="org.realityforge.webtack")
 @JsType(isNative=true,
        namespace="<global>",
        name="Clipboard")
public class Clipboard
extends EventTarget

The Clipboard interface implements the Clipboard API, providing—if the user grants permission—both read and write access to the contents of the system clipboard.

See Also:

Clipboard - MDN, # clipboard-interface

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Clipboard()

Method Summary

Modifier and Type	Method and Description
Promise<JsArray<ClipboardItem>>	read() The read() method of the Clipboard interface requests a copy of the clipboard's contents, delivering the data to the returned Promise when the promise is resolved.
Promise<java.lang.String>	readText() The Clipboard interface's readText() method returns a Promise which resolves with a copy of the textual contents of the system clipboard.
Promise<java.lang.Void>	write(ClipboardItem[] data) The Clipboard method write() writes arbitrary data, such as images, to the clipboard.
Promise<java.lang.Void>	write(JsArray<ClipboardItem> data) The Clipboard method write() writes arbitrary data, such as images, to the clipboard.
Promise<java.lang.Void>	writeText(java.lang.String data) The Clipboard interface's writeText() property writes the specified text string to the system clipboard.

Methods inherited from class akasha.EventTarget

addEventListener, addEventListener, addEventListener, dispatchEvent, removeEventListener, removeEventListener, removeEventListener

Methods inherited from class akasha.core.JsObject

assign, create, create, defineProperties, defineProperty, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyDescriptor, getOwnPropertyDescriptors, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toString_, valueOf_, values

Methods inherited from class java.lang.Object

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

Constructor Detail

Clipboard

protected Clipboard()

Method Detail

read

@Nonnull
public Promise<JsArray<ClipboardItem>> read()

The read() method of the Clipboard interface requests a copy of the clipboard's contents, delivering the data to the returned Promise when the promise is resolved. Unlike readText(), the read() method can return arbitrary data, such as images. This method can also return text.

See Also:

Clipboard.read - MDN, read() - Clipboard API and events

readText

@Nonnull
public Promise<java.lang.String> readText()

The Clipboard interface's readText() method returns a Promise which resolves with a copy of the textual contents of the system clipboard.

See Also:

Clipboard.readText - MDN, readText() - Clipboard API and events

write

@Nonnull
public Promise<java.lang.Void> write(@Nonnull
                                              JsArray<ClipboardItem> data)

The Clipboard method write() writes arbitrary data, such as images, to the clipboard.

See Also:

Clipboard.write - MDN, write() - Clipboard API and events

write

@Nonnull
public Promise<java.lang.Void> write(@Nonnull
                                              ClipboardItem[] data)

The Clipboard method write() writes arbitrary data, such as images, to the clipboard.

See Also:

Clipboard.write - MDN, write() - Clipboard API and events

writeText

@Nonnull
public Promise<java.lang.Void> writeText(@Nonnull
                                                  java.lang.String data)

The Clipboard interface's writeText() property writes the specified text string to the system clipboard. Text may be read back using either read() or readText().

See Also:

Clipboard.writeText - MDN, writeText() - Clipboard API and events