TextComponent.AccessibleAWTTextComponent (Java Platform SE 8 ) (original) (raw)

• java.lang.Object

• • javax.accessibility.AccessibleContext
  • • java.awt.Component.AccessibleAWTComponent
      • • java.awt.TextComponent.AccessibleAWTTextComponent

• All Implemented Interfaces:
  TextListener, Serializable, EventListener, AccessibleComponent, AccessibleText
  Direct Known Subclasses:
  TextArea.AccessibleAWTTextArea, TextField.AccessibleAWTTextField
  Enclosing class:
  TextComponent

protected class TextComponent.AccessibleAWTTextComponent
extends Component.AccessibleAWTComponent
implements AccessibleText, TextListener
This class implements accessibility support for theTextComponent class. It provides an implementation of the Java Accessibility API appropriate to text component user-interface elements.
Since:
1.3
See Also:
Serialized Form

• • Nested Class Summary

     * ### Nested classes/interfaces inherited from class java.awt.[Component.AccessibleAWTComponent](../../java/awt/Component.AccessibleAWTComponent.html "class in java.awt")  
     `[Component.AccessibleAWTComponent.AccessibleAWTComponentHandler](../../java/awt/Component.AccessibleAWTComponent.AccessibleAWTComponentHandler.html "class in java.awt"), [Component.AccessibleAWTComponent.AccessibleAWTFocusHandler](../../java/awt/Component.AccessibleAWTComponent.AccessibleAWTFocusHandler.html "class in java.awt")`  

  • Field Summary

    * ### Fields inherited from class java.awt.[Component.AccessibleAWTComponent](../../java/awt/Component.AccessibleAWTComponent.html "class in java.awt")  
    `[accessibleAWTComponentHandler](../../java/awt/Component.AccessibleAWTComponent.html#accessibleAWTComponentHandler), [accessibleAWTFocusHandler](../../java/awt/Component.AccessibleAWTComponent.html#accessibleAWTFocusHandler)`  
    * ### Fields inherited from class javax.accessibility.[AccessibleContext](../../javax/accessibility/AccessibleContext.html "class in javax.accessibility")  
    `[ACCESSIBLE_ACTION_PROPERTY](../../javax/accessibility/AccessibleContext.html#ACCESSIBLE%5FACTION%5FPROPERTY), [ACCESSIBLE_ACTIVE_DESCENDANT_PROPERTY](../../javax/accessibility/AccessibleContext.html#ACCESSIBLE%5FACTIVE%5FDESCENDANT%5FPROPERTY), [ACCESSIBLE_CARET_PROPERTY](../../javax/accessibility/AccessibleContext.html#ACCESSIBLE%5FCARET%5FPROPERTY), [ACCESSIBLE_CHILD_PROPERTY](../../javax/accessibility/AccessibleContext.html#ACCESSIBLE%5FCHILD%5FPROPERTY), [ACCESSIBLE_COMPONENT_BOUNDS_CHANGED](../../javax/accessibility/AccessibleContext.html#ACCESSIBLE%5FCOMPONENT%5FBOUNDS%5FCHANGED), [ACCESSIBLE_DESCRIPTION_PROPERTY](../../javax/accessibility/AccessibleContext.html#ACCESSIBLE%5FDESCRIPTION%5FPROPERTY), [ACCESSIBLE_HYPERTEXT_OFFSET](../../javax/accessibility/AccessibleContext.html#ACCESSIBLE%5FHYPERTEXT%5FOFFSET), [ACCESSIBLE_INVALIDATE_CHILDREN](../../javax/accessibility/AccessibleContext.html#ACCESSIBLE%5FINVALIDATE%5FCHILDREN), [ACCESSIBLE_NAME_PROPERTY](../../javax/accessibility/AccessibleContext.html#ACCESSIBLE%5FNAME%5FPROPERTY), [ACCESSIBLE_SELECTION_PROPERTY](../../javax/accessibility/AccessibleContext.html#ACCESSIBLE%5FSELECTION%5FPROPERTY), [ACCESSIBLE_STATE_PROPERTY](../../javax/accessibility/AccessibleContext.html#ACCESSIBLE%5FSTATE%5FPROPERTY), [ACCESSIBLE_TABLE_CAPTION_CHANGED](../../javax/accessibility/AccessibleContext.html#ACCESSIBLE%5FTABLE%5FCAPTION%5FCHANGED), [ACCESSIBLE_TABLE_COLUMN_DESCRIPTION_CHANGED](../../javax/accessibility/AccessibleContext.html#ACCESSIBLE%5FTABLE%5FCOLUMN%5FDESCRIPTION%5FCHANGED), [ACCESSIBLE_TABLE_COLUMN_HEADER_CHANGED](../../javax/accessibility/AccessibleContext.html#ACCESSIBLE%5FTABLE%5FCOLUMN%5FHEADER%5FCHANGED), [ACCESSIBLE_TABLE_MODEL_CHANGED](../../javax/accessibility/AccessibleContext.html#ACCESSIBLE%5FTABLE%5FMODEL%5FCHANGED), [ACCESSIBLE_TABLE_ROW_DESCRIPTION_CHANGED](../../javax/accessibility/AccessibleContext.html#ACCESSIBLE%5FTABLE%5FROW%5FDESCRIPTION%5FCHANGED), [ACCESSIBLE_TABLE_ROW_HEADER_CHANGED](../../javax/accessibility/AccessibleContext.html#ACCESSIBLE%5FTABLE%5FROW%5FHEADER%5FCHANGED), [ACCESSIBLE_TABLE_SUMMARY_CHANGED](../../javax/accessibility/AccessibleContext.html#ACCESSIBLE%5FTABLE%5FSUMMARY%5FCHANGED), [ACCESSIBLE_TEXT_ATTRIBUTES_CHANGED](../../javax/accessibility/AccessibleContext.html#ACCESSIBLE%5FTEXT%5FATTRIBUTES%5FCHANGED), [ACCESSIBLE_TEXT_PROPERTY](../../javax/accessibility/AccessibleContext.html#ACCESSIBLE%5FTEXT%5FPROPERTY), [ACCESSIBLE_VALUE_PROPERTY](../../javax/accessibility/AccessibleContext.html#ACCESSIBLE%5FVALUE%5FPROPERTY), [ACCESSIBLE_VISIBLE_DATA_PROPERTY](../../javax/accessibility/AccessibleContext.html#ACCESSIBLE%5FVISIBLE%5FDATA%5FPROPERTY), [accessibleDescription](../../javax/accessibility/AccessibleContext.html#accessibleDescription), [accessibleName](../../javax/accessibility/AccessibleContext.html#accessibleName), [accessibleParent](../../javax/accessibility/AccessibleContext.html#accessibleParent)`  
    * ### Fields inherited from interface javax.accessibility.[AccessibleText](../../javax/accessibility/AccessibleText.html "interface in javax.accessibility")  
    `[CHARACTER](../../javax/accessibility/AccessibleText.html#CHARACTER), [SENTENCE](../../javax/accessibility/AccessibleText.html#SENTENCE), [WORD](../../javax/accessibility/AccessibleText.html#WORD)`  

  • Constructor Summary

  Constructors

  Constructor	Description
  AccessibleAWTTextComponent()	Constructs an AccessibleAWTTextComponent.

  • Method Summary

  All Methods Instance Methods Concrete Methods

  Modifier and Type	Method	Description
  AccessibleRole	getAccessibleRole()	Gets the role of this object.
  AccessibleStateSet	getAccessibleStateSet()	Gets the state set of the TextComponent.
  AccessibleText	getAccessibleText()	Get the AccessibleText associated with this object.
  String	getAfterIndex(int part, int index)	Returns the String after a given index.
  String	getAtIndex(int part, int index)	Returns the String at a given index.
  String	getBeforeIndex(int part, int index)	Returns the String before a given index.
  int	getCaretPosition()	Returns the zero-based offset of the caret.
  AttributeSet	getCharacterAttribute(int i)	Returns the AttributeSet for a given character (at a given index).
  Rectangle	getCharacterBounds(int i)	Determines the bounding box of the character at the given index into the string.
  int	getCharCount()	Returns the number of characters (valid indicies)
  int	getIndexAtPoint(Point p)	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.
  void	textValueChanged(TextEvent textEvent)	TextListener notification of a text value change.

     * ### Methods inherited from class java.awt.[Component.AccessibleAWTComponent](../../java/awt/Component.AccessibleAWTComponent.html "class in java.awt")  
     `[addFocusListener](../../java/awt/Component.AccessibleAWTComponent.html#addFocusListener-java.awt.event.FocusListener-), [addPropertyChangeListener](../../java/awt/Component.AccessibleAWTComponent.html#addPropertyChangeListener-java.beans.PropertyChangeListener-), [contains](../../java/awt/Component.AccessibleAWTComponent.html#contains-java.awt.Point-), [getAccessibleAt](../../java/awt/Component.AccessibleAWTComponent.html#getAccessibleAt-java.awt.Point-), [getAccessibleChild](../../java/awt/Component.AccessibleAWTComponent.html#getAccessibleChild-int-), [getAccessibleChildrenCount](../../java/awt/Component.AccessibleAWTComponent.html#getAccessibleChildrenCount--), [getAccessibleComponent](../../java/awt/Component.AccessibleAWTComponent.html#getAccessibleComponent--), [getAccessibleDescription](../../java/awt/Component.AccessibleAWTComponent.html#getAccessibleDescription--), [getAccessibleIndexInParent](../../java/awt/Component.AccessibleAWTComponent.html#getAccessibleIndexInParent--), [getAccessibleName](../../java/awt/Component.AccessibleAWTComponent.html#getAccessibleName--), [getAccessibleParent](../../java/awt/Component.AccessibleAWTComponent.html#getAccessibleParent--), [getBackground](../../java/awt/Component.AccessibleAWTComponent.html#getBackground--), [getBounds](../../java/awt/Component.AccessibleAWTComponent.html#getBounds--), [getCursor](../../java/awt/Component.AccessibleAWTComponent.html#getCursor--), [getFont](../../java/awt/Component.AccessibleAWTComponent.html#getFont--), [getFontMetrics](../../java/awt/Component.AccessibleAWTComponent.html#getFontMetrics-java.awt.Font-), [getForeground](../../java/awt/Component.AccessibleAWTComponent.html#getForeground--), [getLocale](../../java/awt/Component.AccessibleAWTComponent.html#getLocale--), [getLocation](../../java/awt/Component.AccessibleAWTComponent.html#getLocation--), [getLocationOnScreen](../../java/awt/Component.AccessibleAWTComponent.html#getLocationOnScreen--), [getSize](../../java/awt/Component.AccessibleAWTComponent.html#getSize--), [isEnabled](../../java/awt/Component.AccessibleAWTComponent.html#isEnabled--), [isFocusTraversable](../../java/awt/Component.AccessibleAWTComponent.html#isFocusTraversable--), [isShowing](../../java/awt/Component.AccessibleAWTComponent.html#isShowing--), [isVisible](../../java/awt/Component.AccessibleAWTComponent.html#isVisible--), [removeFocusListener](../../java/awt/Component.AccessibleAWTComponent.html#removeFocusListener-java.awt.event.FocusListener-), [removePropertyChangeListener](../../java/awt/Component.AccessibleAWTComponent.html#removePropertyChangeListener-java.beans.PropertyChangeListener-), [requestFocus](../../java/awt/Component.AccessibleAWTComponent.html#requestFocus--), [setBackground](../../java/awt/Component.AccessibleAWTComponent.html#setBackground-java.awt.Color-), [setBounds](../../java/awt/Component.AccessibleAWTComponent.html#setBounds-java.awt.Rectangle-), [setCursor](../../java/awt/Component.AccessibleAWTComponent.html#setCursor-java.awt.Cursor-), [setEnabled](../../java/awt/Component.AccessibleAWTComponent.html#setEnabled-boolean-), [setFont](../../java/awt/Component.AccessibleAWTComponent.html#setFont-java.awt.Font-), [setForeground](../../java/awt/Component.AccessibleAWTComponent.html#setForeground-java.awt.Color-), [setLocation](../../java/awt/Component.AccessibleAWTComponent.html#setLocation-java.awt.Point-), [setSize](../../java/awt/Component.AccessibleAWTComponent.html#setSize-java.awt.Dimension-), [setVisible](../../java/awt/Component.AccessibleAWTComponent.html#setVisible-boolean-)`  
     * ### Methods inherited from class javax.accessibility.[AccessibleContext](../../javax/accessibility/AccessibleContext.html "class in javax.accessibility")  
     `[firePropertyChange](../../javax/accessibility/AccessibleContext.html#firePropertyChange-java.lang.String-java.lang.Object-java.lang.Object-), [getAccessibleAction](../../javax/accessibility/AccessibleContext.html#getAccessibleAction--), [getAccessibleEditableText](../../javax/accessibility/AccessibleContext.html#getAccessibleEditableText--), [getAccessibleIcon](../../javax/accessibility/AccessibleContext.html#getAccessibleIcon--), [getAccessibleRelationSet](../../javax/accessibility/AccessibleContext.html#getAccessibleRelationSet--), [getAccessibleSelection](../../javax/accessibility/AccessibleContext.html#getAccessibleSelection--), [getAccessibleTable](../../javax/accessibility/AccessibleContext.html#getAccessibleTable--), [getAccessibleValue](../../javax/accessibility/AccessibleContext.html#getAccessibleValue--), [setAccessibleDescription](../../javax/accessibility/AccessibleContext.html#setAccessibleDescription-java.lang.String-), [setAccessibleName](../../javax/accessibility/AccessibleContext.html#setAccessibleName-java.lang.String-), [setAccessibleParent](../../javax/accessibility/AccessibleContext.html#setAccessibleParent-javax.accessibility.Accessible-)`  
     * ### Methods inherited from class java.lang.[Object](../../java/lang/Object.html "class in java.lang")  
     `[clone](../../java/lang/Object.html#clone--), [equals](../../java/lang/Object.html#equals-java.lang.Object-), [finalize](../../java/lang/Object.html#finalize--), [getClass](../../java/lang/Object.html#getClass--), [hashCode](../../java/lang/Object.html#hashCode--), [notify](../../java/lang/Object.html#notify--), [notifyAll](../../java/lang/Object.html#notifyAll--), [toString](../../java/lang/Object.html#toString--), [wait](../../java/lang/Object.html#wait--), [wait](../../java/lang/Object.html#wait-long-), [wait](../../java/lang/Object.html#wait-long-int-)`

• • Constructor Detail

     * #### AccessibleAWTTextComponent  
     public AccessibleAWTTextComponent()  
     Constructs an AccessibleAWTTextComponent. Adds a listener to track caret change.  

  • Method Detail

    * #### textValueChanged  
    public void textValueChanged([TextEvent](../../java/awt/event/TextEvent.html "class in java.awt.event") textEvent)  
    TextListener notification of a text value change.  
    Specified by:  
    `[textValueChanged](../../java/awt/event/TextListener.html#textValueChanged-java.awt.event.TextEvent-)` in interface `[TextListener](../../java/awt/event/TextListener.html "interface in java.awt.event")`  
    * #### getAccessibleStateSet  
    public [AccessibleStateSet](../../javax/accessibility/AccessibleStateSet.html "class in javax.accessibility") getAccessibleStateSet()  
    Gets the state set of the TextComponent. The AccessibleStateSet of an object is composed of a set of unique AccessibleStates. A change in the AccessibleStateSet of an object will cause a PropertyChangeEvent to be fired for the AccessibleContext.ACCESSIBLE\_STATE\_PROPERTY property.  
    Overrides:  
    `[getAccessibleStateSet](../../java/awt/Component.AccessibleAWTComponent.html#getAccessibleStateSet--)` in class `[Component.AccessibleAWTComponent](../../java/awt/Component.AccessibleAWTComponent.html "class in java.awt")`  
    Returns:  
    an instance of AccessibleStateSet containing the current state set of the object  
    See Also:  
    [AccessibleStateSet](../../javax/accessibility/AccessibleStateSet.html "class in javax.accessibility"), [AccessibleState](../../javax/accessibility/AccessibleState.html "class in javax.accessibility"), [Component.AccessibleAWTComponent.addPropertyChangeListener(java.beans.PropertyChangeListener)](../../java/awt/Component.AccessibleAWTComponent.html#addPropertyChangeListener-java.beans.PropertyChangeListener-)  
    * #### getAccessibleRole  
    public [AccessibleRole](../../javax/accessibility/AccessibleRole.html "class in javax.accessibility") getAccessibleRole()  
    Gets the role of this object.  
    Overrides:  
    `[getAccessibleRole](../../java/awt/Component.AccessibleAWTComponent.html#getAccessibleRole--)` in class `[Component.AccessibleAWTComponent](../../java/awt/Component.AccessibleAWTComponent.html "class in java.awt")`  
    Returns:  
    an instance of AccessibleRole describing the role of the object (AccessibleRole.TEXT)  
    See Also:  
    [AccessibleRole](../../javax/accessibility/AccessibleRole.html "class in javax.accessibility")  
    * #### getAccessibleText  
    public [AccessibleText](../../javax/accessibility/AccessibleText.html "interface in javax.accessibility") getAccessibleText()  
    Get the AccessibleText associated with this object. In the implementation of the Java Accessibility API for this class, return this object, which is responsible for implementing the AccessibleText interface on behalf of itself.  
    Overrides:  
    `[getAccessibleText](../../javax/accessibility/AccessibleContext.html#getAccessibleText--)` in class `[AccessibleContext](../../javax/accessibility/AccessibleContext.html "class in javax.accessibility")`  
    Returns:  
    this object  
    See Also:  
    [AccessibleText](../../javax/accessibility/AccessibleText.html "interface in javax.accessibility")  
    * #### getIndexAtPoint  
    public int getIndexAtPoint([Point](../../java/awt/Point.html "class in java.awt") p)  
    Given 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.  
    Specified by:  
    `[getIndexAtPoint](../../javax/accessibility/AccessibleText.html#getIndexAtPoint-java.awt.Point-)` in interface `[AccessibleText](../../javax/accessibility/AccessibleText.html "interface in javax.accessibility")`  
    Parameters:  
    `p` \- the Point in local coordinates  
    Returns:  
    the zero-based index of the character under Point p.  
    * #### getCharacterBounds  
    public [Rectangle](../../java/awt/Rectangle.html "class in java.awt") getCharacterBounds(int i)  
    Determines 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 a null rectangle is returned.  
    Specified by:  
    `[getCharacterBounds](../../javax/accessibility/AccessibleText.html#getCharacterBounds-int-)` in interface `[AccessibleText](../../javax/accessibility/AccessibleText.html "interface in javax.accessibility")`  
    Parameters:  
    `i` \- the index into the String >= 0  
    Returns:  
    the screen coordinates of the character's bounding box  
    * #### getCharCount  
    public int getCharCount()  
    Returns the number of characters (valid indicies)  
    Specified by:  
    `[getCharCount](../../javax/accessibility/AccessibleText.html#getCharCount--)` in interface `[AccessibleText](../../javax/accessibility/AccessibleText.html "interface in javax.accessibility")`  
    Returns:  
    the number of characters >= 0  
    * #### getCaretPosition  
    public int getCaretPosition()  
    Returns the zero-based offset of the caret. Note: The character to the right of the caret will have the same index value as the offset (the caret is between two characters).  
    Specified by:  
    `[getCaretPosition](../../javax/accessibility/AccessibleText.html#getCaretPosition--)` in interface `[AccessibleText](../../javax/accessibility/AccessibleText.html "interface in javax.accessibility")`  
    Returns:  
    the zero-based offset of the caret.  
    * #### getCharacterAttribute  
    public [AttributeSet](../../javax/swing/text/AttributeSet.html "interface in javax.swing.text") getCharacterAttribute(int i)  
    Returns the AttributeSet for a given character (at a given index).  
    Specified by:  
    `[getCharacterAttribute](../../javax/accessibility/AccessibleText.html#getCharacterAttribute-int-)` in interface `[AccessibleText](../../javax/accessibility/AccessibleText.html "interface in javax.accessibility")`  
    Parameters:  
    `i` \- the zero-based index into the text  
    Returns:  
    the AttributeSet of the character  
    * #### getSelectionStart  
    public int 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. Return 0 if the text is empty, or the caret position if no selection.  
    Specified by:  
    `[getSelectionStart](../../javax/accessibility/AccessibleText.html#getSelectionStart--)` in interface `[AccessibleText](../../javax/accessibility/AccessibleText.html "interface in javax.accessibility")`  
    Returns:  
    the index into the text of the start of the selection >= 0  
    * #### getSelectionEnd  
    public int 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. Return 0 if the text is empty, or the caret position if no selection.  
    Specified by:  
    `[getSelectionEnd](../../javax/accessibility/AccessibleText.html#getSelectionEnd--)` in interface `[AccessibleText](../../javax/accessibility/AccessibleText.html "interface in javax.accessibility")`  
    Returns:  
    the index into the text of the end of the selection >= 0  
    * #### getSelectedText  
    public [String](../../java/lang/String.html "class in java.lang") getSelectedText()  
    Returns the portion of the text that is selected.  
    Specified by:  
    `[getSelectedText](../../javax/accessibility/AccessibleText.html#getSelectedText--)` in interface `[AccessibleText](../../javax/accessibility/AccessibleText.html "interface in javax.accessibility")`  
    Returns:  
    the text, null if no selection  
    * #### getAtIndex  
    public [String](../../java/lang/String.html "class in java.lang") getAtIndex(int part,  
                             int index)  
    Returns the String at a given index.  
    Specified by:  
    `[getAtIndex](../../javax/accessibility/AccessibleText.html#getAtIndex-int-int-)` in interface `[AccessibleText](../../javax/accessibility/AccessibleText.html "interface in javax.accessibility")`  
    Parameters:  
    `part` \- the AccessibleText.CHARACTER, AccessibleText.WORD, or AccessibleText.SENTENCE to retrieve  
    `index` \- an index within the text >= 0  
    Returns:  
    the letter, word, or sentence, null for an invalid index or part  
    * #### getAfterIndex  
    public [String](../../java/lang/String.html "class in java.lang") getAfterIndex(int part,  
                                int index)  
    Returns the String after a given index.  
    Specified by:  
    `[getAfterIndex](../../javax/accessibility/AccessibleText.html#getAfterIndex-int-int-)` in interface `[AccessibleText](../../javax/accessibility/AccessibleText.html "interface in javax.accessibility")`  
    Parameters:  
    `part` \- the AccessibleText.CHARACTER, AccessibleText.WORD, or AccessibleText.SENTENCE to retrieve  
    `index` \- an index within the text >= 0  
    Returns:  
    the letter, word, or sentence, null for an invalid index or part  
    * #### getBeforeIndex  
    public [String](../../java/lang/String.html "class in java.lang") getBeforeIndex(int part,  
                                 int index)  
    Returns the String before a given index.  
    Specified by:  
    `[getBeforeIndex](../../javax/accessibility/AccessibleText.html#getBeforeIndex-int-int-)` in interface `[AccessibleText](../../javax/accessibility/AccessibleText.html "interface in javax.accessibility")`  
    Parameters:  
    `part` \- the AccessibleText.CHARACTER, AccessibleText.WORD, or AccessibleText.SENTENCE to retrieve  
    `index` \- an index within the text >= 0  
    Returns:  
    the letter, word, or sentence, null for an invalid index or part

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2025, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.