libjava/java/awt/datatransfer/StringSelection.java

   1 /* StringSelection.java -- Clipboard handler for text.
   2    Copyright (C) 1999, 2004  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., 59 Temple Place, Suite 330, Boston, MA
  19 02111-1307 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 import java.io.IOException;
  42 import java.io.StringReader;
  43
  44 /**
  45   * This class transfers a string as plain text using the clipboard.
  46   *
  47   * @author Aaron M. Renn (arenn@urbanophile.com)
  48   */
  49 public class StringSelection implements Transferable, ClipboardOwner
  50 {
  51
  52 /*
  53  * Class Variables
  54  */
  55
  56 // List of flavors we support
  57 // XXX: DataFlavor.plainTextFlavor is deprecated.
  58 static final DataFlavor[] supported_flavors
  59    = { DataFlavor.stringFlavor,
  60        DataFlavor.plainTextFlavor };
  61
  62 /*************************************************************************/
  63
  64 /*
  65  * Instance Variables
  66  */
  67
  68 // This is the data to transfer
  69 private String data;
  70
  71   /**
  72    * Transfer the specfied string as text.
  73    *
  74    * @param data the data for the string selection
  75    */
  76   public StringSelection(String data)
  77   {
  78     this.data = data;
  79   }
  80
  81 /**
  82   * Returns a list of supported data flavors.
  83   *
  84   * @return A list of supported data flavors.
  85   */
  86 public DataFlavor[]
  87 getTransferDataFlavors()
  88 {
  89   return(supported_flavors);
  90 }
  91
  92 /*************************************************************************/
  93
  94 /**
  95   * Tests whether or not the specified data flavor is supported.
  96   *
  97   * @param flavor The data flavor to test.
  98   *
  99   * @return <code>true</code> if the data flavor is supported,
 100   * <code>false</code> otherwise.
 101   */
 102 public boolean
 103 isDataFlavorSupported(DataFlavor flavor)
 104 {
 105   for (int i = 0; i < supported_flavors.length; i++)
 106     if (supported_flavors[i].equals(flavor))
 107        return(true);
 108
 109   return(false);
 110 }
 111
 112 /*************************************************************************/
 113
 114 /**
 115   * This method returns the data in the requested format.
 116   *
 117   * @param flavor The desired data flavor.
 118   *
 119   * @return The transferred data.
 120   *
 121   * @exception UnsupportedFlavorException If the specified flavor is not
 122   * supported.
 123   * @exception IOException If any other error occurs.
 124   */
 125 public Object
 126 getTransferData(DataFlavor flavor) throws UnsupportedFlavorException,
 127                                           IOException
 128 {
 129   if (!isDataFlavorSupported(flavor))
 130     throw new UnsupportedFlavorException(flavor);
 131
 132   if (DataFlavor.plainTextFlavor == flavor)
 133       /* The behavior of this method for DataFlavor.plainTextFlavor and
 134          equivalent DataFlavors is inconsistent with the definition of
 135          DataFlavor.plainTextFlavor. We choose to do like Sun's implementation
 136          and return a Reader instead of an InputString. */
 137       /* return(new StringBufferInputStream(data)); */
 138       return(new StringReader(data));
 139   else // DataFlavor.stringFlavor
 140       return data;
 141 }
 142
 143 /*************************************************************************/
 144
 145 /**
 146   * Called when ownership of the clipboard object is lost.
 147   *
 148   * @param clipboard The affected clipboard.
 149   * @param contents The clipboard contents.
 150   */
 151 public void
 152 lostOwnership(Clipboard clipboard, Transferable contents)
 153 {
 154   // FIXME: What does this do?
 155 }
 156
 157 } // class StringSelection
 158