javax.accessibility
Interface AccessibleExtendedText
-
- All Known Implementing Classes:
- JEditorPane.AccessibleJEditorPane, JEditorPane.AccessibleJEditorPaneHTML, JEditorPane.JEditorPaneAccessibleHypertextSupport, JPasswordField.AccessibleJPasswordField, JTextArea.AccessibleJTextArea, JTextComponent.AccessibleJTextComponent, JTextField.AccessibleJTextField
public interface AccessibleExtendedTextThe 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
Accessible) and then calling theAccessibleContext.getAccessibleText()method of AccessibleContext. If the return value is an instance of AccessibleExtendedText, the object supports this interface.- Since:
- 1.5
- See Also:
-
Accessible,Accessible.getAccessibleContext(),AccessibleContext,AccessibleContext.getAccessibleText()
-
-
Field Summary
Fields Modifier and Type Field and 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 and 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 indicesAccessibleTextSequencegetTextSequenceAfter(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 text -
endIndex- the end index in the text - Returns:
- the text string if the indices are valid. Otherwise, null is returned.
getTextSequenceAt
AccessibleTextSequence getTextSequenceAt(int part, int index)
Returns theAccessibleTextSequenceat a given index.- Parameters:
-
part- theCHARACTER,WORD,SENTENCE,LINEorATTRIBUTE_RUNto retrieve -
index- an index within the text - Returns:
-
an
AccessibleTextSequencespecifying the text if part and index are valid. Otherwise, null is 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 retrieve -
index- an index within the text - Returns:
-
an
AccessibleTextSequencespecifying the text if part and index are valid. Otherwise, null is 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 retrieve -
index- an index within the text - Returns:
-
an
AccessibleTextSequencespecifying the text if part and index are valid. Otherwise, null is 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 text -
endIndex- the end index in the text - Returns:
- the bounding rectangle of the text if the indices are valid. Otherwise, null is returned.
-
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
