javax.accessibility

Interface AccessibleText

Known Subinterfaces:: AccessibleEditableText, AccessibleHypertext

public interface AccessibleText

Objects which present textual information on the display should implement this interface. Accessibility software can use the implementations of this interface to change the attributes and spacial location of the text.

The AccessibleContext.getAccessibleText() method should return null if an object does not implement this interface.

Since:: 1.2

See Also:: Accessible, AccessibleContext, AccessibleContext.getAccessibleText()

Field Summary
`static int`	`CHARACTER` Constant designating that the next selection should be a character.
`static int`	`SENTENCE` Constant designating that the next selection should be a sentence.
`static int`	`WORD` Constant designating that the next selection should be a word.

Method Summary
`String`	`getAfterIndex(int part, int index)` Returns the section of text after the index, or null if the index or part is invalid.
`String`	`getAtIndex(int part, int index)` Returns the section of text at the index, or null if the index or part is invalid.
`String`	`getBeforeIndex(int part, int index)` Returns the section of text before the index, or null if the index or part is invalid.
`int`	`getCaretPosition()` Return the offset of the character.
`int`	`getCharCount()` Return the number of characters.
`AttributeSet`	`getCharacterAttribute(int index)` Returns the attributes of a character at an index, or null if the index is out of bounds.
`Rectangle`	`getCharacterBounds(int index)` Determines the bounding box of the indexed character.
`int`	`getIndexAtPoint(Point point)` Given a point in the coordinate system of this object, return the 0-based index of the character at that point, or -1 if there is none.
`String`	`getSelectedText()` Returns the selected text.
`int`	`getSelectionEnd()` Returns the end index of the selection.
`int`	`getSelectionStart()` Returns the start index of the selection.

CHARACTER

public static final int CHARACTER

Constant designating that the next selection should be a character.
Field Value:
1
See Also:
getAtIndex(int,int), getAfterIndex(int,int), getBeforeIndex(int,int)

SENTENCE

public static final int SENTENCE

Constant designating that the next selection should be a sentence.
Field Value:
3
See Also:
getAtIndex(int,int), getAfterIndex(int,int), getBeforeIndex(int,int)

WORD

public static final int WORD

Constant designating that the next selection should be a word.
Field Value:
2
See Also:
getAtIndex(int,int), getAfterIndex(int,int), getBeforeIndex(int,int)

getAfterIndex

public String getAfterIndex(int part,
                            int index)

Returns the section of text after the index, or null if the index or part is invalid.
Parameters:
part - CHARACTER, WORD, or SENTENCE
index - the 0-based character index
Returns:
the selection of text after that index, or null

getAtIndex

public String getAtIndex(int part,
                         int index)

Returns the section of text at the index, or null if the index or part is invalid.
Parameters:
part - CHARACTER, WORD, or SENTENCE
index - the 0-based character index
Returns:
the selection of text at that index, or null

getBeforeIndex

public String getBeforeIndex(int part,
                             int index)

Returns the section of text before the index, or null if the index or part is invalid.
Parameters:
part - CHARACTER, WORD, or SENTENCE
index - the 0-based character index
Returns:
the selection of text before that index, or null

getCaretPosition

public int getCaretPosition()

Return the offset of the character. The offset matches the index of the character to the right, since the carat lies between characters.
Returns:
the 0-based caret position

getCharCount

public int getCharCount()

Return the number of characters.
Returns:
the character count

getCharacterAttribute

public AttributeSet getCharacterAttribute(int index)

Returns the attributes of a character at an index, or null if the index is out of bounds.
Parameters:
index - the 0-based character index
Returns:
the character's attributes

getCharacterBounds

public Rectangle getCharacterBounds(int index)

Determines the bounding box of the indexed character. Returns an empty rectangle if the index is out of bounds.
Parameters:
index - the 0-based character index
Returns:
the bounding box, may be empty

getIndexAtPoint

public int getIndexAtPoint(Point point)

Given a point in the coordinate system of this object, return the 0-based index of the character at that point, or -1 if there is none.
Parameters:
point - the point to look at
Returns:
the character index, or -1

getSelectedText

public String getSelectedText()

Returns the selected text. This may be null or "" if no text is selected.
Returns:
the selected text

getSelectionEnd

public int getSelectionEnd()

Returns the end index of the selection. If there is no selection, this is the same as the caret location.
Returns:
the 0-based character index of the selection end

getSelectionStart

public int getSelectionStart()

Returns the start index of the selection. If there is no selection, this is the same as the caret location.
Returns:
the 0-based character index of the selection start

AccessibleText.java -- aids in accessibly manipulating text Copyright (C) 2000, 2002, 2004, 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.

Overview Package Class Use Source Tree Index Deprecated About	GNU Classpath (0.95)
Prev Class \| Next Class	GNU Classpath (0.95)	Frames \| No Frames
Summary: Nested \| Field \| Method \| Constr	Detail: Nested \| Field \| Method \| Constr