libjava/java/awt/datatransfer/StringSelection.java

   1 /* StringSelection.java -- Clipboard handler for text.
   2    Copyright (C) 1999 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.StringBufferInputStream;
  42 import java.io.IOException;
  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 public static final DataFlavor[] supported_flavors
  58    = { DataFlavor.plainTextFlavor };
  59
  60 /*************************************************************************/
  61
  62 /*
  63  * Instance Variables
  64  */
  65
  66 // This is the data to transfer
  67 private String data;
  68
  69 /*************************************************************************/
  70
  71 /*
  72  * Constructors
  73  */
  74
  75 /**
  76   * Transfer the specfied string as text.
  77   */
  78 public
  79 StringSelection(String data)
  80 {
  81   this.data = data;
  82 }
  83
  84 /*************************************************************************/
  85
  86 /*
  87  * Instance Methods
  88  */
  89
  90 /**
  91   * Returns a list of supported data flavors.
  92   *
  93   * @return A list of supported data flavors.
  94   */
  95 public DataFlavor[]
  96 getTransferDataFlavors()
  97 {
  98   return(supported_flavors);
  99 }
 100
 101 /*************************************************************************/
 102
 103 /**
 104   * Tests whether or not the specified data flavor is supported.
 105   *
 106   * @param flavor The data flavor to test.
 107   *
 108   * @return <code>true</code> if the data flavor is supported,
 109   * <code>false</code> otherwise.
 110   */
 111 public boolean
 112 isDataFlavorSupported(DataFlavor flavor)
 113 {
 114   for (int i = 0; i < supported_flavors.length; i++)
 115     if (supported_flavors[i].equals(flavor))
 116        return(true);
 117
 118   return(false);
 119 }
 120
 121 /*************************************************************************/
 122
 123 /**
 124   * This method returns the data in the requested format.
 125   *
 126   * @param flavor The desired data flavor.
 127   *
 128   * @return The transferred data.
 129   *
 130   * @exception UnsupportedFlavorException If the specified flavor is not
 131   * supported.
 132   * @exception IOException If any other error occurs.
 133   */
 134 public Object
 135 getTransferData(DataFlavor flavor) throws UnsupportedFlavorException,
 136                                           IOException
 137 {
 138   if (!isDataFlavorSupported(flavor))
 139     throw new UnsupportedFlavorException(flavor);
 140
 141   return(new StringBufferInputStream(data));
 142 }
 143
 144 /*************************************************************************/
 145
 146 /**
 147   * Called when ownership of the clipboard object is lost.
 148   *
 149   * @param clipboard The affected clipboard.
 150   * @param contents The clipboard contents.
 151   */
 152 public void
 153 lostOwnership(Clipboard clipboard, Transferable contents)
 154 {
 155   // FIXME: What does this do?
 156 }
 157
 158 } // class StringSelection
 159