is new.
java.lang.Objectjava.awt.datatransfer.Clipboard
A class
that
which
implements a mechanism to transfer data using cut/copy/paste operations.
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)
).
,
Toolkit.getSystemSelection()
| Field Summary | |
|---|---|
| protected Transferable |
contents
|
| protected ClipboardOwner |
owner
|
| Constructor Summary | |
|---|---|
|
Clipboard
(
String
name) Creates a clipboard object. |
|
| Method Summary | |
|---|---|
void
|
addFlavorListener
(
FlavorListener
Registers the specified FlavorListener to receive FlavorEvents from this clipboard.
|
DataFlavor
|
getAvailableDataFlavors
()
Returns an array of DataFlavors 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
Returns an object representing the current contents of this clipboard in the specified DataFlavor.
|
FlavorListener
|
getFlavorListeners
()
Returns an array of all the FlavorListeners currently registered on this Clipboard.
|
| String |
getName
() Returns the name of this clipboard object. |
boolean
|
isDataFlavorAvailable
(
DataFlavor
Returns whether or not the current contents of this clipboard can be provided in the specified DataFlavor.
|
void
|
removeFlavorListener
(
FlavorListener
Removes the specified FlavorListener so that it no longer receives FlavorEvents 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. |
| Methods inherited from class java.lang. Object |
|---|
| clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait |
| Field Detail |
|---|
protected ClipboardOwner owner
protected Transferable contents
| Constructor Detail |
|---|
public Clipboard(String name)
| Method Detail |
|---|
public String getName()
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 FlavorListeners 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.
public Transferable getContents(Object requestor)
getAvailableDataFlavors
public
DataFlavor
[]
getAvailableDataFlavors
()
Returns an array of DataFlavors in which the current contents of this clipboard can be provided. If there are no DataFlavors available, this method returns a zero-length array.
Returns:
an array of DataFlavors in which the current contents of this clipboard can be provided
Throws:
IllegalStateException
- if this clipboard is currently unavailable
Since:
1.5
isDataFlavorAvailable
public boolean
isDataFlavorAvailable
(
DataFlavor
flavor)
Returns whether or not the current contents of this clipboard can be provided in the specified DataFlavor.
Parameters:
flavor - the requested DataFlavor for the contents
Returns:
true if the current contents of this clipboard can be provided in the specified DataFlavor; false otherwise
Throws:
NullPointerException
- if flavor is null
IllegalStateException
- if this clipboard is currently unavailable
Since:
1.5
getData
public
Object
getData
(
DataFlavor
flavor) throws
UnsupportedFlavorException
,
IOException
Returns an object representing the current contents of this clipboard in the specified DataFlavor. The class of the object returned is defined by the representation class of flavor.
Parameters:
flavor - the requested DataFlavor for the contents
Returns:
an object representing the current contents of this clipboard in the specified DataFlavor
Throws:
NullPointerException
- if flavor is null
IllegalStateException
- if this clipboard is currently unavailable
UnsupportedFlavorException
- if the requested DataFlavor is not available
IOException
- if the data in the requested DataFlavor can not be retrieved
Since:
1.5
See Also:
DataFlavor.getRepresentationClass()
addFlavorListener
public void
addFlavorListener
(
FlavorListener
listener)
Registers the specified FlavorListener to receive FlavorEvents from this clipboard. If listener is null, no exception is thrown and no action is performed.
Parameters:
listener - the listener to be added
Since:
1.5
See Also:
removeFlavorListener(java.awt.datatransfer.FlavorListener)
,
getFlavorListeners()
,
FlavorListener
,
FlavorEvent
removeFlavorListener
public void
removeFlavorListener
(
FlavorListener
listener)
Removes the specified FlavorListener so that it no longer receives FlavorEvents 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.
Parameters:
listener - the listener to be removed
Since:
1.5
See Also:
addFlavorListener(java.awt.datatransfer.FlavorListener)
,
getFlavorListeners()
,
FlavorListener
,
FlavorEvent
getFlavorListeners
public
FlavorListener
[]
getFlavorListeners
()
Returns an array of all the FlavorListeners currently registered on this Clipboard.
Returns:
all of this clipboard's FlavorListeners or an empty array if no listeners are currently registered
Since:
1.5
See Also:
addFlavorListener(java.awt.datatransfer.FlavorListener)
,
removeFlavorListener(java.awt.datatransfer.FlavorListener)
,
FlavorListener
,
FlavorEvent