-
- All Known Implementing Classes:
JEditorPane.AccessibleJEditorPane,JEditorPane.AccessibleJEditorPaneHTML,JEditorPane.JEditorPaneAccessibleHypertextSupport,JPasswordField.AccessibleJPasswordField,JTextArea.AccessibleJTextArea,JTextComponent.AccessibleJTextComponent,JTextField.AccessibleJTextField
public interface AccessibleExtendedTextTheAccessibleExtendedTextinterface contains additional methods not provided by theAccessibleTextinterface.Applications can determine if an object supports the
AccessibleExtendedTextinterface by first obtaining itsAccessibleContext(seeAccessible) and then calling theAccessibleContext.getAccessibleText()method ofAccessibleContext. If the return value is an instance ofAccessibleExtendedText, the object supports this interface.- Since:
- 1.5
- See Also:
Accessible,Accessible.getAccessibleContext(),AccessibleContext,AccessibleContext.getAccessibleText()
-
-
Field Summary
Fields Modifier and Type Field Description static intATTRIBUTE_RUNConstant used to indicate that the part of the text that should be retrieved is contiguous text with the same text attributes.static intLINEConstant used to indicate that the part of the text that should be retrieved is a line of text.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description RectanglegetTextBounds(int startIndex, int endIndex)Returns the bounding rectangle of the text between two indices.StringgetTextRange(int startIndex, int endIndex)Returns the text between two indices.AccessibleTextSequencegetTextSequenceAfter(int part, int index)Returns theAccessibleTextSequenceafter a given index.AccessibleTextSequencegetTextSequenceAt(int part, int index)Returns theAccessibleTextSequenceat a given index.AccessibleTextSequencegetTextSequenceBefore(int part, int index)Returns theAccessibleTextSequencebefore a given index.
-
-
-
Field Detail
-
LINE
static final int LINE
Constant used to indicate that the part of the text that should be retrieved is a line of text.
-
ATTRIBUTE_RUN
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.
-
-
Method Detail
-
getTextRange
String getTextRange(int startIndex, int endIndex)
Returns the text between two indices.- Parameters:
startIndex- the start index in the textendIndex- the end index in the text- Returns:
- the text string if the indices are valid. Otherwise,
nullis returned.
-
getTextSequenceAt
AccessibleTextSequence getTextSequenceAt(int part, int index)
Returns theAccessibleTextSequenceat a given index.- Parameters:
part- theCHARACTER,WORD,SENTENCE,LINEorATTRIBUTE_RUNto retrieveindex- an index within the text- Returns:
- an
AccessibleTextSequencespecifying the text ifpartandindexare valid. Otherwise,nullis returned. - See Also:
AccessibleText.CHARACTER,AccessibleText.WORD,AccessibleText.SENTENCE
-
getTextSequenceAfter
AccessibleTextSequence getTextSequenceAfter(int part, int index)
Returns theAccessibleTextSequenceafter a given index.- Parameters:
part- theCHARACTER,WORD,SENTENCE,LINEorATTRIBUTE_RUNto retrieveindex- an index within the text- Returns:
- an
AccessibleTextSequencespecifying the text ifpartandindexare valid. Otherwise,nullis returned. - See Also:
AccessibleText.CHARACTER,AccessibleText.WORD,AccessibleText.SENTENCE
-
getTextSequenceBefore
AccessibleTextSequence getTextSequenceBefore(int part, int index)
Returns theAccessibleTextSequencebefore a given index.- Parameters:
part- theCHARACTER,WORD,SENTENCE,LINEorATTRIBUTE_RUNto retrieveindex- an index within the text- Returns:
- an
AccessibleTextSequencespecifying the text ifpartandindexare valid. Otherwise,nullis returned. - See Also:
AccessibleText.CHARACTER,AccessibleText.WORD,AccessibleText.SENTENCE
-
getTextBounds
Rectangle getTextBounds(int startIndex, int endIndex)
Returns the bounding rectangle of the text between two indices.- Parameters:
startIndex- the start index in the textendIndex- the end index in the text- Returns:
- the bounding rectangle of the text if the indices are valid.
Otherwise,
nullis returned.
-
-