- 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
FieldsModifier and TypeFieldDescriptionstatic final intConstant used to indicate that the part of the text that should be retrieved is contiguous text with the same text attributes.static final intConstant used to indicate that the part of the text that should be retrieved is a line of text. -
Method Summary
Modifier and TypeMethodDescriptiongetTextBounds(int startIndex, int endIndex) Returns the bounding rectangle of the text between two indices.getTextRange(int startIndex, int endIndex) Returns the text between two indices.getTextSequenceAfter(int part, int index) Returns theAccessibleTextSequenceafter a given index.getTextSequenceAt(int part, int index) Returns theAccessibleTextSequenceat a given index.getTextSequenceBefore(int part, int index) Returns theAccessibleTextSequencebefore a given index.
-
Field Details
-
LINE
static final int LINEConstant 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_RUNConstant 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
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
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:
-
getTextSequenceAfter
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:
-
getTextSequenceBefore
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:
-
getTextBounds
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.
-