javax.accessibility

Interface AccessibleText

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

UNKNOWN: updated to 1.4

Field Summary
int	CHARACTER Constant designating that the next selection should be a character.
int	SENTENCE Constant designating that the next selection should be a sentence.
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.
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	getCharCount() Return the number of characters.
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.

Field Detail

CHARACTER

public int CHARACTER

Constant designating that the next selection should be a character.

SENTENCE

public int SENTENCE

Constant designating that the next selection should be a sentence.

WORD

public int WORD

Constant designating that the next selection should be a word.

Method Detail

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 {@link #CHARACTER}, {@link #WORD}, or {@link #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 {@link #CHARACTER}, {@link #WORD}, or {@link #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 {@link #CHARACTER}, {@link #WORD}, or {@link #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

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

getCharCount

public int getCharCount()

Return the number of characters.

Returns: the character count

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