All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface java.awt.accessibility.AccessibleText

public interface AccessibleText

The AccessibleText interface should be implemented by all classes that present text information on the display.

Variable Index

o CHARACTER
o SENTENCE
o WORD

Method Index

o getAfterIndex(int, int)
Return the String after a given index.
o getAtIndex(int, int)
Return the String at a given index.
o getBeforeIndex(int, int)
Return the String before a given index.
o getCaretPosition()
Return the zero-based offset of the caret.
o getCharacterAttribute(int)
Return the AttributeSet for a given character (at a given index)
o getCharacterBounds(int)
Determined the bounding box of the character at the given index into the string.
o getCharCount()
Return the number of characters (valid indicies)
o getIndexAtPoint(Point)
Given a point in local coordinates, return the zero-based index of the character under that Point.
o getSelectedText()
Returns the portion of the text that is selected.
o getSelectionEnd()
Returns the end offset within the selected text.
o getSelectionStart()
Returns the start offset within the selected text.

Variables

o CHARACTER 
public static final int CHARACTER
o WORD 
public static final int WORD
o SENTENCE 
public static final int SENTENCE

Methods

o 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 local coordinates
Returns:
the zero-based index of the character under Point p.
o getCharacterBounds 
public abstract Rectangle getCharacterBounds(int i)
Determined 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 the bounding box
o getCharCount 
public abstract int getCharCount()
Return the number of characters (valid indicies)

Returns:
the number of characters
o getCaretPosition 
public abstract int getCaretPosition()
Return 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.
o getAtIndex 
public abstract String getAtIndex(int part,
                                  int index)
Return 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
o getAfterIndex 
public abstract String getAfterIndex(int part,
                                     int index)
Return 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
o getBeforeIndex 
public abstract String getBeforeIndex(int part,
                                      int index)
Return 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
o 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 of the character
o getSelectionStart 
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:
TextRange
o getSelectionEnd 
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:
SelectionRange
o getSelectedText 
public abstract String getSelectedText()
Returns the portion of the text that is selected.

Returns:
the portion of the text that is selected
All Packages  Class Hierarchy  This Package  Previous  Next  Index
Submit a bug or feature