Returns the offset of the caret. The caret is often called text cursor. The caret is actually the position between two characters. Its position/offset is that of the character to the right of it.

The caret is often called text cursor. The caret is actually the position between two characters. Its position/offset is that of the character to the right of it.

Setting the caret position may or may not alter the current selection. A change of the selection is notified to the accessibility event listeners with an AccessibleEventId::ACCESSIBLE_SELECTION_EVENT.

When the new caret position differs from the old one (which, of course, is the standard case) this is notified to the accessibility event listeners with an AccessibleEventId::ACCESSIBLE_CARET_EVENT.

Returns the character at the given index.

Returns a set of attributes that are associated for the character at the given index. To prevent the method from returning possibly large sets of attributes that the caller is not interested in the caller has to provide a list of attributes that he wants to be returned.

An empty sequence signals the callers interest in all the attributes. This is usefull in two cases: a) Simply as a way to avoid passing a potentially large array to the called object or b) when the caller does not know what attributes the called objects supports but is interested in all of them nevertheless.

Returns the bounding box of the indexed character.

The virtual character after the last character of the represented text, i.e. the one at position length is a special case. It represents the current input position and will therefore typically be queried by AT more often than other positions. Because it does not represent an existing character its bounding box is defined in relation to preceding characters. It should be rougly equivalent to the bounding box of some character when inserted at the end of the text. Its height typically being the maximal height of all the characters in the text or the height of the preceding character, its width being at least one pixel so that the bounding box is not degenerate.
Note that the index 'length' is not always valid. Whether it is or not is implementation dependent. It typically is when text is editable or otherwise when on the screen the caret can be placed behind the text. You can be sure that the index is valid after you have received a CARET event for this index.

Returns the number of characters in the text represented by this object or, in other words, the text length.

Given a point in local coordinates, i.e. relative to the coordinate system of the object, return the zero-based index of the character under that point. The same functionality could be achieved by using the bounding boxes for each character as returned by XAccessibleText::getCharacterBounds. The method XAccessibleText::getIndexAtPoint, however, can be implemented in a more efficient way.

Returns the portion of the text that is selected.

Returns the index of the start of the selected text.

Returns the index of the end of the selected text.

Sets the selected text portion according to the given indices. The old selection is replaced by the new selection.

The selection encompasses the same string of text that XAccessibleText::getTextRange would have selected. See there for details.

Setting the selection may or may not change the caret position. Typically the caret is moved to the position after the second argument. When the caret is moved this is notified to the accessibility event listeners with an AccessibleEventId::ACCESSIBLE_CARET_EVENT.

Returns the complete text. This is equivalent to a call to XAccessibleText::getTextRange with the arguments zero and getCharacterCount()-1.

Returns the substring between the two given indices.

The substring starts with the character at nStartIndex (inclusive) and up to the character at nEndIndex (exclusive), if nStartIndex is less or equal nEndIndex. If nEndIndex is lower than nStartIndex, the result is the same as a call with the two arguments being exchanged.

The whole text can be requested by passing the indices zero and getCharacterCount(). If both indices have the same value, an empty string is returned.

Returns the substring of the specified text type that contains the character at the given index, if any. For example, given the text type WORD, the word which contains the character at position nIndex is returned, or an empty string if no word is found at the that position.

Returns the substring of the specified text type that is located before the given character and does not include it. The result of this method should be same as a result for XAccessibleText::getTextAtIndex with a suitably decreased index value.

For example, if text type is WORD, then the complete word that is closest to and located before nIndex is returned.

Returns the substring of the specified text type that is located after the given character and does not include it. The result of this method should be same as a result for XAccessibleText::getTextAtIndex with a suitably increased index value.

For example, if text type is WORD, then the complete word that is closest to and located behind nIndex is returned.

Copy the specified text into the clipboard. The text that is copied is the same text that would have been selected by the XAccessibleText::getTextRange method.

The other clipboard related methods XAccessibleEditableText::cutText and XAccessibleEditableText::deleteText can be found in the XAccessibleEditableText because of their destructive nature.