AccessibleEditableText
, AccessibleHypertext
AbstractButton.AccessibleAbstractButton
, JButton.AccessibleJButton
, JCheckBox.AccessibleJCheckBox
, JCheckBoxMenuItem.AccessibleJCheckBoxMenuItem
, JEditorPane.AccessibleJEditorPane
, JEditorPane.AccessibleJEditorPaneHTML
, JEditorPane.JEditorPaneAccessibleHypertextSupport
, JLabel.AccessibleJLabel
, JMenu.AccessibleJMenu
, JMenuItem.AccessibleJMenuItem
, JPasswordField.AccessibleJPasswordField
, JRadioButton.AccessibleJRadioButton
, JRadioButtonMenuItem.AccessibleJRadioButtonMenuItem
, JSpinner.AccessibleJSpinner
, JTextArea.AccessibleJTextArea
, JTextComponent.AccessibleJTextComponent
, JTextField.AccessibleJTextField
, JToggleButton.AccessibleJToggleButton
, ProgressMonitor.AccessibleProgressMonitor
, TextArea.AccessibleAWTTextArea
, TextComponent.AccessibleAWTTextComponent
, TextField.AccessibleAWTTextField
public interface AccessibleText
AccessibleText
interface should be implemented by all classes that present textual information on the display. This interface provides the standard mechanism for an assistive technology to access that text via its content, attributes, and spatial location. Applications can determine if an object supports the AccessibleText
interface by first obtaining its AccessibleContext
(see Accessible
) and then calling the AccessibleContext.getAccessibleText()
method of AccessibleContext
. If the return value is not null
, the object supports this interface.Modifier and Type | Field | Description |
---|---|---|
static final int |
CHARACTER |
Constant used to indicate that the part of the text that should be retrieved is a character. |
static final int |
SENTENCE |
Constant used to indicate that the part of the text that should be retrieved is a sentence. |
static final int |
WORD |
Constant used to indicate that the part of the text that should be retrieved is a word. |
Modifier and Type | Method | Description |
---|---|---|
String |
getAfterIndex |
Returns the String after a given index. |
String |
getAtIndex |
Returns the String at a given index. |
String |
getBeforeIndex |
Returns the String before a given index. |
int |
getCaretPosition() |
Returns the zero-based offset of the caret. |
AttributeSet |
getCharacterAttribute |
Returns the AttributeSet for a given character at a given index. |
Rectangle |
getCharacterBounds |
Determines the bounding box of the character at the given index into the string. |
int |
getCharCount() |
Returns the number of characters (valid indices). |
int |
getIndexAtPoint |
Given a point in local coordinates, return the zero-based index of the character under that point. |
String |
getSelectedText() |
Returns the portion of the text that is selected. |
int |
getSelectionEnd() |
Returns the end offset within the selected text. |
int |
getSelectionStart() |
Returns the start offset within the selected text. |
static final int CHARACTER
static final int WORD
static final int SENTENCE
A sentence is a string of words which expresses an assertion, a question, a command, a wish, an exclamation, or the performance of an action. In English locales, the string usually begins with a capital letter and concludes with appropriate end punctuation; such as a period, question or exclamation mark. Other locales may use different capitalization and/or punctuation.
int getIndexAtPoint(Point p)
p
- the point in local coordinatesPoint p
; if point is invalid return -1.Rectangle getCharacterBounds(int i)
i
- the index into the stringint getCharCount()
int getCaretPosition()
Note: That to the right of the caret will have the same index value as the offset (the caret is between two characters).
String getAtIndex(int part, int index)
String
at a given index.part
- the CHARACTER, WORD, or SENTENCE to retrieveindex
- an index within the textString getAfterIndex(int part, int index)
String
after a given index.part
- the CHARACTER, WORD, or SENTENCE to retrieveindex
- an index within the textString getBeforeIndex(int part, int index)
String
before a given index.part
- the CHARACTER, WORD, or SENTENCE to retrieveindex
- an index within the textAttributeSet getCharacterAttribute(int i)
AttributeSet
for a given character at a given index.i
- the zero-based index into the textAttributeSet
of the characterint getSelectionStart()
int getSelectionEnd()
String getSelectedText()
String
portion of the text that is selected
© 1993, 2023, 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/21/docs/api/java.desktop/javax/accessibility/AccessibleText.html