FileDocCategorySizeDatePackage
AccessibleExtendedText.javaAPI DocJava SE 6 API4395Tue Jun 10 00:26:02 BST 2008javax.accessibility

AccessibleExtendedText

public interface AccessibleExtendedText

The AccessibleExtendedText interface contains additional methods not provided by the AccessibleText interface Applications can determine if an object supports the AccessibleExtendedText interface by first obtaining its AccessibleContext (see {@link Accessible}) and then calling the {@link AccessibleContext#getAccessibleText} method of AccessibleContext. If the return value is an instance of AccessibleExtendedText, the object supports this interface.

see
Accessible
see
Accessible#getAccessibleContext
see
AccessibleContext
see
AccessibleContext#getAccessibleText
see
AccessibleText.AccessibleTextChunk
version
1.5 04/07/06
author
Peter Korn
author
Lynn Monsanto
since
1.5

Fields Summary
public static final int
LINE
Constant used to indicate that the part of the text that should be retrieved is a line of text.
public static final int
ATTRIBUTE_RUN
Constant used to indicate that the part of the text that should be retrieved is contiguous text with the same text attributes.
Constructors Summary
Methods Summary
public java.awt.RectanglegetTextBounds(int startIndex, int endIndex)
Returns the bounding rectangle of the text between two indices.

param
startIndex the start index in the text
param
endIndex the end index in the text
return
the bounding rectangle of the text if the indices are valid. Otherwise, null is returned.

public java.lang.StringgetTextRange(int startIndex, int endIndex)
Returns the text between two indices
param
startIndex the start index in the text
param
endIndex the end index in the text
return
the text string if the indices are valid.
Otherwise, null is returned.
public javax.accessibility.AccessibleTextSequencegetTextSequenceAfter(int part, int index)
Returns the AccessibleTextSequence after a given index.
param
part the CHARACTER, WORD,
SENTENCE, LINE or ATTRIBUTE_RUN
to retrieve
param
index an index within the text
return
an AccessibleTextSequence specifying the text
if part and index are valid. Otherwise, null is returned.
see
AccessibleText#CHARACTER
see
AccessibleText#WORD
see
AccessibleText#SENTENCE
public javax.accessibility.AccessibleTextSequencegetTextSequenceAt(int part, int index)
Returns the AccessibleTextSequence at a given index.
param
part the CHARACTER, WORD,
SENTENCE, LINE or ATTRIBUTE_RUN
to retrieve
param
index an index within the text
return
an AccessibleTextSequence specifying the text
if part and index are valid. Otherwise, null is returned.
see
AccessibleText#CHARACTER
see
AccessibleText#WORD
see
AccessibleText#SENTENCE
public javax.accessibility.AccessibleTextSequencegetTextSequenceBefore(int part, int index)
Returns the AccessibleTextSequence before a given index.
param
part the CHARACTER, WORD,
SENTENCE, LINE or ATTRIBUTE_RUN
to retrieve
param
index an index within the text
return
an AccessibleTextSequence specifying the text
if part and index are valid. Otherwise, null is returned.
see
AccessibleText#CHARACTER
see
AccessibleText#WORD
see
AccessibleText#SENTENCE