OpenJDK 27 · javax.accessibility.AccessibleText · APIdia, the JavaDoc alternative

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 AccessibleContext#getAccessibleText method of AccessibleContext. If the return value is not null, the object supports this interface.

Field Summary

Modifier and Type	Field and Description
public static final int	CHARACTER Constant used to indicate that the part of the text that should be retrieved is a character.
public static final int	SENTENCE Constant used to indicate that the part of the text that should be retrieved is a sentence.
public static final int	WORD Constant used to indicate that the part of the text that should be retrieved is a word.

Method Summary

Modifier and Type	Method and Description
public String	Returns: the letter, word, or sentence getAfterIndex(int the CHARACTER, WORD, or SENTENCE to retrieve part, int an index within the text index) Returns the `String` after a given index.
public String	Returns: the letter, word, or sentence getAtIndex(int the CHARACTER, WORD, or SENTENCE to retrieve part, int an index within the text index) Returns the `String` at a given index.
public String	Returns: the letter, word, or sentence getBeforeIndex(int the CHARACTER, WORD, or SENTENCE to retrieve part, int an index within the text index) Returns the `String` before a given index.
public int	Returns: the zero-based offset of the caret getCaretPosition() Returns the zero-based offset of the caret.
public AttributeSet	Returns: the `AttributeSet` of the character getCharacterAttribute(int the zero-based index into the text i) Returns the `AttributeSet` for a given character at a given index.
public Rectangle	Returns: the screen coordinates of the character's bounding box, if index is invalid return an empty rectangle. getCharacterBounds(int the index into the string i) Determines the bounding box of the character at the given index into the string.
public int	Returns: the number of characters getCharCount() Returns the number of characters (valid indices).
public int	Returns: the zero-based index of the character under `Point p`; if point is invalid return -1. getIndexAtPoint(Point the point in local coordinates p) Given a point in local coordinates, return the zero-based index of the character under that point.
public String	Returns: the `String` portion of the text that is selected getSelectedText() Returns the portion of the text that is selected.
public int	Returns: the index into the text of the end of the selection getSelectionEnd() Returns the end offset within the selected text.
public int	Returns: the index into the text of the start of the selection getSelectionStart() Returns the start offset within the selected text.

Field Detail

CHARACTER back to summary

CHARACTER	back to summary
public static final int CHARACTER Constant used to indicate that the part of the text that should be retrieved is a character. See Also `getAtIndex`, `getAfterIndex`, `getBeforeIndex`

public static final int CHARACTER

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

See Also: getAtIndex, getAfterIndex, getBeforeIndex

SENTENCE back to summary

SENTENCE	back to summary
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 `getAtIndex`, `getAfterIndex`, `getBeforeIndex`

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: getAtIndex, getAfterIndex, getBeforeIndex

WORD back to summary

WORD	back to summary
public static final int WORD Constant used to indicate that the part of the text that should be retrieved is a word. See Also `getAtIndex`, `getAfterIndex`, `getBeforeIndex`

public static final int WORD

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

See Also: getAtIndex, getAfterIndex, getBeforeIndex

Method Detail

getAfterIndex back to summary

getAfterIndex	back to summary
public String getAfterIndex(int part, int index) Returns the `String` after a given index. Parameters part:int the CHARACTER, WORD, or SENTENCE to retrieve index:int an index within the text Returns:String the letter, word, or sentence

public String getAfterIndex(int part, int index)

Returns the String after a given index.

Parameters

part:int: the CHARACTER, WORD, or SENTENCE to retrieve
index:int: an index within the text

Returns:String

the letter, word, or sentence

getAtIndex back to summary

getAtIndex	back to summary
public String getAtIndex(int part, int index) Returns the `String` at a given index. Parameters part:int the CHARACTER, WORD, or SENTENCE to retrieve index:int an index within the text Returns:String the letter, word, or sentence

public String getAtIndex(int part, int index)

Returns the String at a given index.

Parameters

part:int: the CHARACTER, WORD, or SENTENCE to retrieve
index:int: an index within the text

Returns:String

the letter, word, or sentence

getBeforeIndex back to summary

getBeforeIndex	back to summary
public String getBeforeIndex(int part, int index) Returns the `String` before a given index. Parameters part:int the CHARACTER, WORD, or SENTENCE to retrieve index:int an index within the text Returns:String the letter, word, or sentence

public String getBeforeIndex(int part, int index)

Returns the String before a given index.

Parameters

part:int: the CHARACTER, WORD, or SENTENCE to retrieve
index:int: an index within the text

Returns:String

the letter, word, or sentence

getCaretPosition	back to summary
public 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:int the zero-based offset of the caret

getCaretPosition

back to summary

public 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:int: the zero-based offset of the caret

getCharacterAttribute back to summary

getCharacterAttribute	back to summary
public AttributeSet getCharacterAttribute(int i) Returns the `AttributeSet` for a given character at a given index. Parameters i:int the zero-based index into the text Returns:AttributeSet the `AttributeSet` of the character

public AttributeSet getCharacterAttribute(int i)

Returns the AttributeSet for a given character at a given index.

Parameters

i:int: the zero-based index into the text

Returns:AttributeSet

the AttributeSet of the character

getCharacterBounds	back to summary
public 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:int the index into the string Returns:Rectangle the screen coordinates of the character's bounding box, if index is invalid return an empty rectangle.

getCharacterBounds

back to summary

public 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:int: the index into the string

Returns:Rectangle

the screen coordinates of the character's bounding box, if index is invalid return an empty rectangle.

getCharCount	back to summary
public int getCharCount() Returns the number of characters (valid indices). Returns:int the number of characters

getCharCount

back to summary

public int getCharCount()

Returns the number of characters (valid indices).

Returns:int: the number of characters

getIndexAtPoint back to summary

getIndexAtPoint	back to summary
public 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:Point the point in local coordinates Returns:int the zero-based index of the character under `Point p`; if point is invalid return -1.

public 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:Point: the point in local coordinates

Returns:int

the zero-based index of the character under Point p; if point is invalid return -1.

getSelectedText back to summary

getSelectedText	back to summary
public String getSelectedText() Returns the portion of the text that is selected. Returns:String the `String` portion of the text that is selected

public String getSelectedText()

Returns the portion of the text that is selected.

Returns:String: the String portion of the text that is selected

getSelectionEnd	back to summary
public 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:int the index into the text of the end of the selection

getSelectionEnd

back to summary

public 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:int: the index into the text of the end of the selection

getSelectionStart	back to summary
public 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:int the index into the text of the start of the selection

getSelectionStart

back to summary

public 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:int: the index into the text of the start of the selection

public Interface AccessibleText

Field Summary

Method Summary

Field Detail

Method Detail