FileDocCategorySizeDatePackage
AccessibleText.javaAPI DocJava SE 5 API5003Fri Aug 26 14:57:30 BST 2005javax.accessibility

AccessibleText

public interface AccessibleText

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 {@link Accessible}) and then calling the {@link AccessibleContext#getAccessibleText} method of AccessibleContext. If the return value is not null, the object supports this interface.

see
Accessible
see
Accessible#getAccessibleContext
see
AccessibleContext
see
AccessibleContext#getAccessibleText
version
1.13 01/20/98 07:53:43
author
Peter Korn

Fields Summary
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
WORD
Constant used to indicate that the part of the text that should be retrieved is a word.
public static final int
SENTENCE
Constant used to indicate that the part of the text that should be retrieved is a sentence.
Constructors Summary
Methods Summary
public java.lang.StringgetAfterIndex(int part, int index)
Returns the String after a given index.

param
part the CHARACTER, WORD, or SENTENCE to retrieve
param
index an index within the text
return
the letter, word, or sentence

public java.lang.StringgetAtIndex(int part, int index)
Returns the String at a given index.

param
part the CHARACTER, WORD, or SENTENCE to retrieve
param
index an index within the text
return
the letter, word, or sentence

public java.lang.StringgetBeforeIndex(int part, int index)
Returns the String before a given index.

param
part the CHARACTER, WORD, or SENTENCE to retrieve
param
index an index within the text
return
the letter, word, or sentence

public intgetCaretPosition()
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).

return
the zero-based offset of the caret.

public intgetCharCount()
Returns the number of characters (valid indicies)

return
the number of characters

public javax.swing.text.AttributeSetgetCharacterAttribute(int i)
Returns the AttributeSet for a given character at a given index

param
i the zero-based index into the text
return
the AttributeSet of the character

public java.awt.RectanglegetCharacterBounds(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.

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

public intgetIndexAtPoint(java.awt.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.

param
p the Point in local coordinates
return
the zero-based index of the character under Point p; if Point is invalid return -1.

public java.lang.StringgetSelectedText()
Returns the portion of the text that is selected.

return
the String portion of the text that is selected

public intgetSelectionEnd()
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.

return
the index into teh text of the end of the selection

public intgetSelectionStart()
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.

return
the index into the text of the start of the selection