public class Clipboard extends Object
FlavorListener
s may be registered on an instance of the
Clipboard class to be notified about changes to the set of
DataFlavor
s available on this clipboard (see
addFlavorListener(java.awt.datatransfer.FlavorListener)
).
Modifier and Type | Field | Description |
---|---|---|
protected Transferable |
contents |
Contents of the clipboard.
|
protected ClipboardOwner |
owner |
The owner of the clipboard.
|
Constructor | Description |
---|---|
Clipboard(String name) |
Creates a clipboard object.
|
Modifier and Type | Method | Description |
---|---|---|
void |
addFlavorListener(FlavorListener listener) |
Registers the specified
FlavorListener to receive
FlavorEvent s from this clipboard. |
DataFlavor[] |
getAvailableDataFlavors() |
Returns an array of
DataFlavor s in which the current
contents of this clipboard can be provided. |
Transferable |
getContents(Object requestor) |
Returns a transferable object representing the current contents
of the clipboard.
|
Object |
getData(DataFlavor flavor) |
Returns an object representing the current contents of this clipboard
in the specified
DataFlavor . |
FlavorListener[] |
getFlavorListeners() |
Returns an array of all the
FlavorListener s currently
registered on this Clipboard . |
String |
getName() |
Returns the name of this clipboard object.
|
boolean |
isDataFlavorAvailable(DataFlavor flavor) |
Returns whether or not the current contents of this clipboard can be
provided in the specified
DataFlavor . |
void |
removeFlavorListener(FlavorListener listener) |
Removes the specified
FlavorListener so that it no longer
receives FlavorEvent s from this Clipboard . |
void |
setContents(Transferable contents,
ClipboardOwner owner) |
Sets the current contents of the clipboard to the specified
transferable object and registers the specified clipboard owner
as the owner of the new contents.
|
protected ClipboardOwner owner
protected Transferable contents
public Clipboard(String name)
name
- for the clipboardToolkit.getSystemClipboard()
public String getName()
Toolkit.getSystemClipboard()
public void setContents(Transferable contents, ClipboardOwner owner)
If there is an existing owner different from the argument
owner
, that owner is notified that it no longer
holds ownership of the clipboard contents via an invocation
of ClipboardOwner.lostOwnership()
on that owner.
An implementation of setContents()
is free not
to invoke lostOwnership()
directly from this method.
For example, lostOwnership()
may be invoked later on
a different thread. The same applies to FlavorListener
s
registered on this clipboard.
The method throws IllegalStateException
if the clipboard
is currently unavailable. For example, on some platforms, the system
clipboard is unavailable while it is accessed by another application.
contents
- the transferable object representing the
clipboard contentowner
- the object which owns the clipboard contentIllegalStateException
- if the clipboard is currently unavailableToolkit.getSystemClipboard()
public Transferable getContents(Object requestor)
null
. The parameter Object requestor is
not currently used. The method throws
IllegalStateException
if the clipboard is currently
unavailable. For example, on some platforms, the system clipboard is
unavailable while it is accessed by another application.requestor
- the object requesting the clip data (not used)IllegalStateException
- if the clipboard is currently unavailableToolkit.getSystemClipboard()
public DataFlavor[] getAvailableDataFlavors()
DataFlavor
s in which the current
contents of this clipboard can be provided. If there are no
DataFlavor
s available, this method returns a zero-length
array.DataFlavor
s in which the current
contents of this clipboard can be providedIllegalStateException
- if this clipboard is currently unavailablepublic boolean isDataFlavorAvailable(DataFlavor flavor)
DataFlavor
.flavor
- the requested DataFlavor
for the contentstrue
if the current contents of this clipboard
can be provided in the specified DataFlavor
;
false
otherwiseNullPointerException
- if flavor
is null
IllegalStateException
- if this clipboard is currently unavailablepublic Object getData(DataFlavor flavor) throws UnsupportedFlavorException, IOException
DataFlavor
.
The class of the object returned is defined by the representation
class of flavor
.flavor
- the requested DataFlavor
for the contentsDataFlavor
NullPointerException
- if flavor
is null
IllegalStateException
- if this clipboard is currently unavailableUnsupportedFlavorException
- if the requested DataFlavor
is not availableIOException
- if the data in the requested DataFlavor
can not be retrievedDataFlavor.getRepresentationClass()
public void addFlavorListener(FlavorListener listener)
FlavorListener
to receive
FlavorEvent
s from this clipboard.
If listener
is null
, no exception
is thrown and no action is performed.listener
- the listener to be addedremoveFlavorListener(java.awt.datatransfer.FlavorListener)
,
getFlavorListeners()
,
FlavorListener
,
FlavorEvent
public void removeFlavorListener(FlavorListener listener)
FlavorListener
so that it no longer
receives FlavorEvent
s from this Clipboard
.
This method performs no function, nor does it throw an exception, if
the listener specified by the argument was not previously added to this
Clipboard
.
If listener
is null
, no exception
is thrown and no action is performed.listener
- the listener to be removedaddFlavorListener(java.awt.datatransfer.FlavorListener)
,
getFlavorListeners()
,
FlavorListener
,
FlavorEvent
public FlavorListener[] getFlavorListeners()
FlavorListener
s currently
registered on this Clipboard
.FlavorListener
s or an empty
array if no listeners are currently registeredaddFlavorListener(java.awt.datatransfer.FlavorListener)
,
removeFlavorListener(java.awt.datatransfer.FlavorListener)
,
FlavorListener
,
FlavorEvent
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2017, Oracle and/or its affiliates. 500 Oracle Parkway
Redwood Shores, CA 94065 USA. All rights reserved.
DRAFT 9-internal+0-adhoc.mlchung.jdk9-jdeps