public class Clipboard
extends java.lang.Object
Clipboard
provides a mechanism for transferring data from one
application to another or within an application.
IMPORTANT: This class is not intended to be subclassed.
Constructor and Description |
---|
Clipboard(Display display)
Constructs a new instance of this class.
|
Modifier and Type | Method and Description |
---|---|
protected void |
checkSubclass()
Checks that this class can be subclassed.
|
protected void |
checkWidget()
Throws an
SWTException if the receiver can not
be accessed by the caller. |
void |
dispose()
Disposes of the operating system resources associated with the clipboard.
|
java.lang.Object |
getContents(Transfer transfer)
Retrieve the data of the specified type currently available on the system
clipboard.
|
boolean |
isDisposed()
Returns
true if the clipboard has been disposed,
and false otherwise. |
void |
setContents(java.lang.Object[] data,
Transfer[] dataTypes)
Place data of the specified type on the system clipboard.
|
public Clipboard(Display display)
display
- the display on which to allocate the clipboardSWTException
- checkSubclass()
public java.lang.Object getContents(Transfer transfer)
Transfer
to
determine the type of object returned. Only TextTransfer
is currently supported.
The following snippet shows text being retrieved from the clipboard:
Clipboard clipboard = new Clipboard(display);
TextTransfer textTransfer = TextTransfer.getInstance();
String textData = (String)clipboard.getContents(textTransfer);
if (textData != null) System.out.println("Text is "+textData);
transfer
- the transfer agent for the type of data being requestedSWTException
- java.lang.IllegalArgumentException
- java.lang.UnsupportedOperationException
- when running the application in JEE_COMPATIBILITY modejava.lang.IllegalStateException
- when clipboard content is already requested.Application.OperationMode
,
Transfer
public void setContents(java.lang.Object[] data, Transfer[] dataTypes)
TextTransfer
is currently supported.
The following snippet shows text being set on the copy/paste clipboard:
Clipboard clipboard = new Clipboard(display);
String textData = "Hello World";
TextTransfer textTransfer = TextTransfer.getInstance();
Transfer[] transfers = new Transfer[]{textTransfer};
Object[] data = new Object[]{textData};
clipboard.setContents(data, transfers);
data
- the data to be set in the clipboarddataTypes
- the transfer agents that will convert the data to its
platform specific format; each entry in the data array must have a
corresponding dataTypejava.lang.IllegalArgumentException
- SWTException
- SWTError
- java.lang.UnsupportedOperationException
- when running the application in JEE_COMPATIBILITY modejava.lang.IllegalStateException
- when clipboard content is already requested.Application.OperationMode
public void dispose()
SWTException
- public boolean isDisposed()
true
if the clipboard has been disposed,
and false
otherwise.
This method gets the dispose state for the clipboard. When a clipboard has been disposed, it is an error to invoke any other method using the clipboard.
true
when the widget is disposed and false
otherwiseprotected void checkWidget()
SWTException
if the receiver can not
be accessed by the caller. This may include both checks on
the state of the receiver and more generally on the entire
execution context. This method should be called by
widget implementors to enforce the standard SWT invariants.
Currently, it is an error to invoke any method (other than
isDisposed()
) on a widget that has had its
dispose()
method called. It is also an error
to call widget methods from any thread that is different
from the thread that created the widget.
In future releases of SWT, there may be more or fewer error checks and exceptions may be thrown for different reasons.
SWTException
- protected void checkSubclass()
The SWT class library is intended to be subclassed only at specific, controlled points. This method enforces this rule unless it is overridden.
IMPORTANT: By providing an implementation of this method that allows a subclass of a class which does not normally allow subclassing to be created, the implementer agrees to be fully responsible for the fact that any such subclass will likely fail between SWT releases and will be strongly platform specific. No support is provided for user-written classes which are implemented in this fashion.
The ability to subclass outside of the allowed SWT classes is intended purely to enable those not on the SWT development team to implement patches in order to get around specific limitations in advance of when those limitations can be addressed by the team. Subclassing should not be attempted without an intimate and detailed understanding of the hierarchy.
SWTException
-
Copyright (c) EclipseSource and others 2002, 2020.
All rights reserved. This program and the accompanying materials
are made available under the terms of the
Eclipse Public License v1.0