JavaFX 24 · com.sun.javafx.scene.InputMethodStateManager

Used to manage a collection of scenes which must coordinate enabling input method events and retrieving InputMethodRequests. PopupWindows do not have the OS focus and rely on events being posted first to a root (non-popup) scene and then routed through the PopupWindow stack. If any PopupWindow requires input method events they must be enabled on the root scene and input method requests from that scene must be routed to the PopupWindow.

Field Summary

Modifier and Type	Field and Description
private Scene	currentEventScene The scene for which we enabled input method events.
private final ChangeListener<InputMethodRequests>	inputMethodRequestsChangedListener We listen for changes to the input method requests configuration on every scene in the stack.
private final ChangeListener<EventHandler<? super InputMethodEvent>>	onInputMethodTextChangedListener
private final WeakReference<Scene>	rootScene The root non-popup scene which the OS sends input method events to.
private final LinkedList<Scene>	scenes The scene stack including the root.
private final WeakChangeListener<InputMethodRequests>	weakInputMethodRequestsChangedListener
private final WeakChangeListener<EventHandler<? super InputMethodEvent>>	weakOnInputMethodTextChangedListener

Constructor Summary

Access	Constructor and Description
public	InputMethodStateManager(Scene the root `Scene` for which input methods should be enabled and disabled scene) Constructs a new instance.

Method Summary

Modifier and Type	Method and Description
public void	addScene(Scene scene) Add a new Scene to the stack.
public void	focusOwnerChanged(Node oldFocusOwner, Node newFocusOwner) Every Scene must call this when the focusOwner changes.
public void	focusOwnerWillChangeForScene(Scene scene) Every Scene must call this before the focusOwner changes.
public InputMethodRequests	getInputMethodRequests()
public Scene	getRootScene()
public void	removeScene(Scene scene) Remove a Scene from the stack.
private void	updateInputMethodEventEnableState()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

currentEventScene	back to summary
private Scene currentEventScene The scene for which we enabled input method events.

inputMethodRequestsChangedListener	back to summary
private final ChangeListener<InputMethodRequests> inputMethodRequestsChangedListener We listen for changes to the input method requests configuration on every scene in the stack.

onInputMethodTextChangedListener	back to summary
private final ChangeListener<EventHandler<? super InputMethodEvent>> onInputMethodTextChangedListener

rootScene	back to summary
private final WeakReference<Scene> rootScene The root non-popup scene which the OS sends input method events to.

scenes	back to summary
private final LinkedList<Scene> scenes The scene stack including the root.

weakInputMethodRequestsChangedListener	back to summary
private final WeakChangeListener<InputMethodRequests> weakInputMethodRequestsChangedListener

weakOnInputMethodTextChangedListener	back to summary
private final WeakChangeListener<EventHandler<? super InputMethodEvent>> weakOnInputMethodTextChangedListener

Constructor Detail

InputMethodStateManager back to summary

InputMethodStateManager	back to summary
public InputMethodStateManager(Scene scene) Constructs a new instance. Only root (non-popup) scenes should do this. Parameters scene:Scene the root `Scene` for which input methods should be enabled and disabled

public InputMethodStateManager(Scene scene)

Constructs a new instance. Only root (non-popup) scenes should do this.

Parameters

scene:Scene: the root Scene for which input methods should be enabled and disabled

Method Detail

addScene	back to summary
public void addScene(Scene scene) Add a new Scene to the stack.

focusOwnerChanged	back to summary
public void focusOwnerChanged(Node oldFocusOwner, Node newFocusOwner) Every Scene must call this when the focusOwner changes.

focusOwnerWillChangeForScene	back to summary
public void focusOwnerWillChangeForScene(Scene scene) Every Scene must call this before the focusOwner changes.

getInputMethodRequests	back to summary
public InputMethodRequests getInputMethodRequests()

getRootScene	back to summary
public Scene getRootScene()

removeScene	back to summary
public void removeScene(Scene scene) Remove a Scene from the stack.