javafx.scene

Class Scene.InputMethodRequestsDelegate

java.lang.Object

javafx.scene.Scene.InputMethodRequestsDelegate

All Implemented Interfaces:

InputMethodRequests

Enclosing class:

Scene

 class Scene.InputMethodRequestsDelegate
extends java.lang.Object
implements InputMethodRequests

Method Summary

Methods

Modifier and Type	Method and Description
void	cancelLatestCommittedText() Gets the latest committed text from the text editing node and removes it from the node's text body.
int	getLocationOffset(int x, int y) Gets the offset within the composed text for the specified absolute x and y coordinates on the screen.
java.lang.String	getSelectedText() Gets the currently selected text from the text editing node.
Point2D	getTextLocation(int offset) Gets the location of a specified offset in the current composed text, or of the selection in committed text.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getTextLocation

public Point2D getTextLocation(int offset)

Description copied from interface: InputMethodRequests

Gets the location of a specified offset in the current composed text, or of the selection in committed text. This information is, for example, used to position the candidate window near the composed text, or a composition window near the location where committed text will be inserted.

Specified by:

getTextLocation in interface InputMethodRequests

Parameters:

offset - the offset within the composed text, if there is composed text; null otherwise

Returns:

a point representing the screen location of the offset

getLocationOffset

public int getLocationOffset(int x,
                    int y)

Description copied from interface: InputMethodRequests

Gets the offset within the composed text for the specified absolute x and y coordinates on the screen. This information is used, for example to handle mouse clicks and the mouse cursor. The offset is relative to the composed text, so offset 0 indicates the beginning of the composed text.

Specified by:

getLocationOffset in interface InputMethodRequests

Parameters:

x - the absolute x coordinate on screen

y - the absolute y coordinate on screen

Returns:

the offset in the composed text.

cancelLatestCommittedText

public void cancelLatestCommittedText()

Description copied from interface: InputMethodRequests

Gets the latest committed text from the text editing node and removes it from the node's text body. This is used for the "Undo Commit" feature in some input methods, where the committed text reverts to its previous composed state. The composed text will be sent to the node using an InputMethodEvent.

Specified by:

cancelLatestCommittedText in interface InputMethodRequests

getSelectedText

public java.lang.String getSelectedText()

Description copied from interface: InputMethodRequests

Gets the currently selected text from the text editing node. This may be used for a variety of purposes. One of them is the "Reconvert" feature in some input methods. In this case, the input method will typically send an input method event to replace the selected text with composed text. Depending on the input method's capabilities, this may be the original composed text for the selected text, the latest composed text entered anywhere in the text, or a version of the text that's converted back from the selected text.

Specified by:

getSelectedText in interface InputMethodRequests

Returns:

the latest committed text, or null when the "Undo Commit" feature is not supported