public class

Clipboard

extends Object
java.lang.Object
   ↳ java.awt.datatransfer.Clipboard
Known Direct Subclasses

Class Overview

A class that implements a mechanism to transfer data using cut/copy/paste operations.

FlavorListeners may be registered on an instance of the Clipboard class to be notified about changes to the set of DataFlavors available on this clipboard (see addFlavorListener(FlavorListener)).

See Also

Summary

Fields
protected Transferable contents
protected ClipboardOwner owner
Public Constructors
Clipboard(String name)
Creates a clipboard object.
Public Methods
synchronized void addFlavorListener(FlavorListener listener)
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.
synchronized 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.
synchronized 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 flavor)
Returns whether or not the current contents of this clipboard can be provided in the specified DataFlavor.
synchronized void removeFlavorListener(FlavorListener listener)
Removes the specified FlavorListener so that it no longer receives FlavorEvents from this Clipboard.
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.
[Expand]
Inherited Methods
From class java.lang.Object

Fields

protected Transferable contents

protected ClipboardOwner owner

Public Constructors

public Clipboard (String name)

Creates a clipboard object.

See Also

Public Methods

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.

Parameters
listener the listener to be added
See Also

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

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.

Parameters
requestor the object requesting the clip data (not used)
Returns
  • the current transferable object on the clipboard
Throws
IllegalStateException if the clipboard is currently unavailable
See Also

public Object getData (DataFlavor flavor)

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
See Also

public synchronized 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
See Also

public String getName ()

Returns the name of this clipboard object.

See Also

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

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.

Parameters
listener the listener to be removed
See Also

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.

Parameters
contents the transferable object representing the clipboard content
owner the object which owns the clipboard content
Throws
IllegalStateException if the clipboard is currently unavailable
See Also