Index (Frames) | Index (No Frames) | Package | Package Tree | Tree
javax.accessibility

Interface AccessibleText

java.lang.Object
|
+--javax.accessibility.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:Author:See Also:

Method Summary

java.lang.StringgetAfterIndex(int part, int index)

Returns the section of text after the index, or null if the index or part is invalid.
java.lang.StringgetAtIndex(int part, int index)

Returns the section of text at the index, or null if the index or part is invalid.
java.lang.StringgetBeforeIndex(int part, int index)

Returns the section of text before the index, or null if the index or part is invalid.
intgetCaretPosition()

Return the offset of the character.
intgetCharCount()

Return the number of characters.
javax.swing.text.AttributeSetgetCharacterAttribute(int index)

Returns the attributes of a character at an index, or null if the index is out of bounds.
java.awt.RectanglegetCharacterBounds(int index)

Determines the bounding box of the indexed character.
intgetIndexAtPoint(java.awt.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.
java.lang.StringgetSelectedText()

Returns the selected text.
intgetSelectionEnd()

Returns the end index of the selection.
intgetSelectionStart()

Returns the start index of the selection.

Method Details

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:

Returns:


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:

Returns:


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:

Returns:


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:


getCharCount

public int getCharCount()

Return the number of characters.

Returns:


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:

Returns:


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:

Returns:


getIndexAtPoint

public int getIndexAtPoint(java.awt.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:

Returns:


getSelectedText

public String getSelectedText()

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

Returns:


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:


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: