Home » openjdk-7 » java » awt » datatransfer » [javadoc | source]
java.awt.datatransfer
public class: Clipboard [javadoc | source]
java.lang.Object
   java.awt.datatransfer.Clipboard
A class that 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 ).

Field Summary
 String name     
protected  ClipboardOwner owner     
protected  Transferable contents     
Constructor:
 public Clipboard(String name) 
    Creates a clipboard object.
    Also see:
    java.awt.Toolkit#getSystemClipboard
Method from java.awt.datatransfer.Clipboard Summary:
addFlavorListener,   getAvailableDataFlavors,   getContents,   getData,   getFlavorListeners,   getName,   isDataFlavorAvailable,   removeFlavorListener,   setContents
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from java.awt.datatransfer.Clipboard Detail:
 public synchronized  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.
 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.
 public synchronized Transferable getContents(Object requestor) 
    Returns a transferable object representing the current contents of the clipboard. If the clipboard currently has no contents, it returns 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.
 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.
 public synchronized FlavorListener[] getFlavorListeners() 
    Returns an array of all the FlavorListeners currently registered on this Clipboard.
 public String getName() 
    Returns the name of this clipboard object.
 public boolean isDataFlavorAvailable(DataFlavor flavor) 
    Returns whether or not the current contents of this clipboard can be provided in the specified DataFlavor.
 public synchronized  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.
 public synchronized  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.

    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.