- All Known Subinterfaces:
- AccessibleEditableText,- AccessibleHypertext
- All Known Implementing Classes:
- 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
The 
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.- See Also:
- 
Field SummaryFieldsModifier and TypeFieldDescriptionstatic final intConstant used to indicate that the part of the text that should be retrieved is a character.static final intConstant used to indicate that the part of the text that should be retrieved is a sentence.static final intConstant used to indicate that the part of the text that should be retrieved is a word.
- 
Method SummaryModifier and TypeMethodDescriptiongetAfterIndex(int part, int index) Returns theStringafter a given index.getAtIndex(int part, int index) Returns theStringat a given index.getBeforeIndex(int part, int index) Returns theStringbefore a given index.intReturns the zero-based offset of the caret.getCharacterAttribute(int i) Returns theAttributeSetfor a given character at a given index.getCharacterBounds(int i) Determines the bounding box of the character at the given index into the string.intReturns the number of characters (valid indices).intGiven a point in local coordinates, return the zero-based index of the character under that point.Returns the portion of the text that is selected.intReturns the end offset within the selected text.intReturns the start offset within the selected text.
- 
Field Details- 
CHARACTERstatic final int CHARACTERConstant used to indicate that the part of the text that should be retrieved is a character.- See Also:
 
- 
WORDstatic final int WORDConstant used to indicate that the part of the text that should be retrieved is a word.- See Also:
 
- 
SENTENCEstatic final int SENTENCEConstant used to indicate that the part of the text that should be retrieved is a 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. - See Also:
 
 
- 
- 
Method Details- 
getIndexAtPointGiven a point in local coordinates, return the zero-based index of the character under that point. If the point is invalid, this method returns -1.- Parameters:
- p- the point in local coordinates
- Returns:
- the zero-based index of the character under Point p; if point is invalid return -1.
 
- 
getCharacterBoundsDetermines the bounding box of the character at the given index into the string. The bounds are returned in local coordinates. If the index is invalid an empty rectangle is returned.- Parameters:
- i- the index into the string
- Returns:
- the screen coordinates of the character's bounding box, if index is invalid return an empty rectangle.
 
- 
getCharCountint getCharCount()Returns the number of characters (valid indices).- Returns:
- the number of characters
 
- 
getCaretPositionint getCaretPosition()Returns the zero-based offset of the caret.Note: That to the right of the caret will have the same index value as the offset (the caret is between two characters). - Returns:
- the zero-based offset of the caret
 
- 
getAtIndexReturns theStringat a given index.- Parameters:
- part- the CHARACTER, WORD, or SENTENCE to retrieve
- index- an index within the text
- Returns:
- the letter, word, or sentence
 
- 
getAfterIndexReturns theStringafter a given index.- Parameters:
- part- the CHARACTER, WORD, or SENTENCE to retrieve
- index- an index within the text
- Returns:
- the letter, word, or sentence
 
- 
getBeforeIndexReturns theStringbefore a given index.- Parameters:
- part- the CHARACTER, WORD, or SENTENCE to retrieve
- index- an index within the text
- Returns:
- the letter, word, or sentence
 
- 
getCharacterAttributeReturns theAttributeSetfor a given character at a given index.- Parameters:
- i- the zero-based index into the text
- Returns:
- the AttributeSetof the character
 
- 
getSelectionStartint getSelectionStart()Returns the start offset within the selected text. If there is no selection, but there is a caret, the start and end offsets will be the same.- Returns:
- the index into the text of the start of the selection
 
- 
getSelectionEndint getSelectionEnd()Returns the end offset within the selected text. If there is no selection, but there is a caret, the start and end offsets will be the same.- Returns:
- the index into the text of the end of the selection
 
- 
getSelectedTextString getSelectedText()Returns the portion of the text that is selected.- Returns:
- the Stringportion of the text that is selected
 
 
-