javax.accessibility
Interface AccessibleText

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, JTextArea.AccessibleJTextArea, JTextComponent.AccessibleJTextComponent, JTextField.AccessibleJTextField, JToggleButton.AccessibleJToggleButton, TextArea.AccessibleAWTTextArea, TextComponent.AccessibleAWTTextComponent, TextField.AccessibleAWTTextField

public interface AccessibleText

Objects which present textual information on the display should implement this interface. Accessibility software can use the implementations of this interface to change the attributes and spacial location of the text.

The AccessibleContext.getAccessibleText() method should return null if an object does not implement this interface.

Since:
1.2
See Also:
Accessible, AccessibleContext, AccessibleContext.getAccessibleText()

Field Summary
static int CHARACTER
          Constant designating that the next selection should be a character.
static int SENTENCE
          Constant designating that the next selection should be a sentence.
static int WORD
          Constant designating that the next selection should be a word.
 
Method Summary
 String getAfterIndex(int part, int index)
          Returns the section of text after the index, or null if the index or part is invalid.
 String getAtIndex(int part, int index)
          Returns the section of text at the index, or null if the index or part is invalid.
 String getBeforeIndex(int part, int index)
          Returns the section of text before the index, or null if the index or part is invalid.
 int getCaretPosition()
          Return the offset of the character.
 AttributeSet getCharacterAttribute(int index)
          Returns the attributes of a character at an index, or null if the index is out of bounds.
 Rectangle getCharacterBounds(int index)
          Determines the bounding box of the indexed character.
 int getCharCount()
          Return the number of characters.
 int getIndexAtPoint(Point point)
          Given a point in the coordinate system of this object, return the 0-based index of the character at that point, or -1 if there is none.
 String getSelectedText()
          Returns the selected text.
 int getSelectionEnd()
          Returns the end index of the selection.
 int getSelectionStart()
          Returns the start index of the selection.
 

Field Detail

CHARACTER

static final int CHARACTER
Constant designating that the next selection should be a character.

See Also:
getAtIndex(int, int), getAfterIndex(int, int), getBeforeIndex(int, int), Constant Field Values

WORD

static final int WORD
Constant designating that the next selection should be a word.

See Also:
getAtIndex(int, int), getAfterIndex(int, int), getBeforeIndex(int, int), Constant Field Values

SENTENCE

static final int SENTENCE
Constant designating that the next selection should be a sentence.

See Also:
getAtIndex(int, int), getAfterIndex(int, int), getBeforeIndex(int, int), Constant Field Values
Method Detail

getIndexAtPoint

int getIndexAtPoint(Point point)
Given a point in the coordinate system of this object, return the 0-based index of the character at that point, or -1 if there is none.

Parameters:
point - the point to look at
Returns:
the character index, or -1

getCharacterBounds

Rectangle getCharacterBounds(int index)
Determines the bounding box of the indexed character. Returns an empty rectangle if the index is out of bounds.

Parameters:
index - the 0-based character index
Returns:
the bounding box, may be empty

getCharCount

int getCharCount()
Return the number of characters.

Returns:
the character count

getCaretPosition

int getCaretPosition()
Return the offset of the character. The offset matches the index of the character to the right, since the carat lies between characters.

Returns:
the 0-based caret position

getAtIndex

String getAtIndex(int part,
                  int index)
Returns the section of text at the index, or null if the index or part is invalid.

Parameters:
part - CHARACTER, WORD, or SENTENCE
index - the 0-based character index
Returns:
the selection of text at that index, or null

getAfterIndex

String getAfterIndex(int part,
                     int index)
Returns the section of text after the index, or null if the index or part is invalid.

Parameters:
part - CHARACTER, WORD, or SENTENCE
index - the 0-based character index
Returns:
the selection of text after that index, or null

getBeforeIndex

String getBeforeIndex(int part,
                      int index)
Returns the section of text before the index, or null if the index or part is invalid.

Parameters:
part - CHARACTER, WORD, or SENTENCE
index - the 0-based character index
Returns:
the selection of text before that index, or null

getCharacterAttribute

AttributeSet getCharacterAttribute(int index)
Returns the attributes of a character at an index, or null if the index is out of bounds.

Parameters:
index - the 0-based character index
Returns:
the character's attributes

getSelectionStart

int getSelectionStart()
Returns the start index of the selection. If there is no selection, this is the same as the caret location.

Returns:
the 0-based character index of the selection start

getSelectionEnd

int getSelectionEnd()
Returns the end index of the selection. If there is no selection, this is the same as the caret location.

Returns:
the 0-based character index of the selection end

getSelectedText

String getSelectedText()
Returns the selected text. This may be null or "" if no text is selected.

Returns:
the selected text