Interface AccessibleExtendedText

All Known Implementing Classes:
JEditorPane.AccessibleJEditorPane, JEditorPane.AccessibleJEditorPaneHTML, JEditorPane.JEditorPaneAccessibleHypertextSupport, JPasswordField.AccessibleJPasswordField, JTextArea.AccessibleJTextArea, JTextComponent.AccessibleJTextComponent, JTextField.AccessibleJTextField 
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 Accessible) and then calling the AccessibleContext.getAccessibleText() method of AccessibleContext. If the return value is an instance of AccessibleExtendedText, the object supports this interface.

Since:
1.5
See Also:

Field Summary

Modifier and Type Field Description
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.
static final int LINE
Constant used to indicate that the part of the text that should be retrieved is a line of text.

Method Summary

Modifier and Type Method Description
Rectangle getTextBounds(int startIndex, int endIndex)
Returns the bounding rectangle of the text between two indices.
String getTextRange(int startIndex, int endIndex)
Returns the text between two indices.
AccessibleTextSequence getTextSequenceAfter(int part, int index)
Returns the AccessibleTextSequence after a given index.
AccessibleTextSequence getTextSequenceAt(int part, int index)
Returns the AccessibleTextSequence at a given index.
AccessibleTextSequence getTextSequenceBefore(int part, int index)
Returns the AccessibleTextSequence before a given index.

Field Details

LINE

static final int LINE
Constant used to indicate that the part of the text that should be retrieved is a line of text.
See Also:

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.
See Also:

Method Details

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 the AccessibleTextSequence at a given index.
Parameters:
part - the CHARACTER, WORD, SENTENCE, LINE or ATTRIBUTE_RUN to retrieve
index - an index within the text
Returns:
an AccessibleTextSequence specifying the text if part and index are valid. Otherwise, null is returned.
See Also:

getTextSequenceAfter

AccessibleTextSequence getTextSequenceAfter(int part, int index)
Returns the AccessibleTextSequence after a given index.
Parameters:
part - the CHARACTER, WORD, SENTENCE, LINE or ATTRIBUTE_RUN to retrieve
index - an index within the text
Returns:
an AccessibleTextSequence specifying the text if part and index are valid. Otherwise, null is returned.
See Also:

getTextSequenceBefore

AccessibleTextSequence getTextSequenceBefore(int part, int index)
Returns the AccessibleTextSequence before a given index.
Parameters:
part - the CHARACTER, WORD, SENTENCE, LINE or ATTRIBUTE_RUN to retrieve
index - an index within the text
Returns:
an AccessibleTextSequence specifying the text if part and index are valid. Otherwise, null is returned.
See Also:

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.

© 1993, 2021, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/17/docs/api/java.desktop/javax/accessibility/AccessibleExtendedText.html