com.yworks.yfiles.view.input

Class KeyboardInputModeKeyBinding

java.lang.Object

com.yworks.yfiles.view.input.KeyboardInputModeBinding

com.yworks.yfiles.view.input.KeyboardInputModeKeyBinding

public final class KeyboardInputModeKeyBinding
extends KeyboardInputModeBinding

A token returned by KeyboardInputMode's factory methods that can be used to remove() the created key binding again.

Instances of this class can only be obtained from KeyboardInputMode.addKeyBinding(javafx.scene.input.KeyCode, com.yworks.yfiles.view.ModifierKeys, ICommand, java.lang.Object).

Method Summary

Modifier and Type	Method and Description
KeyCodeCombination	getAccelerator() Gets the keyboard shortcut that is bound by this instance.
ICommand	getCommand() Gets the ICommand that is associated with this binding.
Object	getCommandParameter() Gets the command parameter to use for execution of the command.
void	remove() Removes the binding represented by this instance from the KeyboardInputMode it has been created for.

Methods inherited from class com.yworks.yfiles.view.input.KeyboardInputModeBinding

getKeyboardInputMode

Methods inherited from class java.lang.Object

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

Method Detail

getAccelerator

public KeyCodeCombination getAccelerator()

Gets the keyboard shortcut that is bound by this instance.

Returns:

The keyboard shortcut.

getCommand

public ICommand getCommand()

Gets the ICommand that is associated with this binding.

Specified by:

getCommand in class KeyboardInputModeBinding

Returns:

The command instance.

getCommandParameter

public final Object getCommandParameter()

Gets the command parameter to use for execution of the command.

Returns:

The command parameter to use for execution of the command.

remove

public void remove()

Removes the binding represented by this instance from the KeyboardInputMode it has been created for.

Once this method has been called, the instance can be

Specified by:

remove in class KeyboardInputModeBinding