libjava/javax/accessibility/AccessibleEditableText.java

   1 /* AccessibleEditableText.java -- aids in accessibly for editable text
   2    Copyright (C) 2002, 2005  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 package javax.accessibility;
  39
  40 import javax.swing.text.AttributeSet;
  41
  42 /**
  43  * Objects which present editable textual information on the display should
  44  * implement this interface.  Accessibility software can use the
  45  * implementations of this interface to change the content, attributes,
  46  * and spacial location of the text.
  47  *
  48  * <p>The <code>AccessibleContext.getAccessibleEditableText()</code> method
  49  * should return <code>null</code> if an object does not implement this
  50  * interface.
  51  *
  52  * @author Eric Blake (ebb9@email.byu.edu)
  53  * @see Accessible
  54  * @see AccessibleContext
  55  * @see AccessibleContext#getAccessibleText()
  56  * @see AccessibleContext#getAccessibleEditableText()
  57  * @since 1.2
  58  * @status updated to 1.4, except for javax.swing support
  59  */
  60 public interface AccessibleEditableText extends AccessibleText
  61 {
  62   /**
  63    * Set the text contents to the given string.
  64    *
  65    * @param s the new text
  66    */
  67   // XXX What happens if s is null?
  68   void setTextContents(String s);
  69
  70   /**
  71    * Inserts the given string at the specified location.
  72    *
  73    * @param index the index for insertion
  74    * @param s the new text
  75    */
  76   // XXX What happens if index is out of bounds, or s is null?
  77   void insertTextAtIndex(int index, String s);
  78
  79   /**
  80    * Return the text between two points.
  81    *
  82    * @param start the start position, inclusive
  83    * @param end the end position, exclusive
  84    */
  85   // XXX What happens if indices are out of bounds?
  86   String getTextRange(int start, int end);
  87
  88   /**
  89    * Delete the text between two points.
  90    *
  91    * @param start the start position, inclusive
  92    * @param end the end position, exclusive
  93    */
  94   // XXX What happens if indices are out of bounds?
  95   void delete(int start, int end);
  96
  97   /**
  98    * Cut the text between two points to the system clipboard.
  99    *
 100    * @param start the start position, inclusive
 101    * @param end the end position, exclusive
 102    */
 103   // XXX What happens if indices are out of bounds?
 104   void cut(int start, int end);
 105
 106   /**
 107    * Paste the text from the system clipboard at the given index.
 108    *
 109    * @param start the start position
 110    */
 111   // XXX What happens if start is out of bounds?
 112   void paste(int start);
 113
 114   /**
 115    * Replace the text between two points with the given string.
 116    *
 117    * @param start the start position, inclusive
 118    * @param end the end position, exclusive
 119    * @param s the string to paste
 120    */
 121   // XXX What happens if indices are out of bounds, or s is null?
 122   void replaceText(int start, int end, String s);
 123
 124   /**
 125    * Select the text between two points.
 126    *
 127    * @param start the start position, inclusive
 128    * @param end the end position, exclusive
 129    */
 130   // XXX What happens if indices are out of bounds?
 131   void selectText(int start, int stop);
 132
 133   /**
 134    * Set the attributes of text between two points.
 135    *
 136    * @param start the start position, inclusive
 137    * @param end the end position, exclusive
 138    * @param s the new attribute set for the range
 139    */
 140   // XXX What happens if indices are out of bounds, or s is null?
 141   void setAttributes(int start, int end, AttributeSet s);
 142 } // interface AccessibleEditableText