Java Doc for Clipboard.java in  » 6.0-JDK-Core » AWT » java » awt » datatransfer » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Home
Java Source Code / Java Documentation
1.6.0 JDK Core
2.6.0 JDK Modules
3.6.0 JDK Modules com.sun
4.6.0 JDK Modules com.sun.java
5.6.0 JDK Modules sun
6.6.0 JDK Platform
7.Ajax
8.Apache Harmony Java SE
9.Aspect oriented
10.Authentication Authorization
11.Blogger System
12.Build
13.Byte Code
14.Cache
15.Chart
16.Chat
17.Code Analyzer
18.Collaboration
19.Content Management System
20.Database Client
21.Database DBMS
22.Database JDBC Connection Pool
23.Database ORM
24.Development
25.EJB Server
26.ERP CRM Financial
27.ESB
28.Forum
29.Game
30.GIS
31.Graphic 3D
32.Graphic Library
33.Groupware
34.HTML Parser
35.IDE
36.IDE Eclipse
37.IDE Netbeans
38.Installer
39.Internationalization Localization
40.Inversion of Control
41.Issue Tracking
42.J2EE
43.J2ME
44.JBoss
45.JMS
46.JMX
47.Library
48.Mail Clients
49.Music
50.Net
51.Parser
52.PDF
53.Portal
54.Profiler
55.Project Management
56.Report
57.RSS RDF
58.Rule Engine
59.Science
60.Scripting
61.Search Engine
62.Security
63.Sevlet Container
64.Source Control
65.Swing Library
66.Template Engine
67.Test Coverage
68.Testing
69.UML
70.Web Crawler
71.Web Framework
72.Web Mail
73.Web Server
74.Web Services
75.Web Services apache cxf 2.2.6
76.Web Services AXIS2
77.Wiki Engine
78.Workflow Engines
79.XML
80.XML UI
Java Source Code / Java Documentation » 6.0 JDK Core » AWT » java.awt.datatransfer 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   java.awt.datatransfer.Clipboard

Clipboard
public class Clipboard (Code)
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 Clipboard.addFlavorListener ).
See Also:   java.awt.Toolkit.getSystemClipboard
See Also:   java.awt.Toolkit.getSystemSelection
version:
   1.30, 05/05/07
author:
   Amy Fowler
author:
   Alexander Gerasimov



Field Summary
protected  Transferablecontents
    
 Stringname
    
protected  ClipboardOwnerowner
    

Constructor Summary
public  Clipboard(String name)
     Creates a clipboard object.

Method Summary
public synchronized  voidaddFlavorListener(FlavorListener listener)
     Registers the specified FlavorListener to receive FlavorEvents from this clipboard.
public  DataFlavor[]getAvailableDataFlavors()
     Returns an array of DataFlavors in which the current contents of this clipboard can be provided.
public synchronized  TransferablegetContents(Object requestor)
     Returns a transferable object representing the current contents of the clipboard.
public  ObjectgetData(DataFlavor flavor)
     Returns an object representing the current contents of this clipboard in the specified DataFlavor.
public synchronized  FlavorListener[]getFlavorListeners()
     Returns an array of all the FlavorListeners currently registered on this Clipboard.
public  StringgetName()
     Returns the name of this clipboard object.
public  booleanisDataFlavorAvailable(DataFlavor flavor)
     Returns whether or not the current contents of this clipboard can be provided in the specified DataFlavor.
public synchronized  voidremoveFlavorListener(FlavorListener listener)
     Removes the specified FlavorListener so that it no longer receives FlavorEvents from this Clipboard.
public synchronized  voidsetContents(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.


Field Detail
contents
protected Transferable contents(Code)



name
String name(Code)



owner
protected ClipboardOwner owner(Code)




Constructor Detail
Clipboard
public Clipboard(String name)(Code)
Creates a clipboard object.
See Also:   java.awt.Toolkit.getSystemClipboard




Method Detail
addFlavorListener
public synchronized void addFlavorListener(FlavorListener listener)(Code)
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:   Clipboard.removeFlavorListener
See Also:   Clipboard.getFlavorListeners
See Also:   FlavorListener
See Also:   FlavorEvent
since:
   1.5



getAvailableDataFlavors
public DataFlavor[] getAvailableDataFlavors()(Code)
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. an array of DataFlavors in which the currentcontents of this clipboard can be provided
throws:
  IllegalStateException - if this clipboard is currently unavailable
since:
   1.5



getContents
public synchronized Transferable getContents(Object requestor)(Code)
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) the current transferable object on the clipboard
throws:
  IllegalStateException - if the clipboard is currently unavailable
See Also:   java.awt.Toolkit.getSystemClipboard



getData
public Object getData(DataFlavor flavor) throws UnsupportedFlavorException, IOException(Code)
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 an object representing the current contents of this clipboardin the specified DataFlavor
throws:
  NullPointerException - if flavor is null
throws:
  IllegalStateException - if this clipboard is currently unavailable
throws:
  UnsupportedFlavorException - if the requested DataFlavoris not available
throws:
  IOException - if the data in the requested DataFlavorcan not be retrieved
See Also:   DataFlavor.getRepresentationClass
since:
   1.5



getFlavorListeners
public synchronized FlavorListener[] getFlavorListeners()(Code)
Returns an array of all the FlavorListeners currently registered on this Clipboard. all of this clipboard's FlavorListeners or an emptyarray if no listeners are currently registered
See Also:   Clipboard.addFlavorListener
See Also:   Clipboard.removeFlavorListener
See Also:   FlavorListener
See Also:   FlavorEvent
since:
   1.5



getName
public String getName()(Code)
Returns the name of this clipboard object.
See Also:   java.awt.Toolkit.getSystemClipboard



isDataFlavorAvailable
public boolean isDataFlavorAvailable(DataFlavor flavor)(Code)
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 true if the current contents of this clipboardcan be provided in the specified DataFlavor;false otherwise
throws:
  NullPointerException - if flavor is null
throws:
  IllegalStateException - if this clipboard is currently unavailable
since:
   1.5



removeFlavorListener
public synchronized void removeFlavorListener(FlavorListener listener)(Code)
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:   Clipboard.addFlavorListener
See Also:   Clipboard.getFlavorListeners
See Also:   FlavorListener
See Also:   FlavorEvent
since:
   1.5



setContents
public synchronized void setContents(Transferable contents, ClipboardOwner owner)(Code)
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 theclipboard content
Parameters:
  owner - the object which owns the clipboard content
throws:
  IllegalStateException - if the clipboard is currently unavailable
See Also:   java.awt.Toolkit.getSystemClipboard




Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.