If the component has composed text (from the most recent * InputMethodEvent), then offset 0 indicates the location of the first * character of this composed text. Otherwise, the offset is ignored, and * the location should be the beginning of the final line of selected * text (in horizontal left-to-right text, like English, this would be the * lower left corner of the selction; in vertical top-to-bottom text, like * Chinese, this would be the top right corner of the selection). * *
The location returned is a 0-thickness caret (either horizontal or * vertical, depending on text flow), mapped to absolute screen coordinates. * * @param offset offset within composed text, or null * @return the screen location of the caret at the offset */ Rectangle getTextLocation(TextHitInfo offset); /** * Get the text offset for the given screen coordinate. The offset is * relative to the composed text, and the return is null if it is outside * the range of composed text. For example, this can be used to find * where a mouse click should pop up a text composition window. * * @param x the x screen coordinate * @param y the y screen coordinate * @return a text hit info describing the composed text offset */ TextHitInfo getLocationOffset(int x, int y); /** * Gets the offset where the committed text exists in the text editing * component. This can be used to examine the text surrounding the insert * position. * * @return the offset of the insert position */ int getInsertPositionOffset(); /** * Gets an interator which provides access to the text and its attributes, * except for the uncommitted text. The input method may provide a list of * attributes it is interested in; and the iterator need not provide * information on the remaining attributes. If the attribute list is null, * the iterator must list all attributes. * * @param beginIndex the index of the first character in the iteration * @param endIndex the index of the last character in the iteration * @param attributes a list of attributes interested in, or null * @return an iterator over the region of text with its attributes */ AttributedCharacterIterator getCommittedText(int beginIndex, int endIndex, Attribute[] attributes); /** * Gets the length of committed text. * * @return the number of committed characters */ int getCommittedTextLength(); /** * Gets the latest committed text, and removes it from the component's text * body. This allows an input method to provide an "Undo" command. In * general, this should only be supported immediately after a commit, and * not when other actions intervene; if not supported, simply return null. * The input method may provide a list of attributes it is interested in; * and the iterator need not provide information on the remaining attributes. * If the attribute list is null, the iterator must list all attributes. * * @param attributes a list of attributes interested in, or null * @return the latest committed text, or null */ AttributedCharacterIterator cancelLatestCommittedText (Attribute[] attributes); /** * Gets the currently selected text. One use of this is to implement a * "Reconvert" feature in an input method, which modifies the selection * based on the text in the composition window. The input method may * provide a list of attributes it is interested in; and the iterator need * not provide information on the remaining attributes. If the attribute * list is null, the iterator must list all attributes. * * @param attributes a list of attributes interested in, or null * @return the current selection */ AttributedCharacterIterator getSelectedText(Attribute[] attributes); } // interface InputMethodRequests