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.

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)
Given an index into the String, determine the bounding box of the character at that index.
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 text of of the selection.
o getSelectionStart()
Returns the start offset within the text of of the selection.

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 screen coordinates
Returns:
the zero-based index of the character under Point p.
o 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
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: 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.
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
o 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
o 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
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