Module java.desktop

Interface AccessibleText

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int CHARACTER
      Constant used to indicate that the part of the text that should be retrieved is a character.
      static int SENTENCE
      Constant used to indicate that the part of the text that should be retrieved is a sentence.
      static int WORD
      Constant used to indicate that the part of the text that should be retrieved is a word.
    • Method Detail

      • getIndexAtPoint

        int getIndexAtPoint​(Point 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.
        Parameters:
        p - the point in local coordinates
        Returns:
        the zero-based index of the character under Point p; if point is invalid return -1.
      • getCharacterBounds

        Rectangle 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 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.
      • getCharCount

        int getCharCount​()
        Returns the number of characters (valid indicies).
        Returns:
        the number of characters
      • getCaretPosition

        int 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
      • getAtIndex

        String getAtIndex​(int part,
                          int index)
        Returns the String at a given index.
        Parameters:
        part - the CHARACTER, WORD, or SENTENCE to retrieve
        index - an index within the text
        Returns:
        the letter, word, or sentence
      • getAfterIndex

        String getAfterIndex​(int part,
                             int index)
        Returns the String after a given index.
        Parameters:
        part - the CHARACTER, WORD, or SENTENCE to retrieve
        index - an index within the text
        Returns:
        the letter, word, or sentence
      • getBeforeIndex

        String getBeforeIndex​(int part,
                              int index)
        Returns the String before a given index.
        Parameters:
        part - the CHARACTER, WORD, or SENTENCE to retrieve
        index - an index within the text
        Returns:
        the letter, word, or sentence
      • getCharacterAttribute

        AttributeSet getCharacterAttribute​(int i)
        Returns the AttributeSet for a given character at a given index.
        Parameters:
        i - the zero-based index into the text
        Returns:
        the AttributeSet of the character
      • getSelectionStart

        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.
        Returns:
        the index into the text of the start of the selection
      • getSelectionEnd

        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.
        Returns:
        the index into the text of the end of the selection
      • getSelectedText

        String getSelectedText​()
        Returns the portion of the text that is selected.
        Returns:
        the String portion of the text that is selected