Source for java.awt.datatransfer.Clipboard

   1: /* Clipboard.java -- Class for transferring data via cut and paste.
   2:    Copyright (C) 1999, 2001 Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: 
  39: package java.awt.datatransfer;
  40: 
  41: /**
  42:  * This class allows data to be transferred using a cut and paste type
  43:  * mechanism.
  44:  *
  45:  * @author Aaron M. Renn (arenn@urbanophile.com)
  46:  */
  47: public class Clipboard
  48: {
  49:   /**
  50:    * The data being transferred.
  51:    */
  52:   protected Transferable contents;
  53: 
  54:   /**
  55:    * The owner of this clipboard.
  56:    */
  57:   protected ClipboardOwner owner;
  58: 
  59:   // The clipboard name
  60:   private String name;
  61: 
  62:   /**
  63:    * Initializes a new instance of <code>Clipboard</code> with the
  64:    * specified name.
  65:    *
  66:    * @param name The clipboard name.
  67:    */
  68:   public Clipboard(String name)
  69:   {
  70:     this.name = name;
  71:   }
  72: 
  73:   /**
  74:     * Returns the name of the clipboard.
  75:     */
  76:   public String getName()
  77:   {
  78:     return name;
  79:   }
  80: 
  81:   /**
  82:    * Returns the contents of the clipboard.
  83:    *
  84:    * @param requestor The object requesting the contents.
  85:    *
  86:    * @exception IllegalStateException If the clipboard is currently unavailable
  87:    */
  88:   public synchronized Transferable getContents(Object requestor)
  89:   {
  90:     return contents;
  91:   }
  92: 
  93:   /**
  94:    * Sets the content and owner of this clipboard.
  95:    * If the given owner is different from the current owner
  96:    * then lostOwnership is called on the current owner.
  97:    * XXX - is this called with the old or new contents.
  98:    *
  99:    * @param contents The new clipboard contents.
 100:    * @param owner The new clipboard owner
 101:    *
 102:    * @exception IllegalStateException If the clipboard is currently unavailable
 103:    */
 104:   public synchronized void setContents(Transferable contents, ClipboardOwner owner)
 105:   {
 106:     if (this.owner != owner)
 107:       if (this.owner != null)
 108:         this.owner.lostOwnership(this, contents);
 109:  
 110:     this.owner = owner;
 111:     this.contents = contents;
 112:   }
 113: }