All Packages Class Hierarchy This Package Previous Next Index
Interface com.sun.java.accessibility.AccessibleText
- public interface AccessibleText
The AccessibleText interface should be implemented by all
classes that present text information on the display.
This minimal interface allows an assistive technology to obtain
character, word, sentence, attribute, and selection information
about a text object.
NOTE: This is a preliminary draft. The methods and name may change
in future beta releases.
-
CHARACTER
-
-
SENTENCE
-
-
WORD
-
-
getAfterIndex(int, int)
- Return the object after a given index.
-
getAtIndex(int, int)
- Return the object at a given index.
-
getBeforeIndex(int, int)
- Return the object before a given index.
-
getCaretPosition()
- Return the zero-based offset of the caret.
-
getCharacterAttribute(int)
- Return the AttributeSet for a given character (at a given index)
-
getCharacterBounds(int)
- Given an index into the String, determine the bounding box of
the character at that index.
-
getCharCount()
- Return the number of characters (valid indicies)
-
getIndexAtPoint(Point)
- Given a point in local coordinates, return the zero-based index
of the character under that Point.
-
getSelectedText()
- Returns the portion of the text that is selected.
-
getSelectionEnd()
- Returns the end offset within the text of
of the selection.
-
getSelectionStart()
- Returns the start offset within the text of
of the selection.
CHARACTER
public static final int CHARACTER
WORD
public static final int WORD
SENTENCE
public static final int SENTENCE
getIndexAtPoint
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 screen coordinates
- Returns:
- the zero-based index of the character under Point p.
getCharacterBounds
public abstract Rectangle getCharacterBounds(int i)
- Given an index into the String, determine the bounding box of
the character at that index. The bounds are returned in local
coordinates. If the index is invalid, returns an empty rectangle.
- Parameters:
- i - the index into the String
- Returns:
- the bounding box, in screen coordinates, of the character
getCharCount
public abstract int getCharCount()
- Return the number of characters (valid indicies)
- Returns:
- the number of characters
getCaretPosition
public abstract int getCaretPosition()
- Return the zero-based offset of the caret.
Note: the 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.
getAtIndex
public abstract Object getAtIndex(int chunk,
int index)
- Return the object at a given index. Use instanceof() to
determine whether this is a String (common), or either an
Accessible, or an inaccessible Object.
- Parameters:
- chunk - the letter, word, or sentence to retrieve
- index - an index within the text
- Returns:
- the letter
getAfterIndex
public abstract Object getAfterIndex(int chunk,
int index)
- Return the object after a given index. Use instanceof() to
determine whether this is a String (common), or either an
Accessible, or an inaccessible Object.
- Parameters:
- chunk - the letter, word, or sentence to retrieve
- index - an index within the text
- Returns:
- the letter
getBeforeIndex
public abstract Object getBeforeIndex(int chunk,
int index)
- Return the object before a given index. Use instanceof() to
determine whether this is a String (common), or either an
Accessible, or an inaccessible Object.
- Parameters:
- chunk - the letter, word, or sentence to retrieve
- index - an index within the text
- Returns:
- the letter
getCharacterAttribute
public abstract AttributeSet getCharacterAttribute(int i)
- Return the AttributeSet for a given character (at a given index)
- Parameters:
- i - the zero-based index into the text
- Returns:
- the AttributeSet
getSelectionStart
public abstract int getSelectionStart()
- Returns the start offset within the text of
of the selection. If there is no selection, but there is
a caret, the start and end offsets will be the same.
- Returns:
- TextRange
getSelectionEnd
public abstract int getSelectionEnd()
- Returns the end offset within the text of
of the selection. If there is no selection, but there is
a caret, the start and end offsets will be the same.
- Returns:
- SelectionRange
getSelectedText
public abstract String getSelectedText()
- Returns the portion of the text that is selected. Use instanceof()
to determine whether this is a String (common), or either an
Accessible, or an inaccessible Object. If the portion of the
text that is selected includes both String text and embedded
objects, only the String text will be returned.
- Returns:
- the portion of the text that is selected
All Packages Class Hierarchy This Package Previous Next Index