Source for javax.accessibility.AccessibleExtendedText

   1: /* AccessibleExtendedText.java
   2:    Copyright (C) 2006 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 javax.accessibility;
  40: 
  41: import java.awt.Rectangle;
  42: 
  43: /**
  44:  * This interface provides extended text functionality, similar
  45:  * to AccessibleText.
  46:  * @see AccessibleText
  47:  * @since 1.5
  48:  */
  49: public interface AccessibleExtendedText
  50: {
  51:   /**
  52:    * This constant indicates that the retrieved text should be a
  53:    * complete line.
  54:    */
  55:   int LINE = 4;
  56: 
  57:   /**
  58:    * This constant indicates that the retrieved text should consist
  59:    * of a run with identical attributes. 
  60:    */
  61:   int ATTRIBUTE_RUN = 5;
  62: 
  63:   /**
  64:    * Determines the bounding box of some text held by this object.
  65:    * @param start the starting index
  66:    * @param end the ending index
  67:    * @return the bounding box
  68:    * @see AccessibleText#getCharacterBounds(int)
  69:    */
  70:   Rectangle getTextBounds(int start, int end);
  71: 
  72:   /**
  73:    * Return a range of text from the underlying object.
  74:    * @param start the starting index
  75:    * @param end the ending index
  76:    */
  77:   String getTextRange(int start, int end);
  78: 
  79:   /**
  80:    * Return a text sequence from the underlying object.  The part
  81:    * parameter describes the type of sequence to return; it is one
  82:    * of the constants from {@link AccessibleText} or from this
  83:    * class.
  84:    * @param part the type of the sequence to return 
  85:    * @param index start of the sequence
  86:    */
  87:   AccessibleTextSequence getTextSequenceAfter(int part, int index);
  88: 
  89:   /**
  90:    * Return a text sequence from the underlying object.  The part
  91:    * parameter describes the type of sequence to return; it is one
  92:    * of the constants from {@link AccessibleText} or from this
  93:    * class.
  94:    * @param part the type of the sequence to return 
  95:    * @param index start of the sequence
  96:    */
  97:   AccessibleTextSequence getTextSequenceAt(int part, int index);
  98: 
  99:   /**
 100:    * Return a text sequence from the underlying object.  The part
 101:    * parameter describes the type of sequence to return; it is one
 102:    * of the constants from {@link AccessibleText} or from this
 103:    * class.
 104:    * @param part the type of the sequence to return 
 105:    * @param index end of the sequence
 106:    */
 107:   AccessibleTextSequence getTextSequenceBefore(int part, int index);
 108: }