001/* AccessibleExtendedText.java 002 Copyright (C) 2006 Free Software Foundation, Inc. 003 004This file is part of GNU Classpath. 005 006GNU Classpath is free software; you can redistribute it and/or modify 007it under the terms of the GNU General Public License as published by 008the Free Software Foundation; either version 2, or (at your option) 009any later version. 010 011GNU Classpath is distributed in the hope that it will be useful, but 012WITHOUT ANY WARRANTY; without even the implied warranty of 013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 014General Public License for more details. 015 016You should have received a copy of the GNU General Public License 017along with GNU Classpath; see the file COPYING. If not, write to the 018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 01902110-1301 USA. 020 021Linking this library statically or dynamically with other modules is 022making a combined work based on this library. Thus, the terms and 023conditions of the GNU General Public License cover the whole 024combination. 025 026As a special exception, the copyright holders of this library give you 027permission to link this library with independent modules to produce an 028executable, regardless of the license terms of these independent 029modules, and to copy and distribute the resulting executable under 030terms of your choice, provided that you also meet, for each linked 031independent module, the terms and conditions of the license of that 032module. An independent module is a module which is not derived from 033or based on this library. If you modify this library, you may extend 034this exception to your version of the library, but you are not 035obligated to do so. If you do not wish to do so, delete this 036exception statement from your version. */ 037 038 039package javax.accessibility; 040 041import java.awt.Rectangle; 042 043/** 044 * This interface provides extended text functionality, similar 045 * to AccessibleText. 046 * @see AccessibleText 047 * @since 1.5 048 */ 049public interface AccessibleExtendedText 050{ 051 /** 052 * This constant indicates that the retrieved text should be a 053 * complete line. 054 */ 055 int LINE = 4; 056 057 /** 058 * This constant indicates that the retrieved text should consist 059 * of a run with identical attributes. 060 */ 061 int ATTRIBUTE_RUN = 5; 062 063 /** 064 * Determines the bounding box of some text held by this object. 065 * @param start the starting index 066 * @param end the ending index 067 * @return the bounding box 068 * @see AccessibleText#getCharacterBounds(int) 069 */ 070 Rectangle getTextBounds(int start, int end); 071 072 /** 073 * Return a range of text from the underlying object. 074 * @param start the starting index 075 * @param end the ending index 076 */ 077 String getTextRange(int start, int end); 078 079 /** 080 * Return a text sequence from the underlying object. The part 081 * parameter describes the type of sequence to return; it is one 082 * of the constants from {@link AccessibleText} or from this 083 * class. 084 * @param part the type of the sequence to return 085 * @param index start of the sequence 086 */ 087 AccessibleTextSequence getTextSequenceAfter(int part, int index); 088 089 /** 090 * Return a text sequence from the underlying object. The part 091 * parameter describes the type of sequence to return; it is one 092 * of the constants from {@link AccessibleText} or from this 093 * class. 094 * @param part the type of the sequence to return 095 * @param index start of the sequence 096 */ 097 AccessibleTextSequence getTextSequenceAt(int part, int index); 098 099 /** 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}