public interface

AccessibleText

javax.accessibility.AccessibleText
Known Indirect Subclasses

Class Overview

The AccessibleText interface should be implemented by all classes that present textual information on the display. This interface provides the standard mechanism for an assistive technology to access that text via its content, attributes, and spatial location. Applications can determine if an object supports the AccessibleText interface by first obtaining its AccessibleContext (see Accessible) and then calling the getAccessibleText() method of AccessibleContext. If the return value is not null, the object supports this interface.

See Also

Summary

Constants
int CHARACTER Constant used to indicate that the part of the text that should be retrieved is a character.
int SENTENCE Constant used to indicate that the part of the text that should be retrieved is a sentence.
int WORD Constant used to indicate that the part of the text that should be retrieved is a word.
Public Methods
abstract String getAfterIndex(int part, int index)
Returns the String after a given index.
abstract String getAtIndex(int part, int index)
Returns the String at a given index.
abstract String getBeforeIndex(int part, int index)
Returns the String before a given index.
abstract int getCaretPosition()
Returns the zero-based offset of the caret.
abstract int getCharCount()
Returns the number of characters (valid indicies)
abstract AttributeSet getCharacterAttribute(int i)
Returns the AttributeSet for a given character at a given index
abstract Rectangle getCharacterBounds(int i)
Determines the bounding box of the character at the given index into the string.
abstract int getIndexAtPoint(Point p)
Given a point in local coordinates, return the zero-based index of the character under that Point.
abstract String getSelectedText()
Returns the portion of the text that is selected.
abstract int getSelectionEnd()
Returns the end offset within the selected text.
abstract int getSelectionStart()
Returns the start offset within the selected text.

Constants

public static final int CHARACTER

Constant used to indicate that the part of the text that should be retrieved is a character.

See Also
Constant Value: 1 (0x00000001)

public static final int SENTENCE

Constant used to indicate that the part of the text that should be retrieved is a sentence. A sentence is a string of words which expresses an assertion, a question, a command, a wish, an exclamation, or the performance of an action. In English locales, the string usually begins with a capital letter and concludes with appropriate end punctuation; such as a period, question or exclamation mark. Other locales may use different capitalization and/or punctuation.

See Also
Constant Value: 3 (0x00000003)

public static final int WORD

Constant used to indicate that the part of the text that should be retrieved is a word.

See Also
Constant Value: 2 (0x00000002)

Public Methods

public abstract String getAfterIndex (int part, int index)

Returns the String after a given index.

Parameters
part the CHARACTER, WORD, or SENTENCE to retrieve
index an index within the text
Returns
  • the letter, word, or sentence

public abstract String getAtIndex (int part, int index)

Returns the String at a given index.

Parameters
part the CHARACTER, WORD, or SENTENCE to retrieve
index an index within the text
Returns
  • the letter, word, or sentence

public abstract String getBeforeIndex (int part, int index)

Returns the String before a given index.

Parameters
part the CHARACTER, WORD, or SENTENCE to retrieve
index an index within the text
Returns
  • the letter, word, or sentence

public abstract int getCaretPosition ()

Returns the zero-based offset of the caret. Note: That to the right of the caret will have the same index value as the offset (the caret is between two characters).

Returns
  • the zero-based offset of the caret.

public abstract int getCharCount ()

Returns the number of characters (valid indicies)

Returns
  • the number of characters

public abstract AttributeSet getCharacterAttribute (int i)

Returns the AttributeSet for a given character at a given index

Parameters
i the zero-based index into the text
Returns
  • the AttributeSet of the character

public abstract Rectangle getCharacterBounds (int i)

Determines the bounding box of the character at the given index into the string. The bounds are returned in local coordinates. If the index is invalid an empty rectangle is returned.

Parameters
i the index into the String
Returns
  • the screen coordinates of the character's bounding box, if index is invalid return an empty rectangle.

public abstract int getIndexAtPoint (Point p)

Given a point in local coordinates, return the zero-based index of the character under that Point. If the point is invalid, this method returns -1.

Parameters
p the Point in local coordinates
Returns
  • the zero-based index of the character under Point p; if Point is invalid return -1.

public abstract String getSelectedText ()

Returns the portion of the text that is selected.

Returns
  • the String portion of the text that is selected

public abstract int getSelectionEnd ()

Returns the end offset within the selected text. If there is no selection, but there is a caret, the start and end offsets will be the same.

Returns
  • the index into teh text of the end of the selection

public abstract int getSelectionStart ()

Returns the start offset within the selected text. If there is no selection, but there is a caret, the start and end offsets will be the same.

Returns
  • the index into the text of the start of the selection