AccessibleExtendedText (Java Platform SE 8 ) (original) (raw)

• 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 the AccessibleContext.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	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

  All Methods Instance Methods Abstract Methods

  Modifier and Type	Method	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 indices
  AccessibleTextSequence	getTextSequenceAfter(int part, int index)	Returns the AccessibleTextSequence after a given index.
  AccessibleTextSequence	getTextSequenceAt(int part, int index)	Returns the AccessibleTextSequence at a given index.
  AccessibleTextSequence	getTextSequenceBefore(int part, int index)	Returns the AccessibleTextSequence 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.  
     See Also:  
     [AccessibleText.getAtIndex(int, int)](../../javax/accessibility/AccessibleText.html#getAtIndex-int-int-), [AccessibleText.getAfterIndex(int, int)](../../javax/accessibility/AccessibleText.html#getAfterIndex-int-int-), [AccessibleText.getBeforeIndex(int, int)](../../javax/accessibility/AccessibleText.html#getBeforeIndex-int-int-), [Constant Field Values](../../constant-values.html#javax.accessibility.AccessibleExtendedText.LINE)  
     * #### 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.  
     See Also:  
     [AccessibleText.getAtIndex(int, int)](../../javax/accessibility/AccessibleText.html#getAtIndex-int-int-), [AccessibleText.getAfterIndex(int, int)](../../javax/accessibility/AccessibleText.html#getAfterIndex-int-int-), [AccessibleText.getBeforeIndex(int, int)](../../javax/accessibility/AccessibleText.html#getBeforeIndex-int-int-), [Constant Field Values](../../constant-values.html#javax.accessibility.AccessibleExtendedText.ATTRIBUTE%5FRUN)  

  • Method Detail

    * #### getTextRange  
    [String](../../java/lang/String.html "class in java.lang") getTextRange(int startIndex,  
                        int endIndex)  
    Returns the text between two indices  
    Parameters:  
    `startIndex` \- the start index in the text  
    `endIndex` \- the end index in the text  
    Returns:  
    the text string if the indices are valid. Otherwise, null is returned.  
    * #### getTextSequenceAt  
    [AccessibleTextSequence](../../javax/accessibility/AccessibleTextSequence.html "class in javax.accessibility") getTextSequenceAt(int part,  
                                             int index)  
    Returns the `AccessibleTextSequence` at a given index.  
    Parameters:  
    `part` \- the `CHARACTER`, `WORD`,`SENTENCE`, `LINE` or `ATTRIBUTE_RUN` to retrieve  
    `index` \- 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](../../javax/accessibility/AccessibleText.html#CHARACTER), [AccessibleText.WORD](../../javax/accessibility/AccessibleText.html#WORD), [AccessibleText.SENTENCE](../../javax/accessibility/AccessibleText.html#SENTENCE)  
    * #### getTextSequenceAfter  
    [AccessibleTextSequence](../../javax/accessibility/AccessibleTextSequence.html "class in javax.accessibility") getTextSequenceAfter(int part,  
                                                int index)  
    Returns the `AccessibleTextSequence` after a given index.  
    Parameters:  
    `part` \- the `CHARACTER`, `WORD`,`SENTENCE`, `LINE` or `ATTRIBUTE_RUN` to retrieve  
    `index` \- 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](../../javax/accessibility/AccessibleText.html#CHARACTER), [AccessibleText.WORD](../../javax/accessibility/AccessibleText.html#WORD), [AccessibleText.SENTENCE](../../javax/accessibility/AccessibleText.html#SENTENCE)  
    * #### getTextSequenceBefore  
    [AccessibleTextSequence](../../javax/accessibility/AccessibleTextSequence.html "class in javax.accessibility") getTextSequenceBefore(int part,  
                                                 int index)  
    Returns the `AccessibleTextSequence` before a given index.  
    Parameters:  
    `part` \- the `CHARACTER`, `WORD`,`SENTENCE`, `LINE` or `ATTRIBUTE_RUN` to retrieve  
    `index` \- 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](../../javax/accessibility/AccessibleText.html#CHARACTER), [AccessibleText.WORD](../../javax/accessibility/AccessibleText.html#WORD), [AccessibleText.SENTENCE](../../javax/accessibility/AccessibleText.html#SENTENCE)  
    * #### getTextBounds  
    [Rectangle](../../java/awt/Rectangle.html "class in java.awt") getTextBounds(int startIndex,  
                            int endIndex)  
    Returns the bounding rectangle of the text between two indices.  
    Parameters:  
    `startIndex` \- the start index in the text  
    `endIndex` \- the end index in the text  
    Returns:  
    the bounding rectangle of the text if the indices are valid. Otherwise, null is returned.

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.