com.tplan.robot.remoteclient.capabilities

Interface ClipboardTransferCapable

All Superinterfaces:

Capability

public interface ClipboardTransferCapable
extends Capability

This interface declares client capability to receive updates of the server system clipboard. Clients implementing this interface declare that they may fire events of clipboard changes through the RemoteDesktopServerListener listener mechanism.

T-Plan Robot Enterprise, (C) 2009-2022 T-Plan Limited. All rights reserved.

Method Summary

Modifier and Type	Method and Description
boolean	canReadClipboard() Allows to switch dynamically support of clipboard reading.
boolean	canWriteToClipboard() Allows to switch dynamically support of clipboard writing.
String	getClipboardPlainText() Read the clipboard content converted to a plain text.
String	getClipboardText() Read the clipboard content as text.
void	setClipboardText(String text) Set the clipboard content to the argument text.

Method Detail

canReadClipboard

boolean canReadClipboard()

Allows to switch dynamically support of clipboard reading.

Returns:

true if the desktop supports clipboard events, false if not.

canWriteToClipboard

boolean canWriteToClipboard()

Allows to switch dynamically support of clipboard writing.

Returns:

true if the desktop supports clipboard events, false if not.

Since:

4.1.1

getClipboardText

String getClipboardText()

Read the clipboard content as text.

Returns:

the clipboard content as plain text.

Since:

4.1.1

getClipboardPlainText

String getClipboardPlainText()

Read the clipboard content converted to a plain text. It will strip any RTF or HTML markup.

Returns:

the clipboard content as plain text.

Since:

4.4.6

setClipboardText

void setClipboardText(String text)

Set the clipboard content to the argument text.

Parameters:

text - the text to set the clipboard to.

Since:

4.1.1