com.xmlmind.guiutil

Class ClipboardHelper

java.lang.Object

com.xmlmind.guiutil.ClipboardHelper

public final class ClipboardHelper
extends Object

Convenience methods for accessing the contents of the clipboard.

This class is as thread-safe as Clipboard is.

Constructor Summary

Constructors

Constructor and Description
ClipboardHelper()

Method Summary

Modifier and Type	Method and Description
static String	getHTML(Clipboard clipboard) Returns the "text/html" string contained in the clipboard if any; null otherwise.
static Image	getImage(Clipboard clipboard) Returns the image contained in the clipboard if any; null otherwise.
static String	getSelection(Clipboard clipboard) Returns the system selection if any; null otherwise.
static String	getString(Clipboard clipboard) Returns the string contained in the clipboard if any; null otherwise.
static Clipboard	getSystemClipboard() Returns the system clipboard if the environment is not headless; a shared clipboard, private to the application, otherwise.
static Clipboard	getSystemSelection() Returns the system selection if this is supported by the platform (example: Linux/X11) and if the environment is not headless; a shared clipboard, private to the application, otherwise.
static boolean	hasHTML(Clipboard clipboard) Tests whether the clipboard contains a "text/html" string.
static boolean	hasImage(Clipboard clipboard) Tests whether the clipboard contains a image.
static boolean	hasSelection(Clipboard clipboard) Tests whether the system selection has been set.
static boolean	hasString(Clipboard clipboard) Tests whether the clipboard contains a string.
static void	reportError(String message, Throwable t)
static boolean	setImage(Clipboard clipboard, Image image) Copies specified image to the clipboard.
static boolean	setSelection(Clipboard clipboard, String s) Sets the system selection to specified string.
static boolean	setString(Clipboard clipboard, String s) Copies specified string to the clipboard.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClipboardHelper

public ClipboardHelper()

Method Detail

getSystemClipboard

public static Clipboard getSystemClipboard()

Returns the system clipboard if the environment is not headless; a shared clipboard, private to the application, otherwise.

See Also:

GraphicsEnvironment.isHeadless()

setString

public static boolean setString(Clipboard clipboard,
                                String s)

Copies specified string to the clipboard.

Parameters:

clipboard - the clipboard being used; null to specify the system clipboard

s - string to be copied to the clipboard

Returns:

true if the string has been successfully copied to the clipboard; false otherwise (clipboard busy or null string)

hasString

public static boolean hasString(Clipboard clipboard)

Tests whether the clipboard contains a string.

Parameters:

clipboard - the clipboard being used; null to specify the system clipboard

getString

public static String getString(Clipboard clipboard)

Returns the string contained in the clipboard if any; null otherwise.

Parameters:

clipboard - the clipboard being used; null to specify the system clipboard

hasHTML

public static boolean hasHTML(Clipboard clipboard)

Tests whether the clipboard contains a "text/html" string.

Parameters:

clipboard - the clipboard being used; null to specify the system clipboard

getHTML

public static String getHTML(Clipboard clipboard)

Returns the "text/html" string contained in the clipboard if any; null otherwise.

Beware that the returned HTML may be vastly incorrect. For example, MS-Word copies vastly incorrect HTML to the clipboard. Moreover, this HTML may start with the following kind of plain text ``header'':

Version:1.0
 StartHTML:0000000186
 EndHTML:0000486344
 ...

Parameters:

clipboard - the clipboard being used; null to specify the system clipboard

getSystemSelection

public static Clipboard getSystemSelection()

Returns the system selection if this is supported by the platform (example: Linux/X11) and if the environment is not headless; a shared clipboard, private to the application, otherwise.

See Also:

GraphicsEnvironment.isHeadless()

setSelection

public static boolean setSelection(Clipboard clipboard,
                                   String s)

Sets the system selection to specified string.

Parameters:

clipboard - the clipboard being used; null to specify the system selection

s - string to be copied to the system selection

Returns:

true if the string has been successfully copied to the system selection; false otherwise (system selection busy or null string)

hasSelection

public static boolean hasSelection(Clipboard clipboard)

Tests whether the system selection has been set.

Parameters:

clipboard - the clipboard being used; null to specify the system selection

getSelection

public static String getSelection(Clipboard clipboard)

Returns the system selection if any; null otherwise.

Parameters:

clipboard - the clipboard being used; null to specify the system selection

setImage

public static boolean setImage(Clipboard clipboard,
                               Image image)

Copies specified image to the clipboard.

Parameters:

image - image to be copied to the clipboard

Returns:

true if the image has been successfully copied to the clipboard; false otherwise (clipboard busy or null image)

hasImage

public static boolean hasImage(Clipboard clipboard)

Tests whether the clipboard contains a image.

getImage

public static Image getImage(Clipboard clipboard)

Returns the image contained in the clipboard if any; null otherwise.

See Also:

AWTUtil.toBufferedImage(java.awt.Image)

reportError

public static void reportError(String message,
                               Throwable t)