-
- 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 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 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 int
LINE
Constant used to indicate that the part of the text that should be retrieved is a line of text.
-
Method Summary
Methods Modifier and Type Method and 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 indicesAccessibleTextSequence
getTextSequenceAfter(int part, int index)
Returns theAccessibleTextSequence
after a given index.AccessibleTextSequence
getTextSequenceAt(int part, int index)
Returns theAccessibleTextSequence
at a given index.AccessibleTextSequence
getTextSequenceBefore(int part, int index)
Returns theAccessibleTextSequence
before 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, null is returned.
-
getTextSequenceAt
AccessibleTextSequence getTextSequenceAt(int part, int index)
Returns theAccessibleTextSequence
at a given index.- Parameters:
part
- theCHARACTER
,WORD
,SENTENCE
,LINE
orATTRIBUTE_RUN
to retrieveindex
- an index within the text- Returns:
- an
AccessibleTextSequence
specifying 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 theAccessibleTextSequence
after a given index.- Parameters:
part
- theCHARACTER
,WORD
,SENTENCE
,LINE
orATTRIBUTE_RUN
to retrieveindex
- an index within the text- Returns:
- an
AccessibleTextSequence
specifying 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 theAccessibleTextSequence
before a given index.- Parameters:
part
- theCHARACTER
,WORD
,SENTENCE
,LINE
orATTRIBUTE_RUN
to retrieveindex
- an index within the text- Returns:
- an
AccessibleTextSequence
specifying 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 textendIndex
- the end index in the text- Returns:
- the bounding rectangle of the text if the indices are valid. Otherwise, null is returned.
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-javax/accessibility/accessibleextendedtext.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.