com.yworks.yfiles.view.input

Class KeyboardInputModeBinding

java.lang.Object

com.yworks.yfiles.view.input.KeyboardInputModeBinding

Direct Known Subclasses:

KeyboardInputModeCommandBinding, KeyboardInputModeKeyBinding, KeyboardInputModeRecognizerBinding

public abstract class KeyboardInputModeBinding
extends Object

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

Instances of this class can only be obtained from KeyboardInputMode.addCommandBinding(ICommand, KeyboardInputMode.ExecuteCommandHandler, KeyboardInputMode.CanExecuteCommandHandler), KeyboardInputMode.addKeyBinding(javafx.scene.input.KeyCode, com.yworks.yfiles.view.ModifierKeys, ICommand, java.lang.Object), and KeyboardInputMode.addRecognizerBinding(IEventRecognizer, ICommand, java.lang.Object). Removing the instances is done via the instance method remove() of this type.

Method Summary

Modifier and Type	Method and Description
abstract ICommand	getCommand() Gets the ICommand that is associated with this binding.
KeyboardInputMode	getKeyboardInputMode() Returns the keyboard input mode for which this binding was created.
abstract void	remove() Removes the binding represented by this instance from the KeyboardInputMode it has been created for.

Methods inherited from class java.lang.Object

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

Method Detail

getCommand

public abstract ICommand getCommand()

Gets the ICommand that is associated with this binding.

Returns:

The command instance.

getKeyboardInputMode

public KeyboardInputMode getKeyboardInputMode()

Returns the keyboard input mode for which this binding was created.

Returns:

The associated keyboard input mode instance or null if this binding has been removed already.

remove

public abstract void remove()

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

Once this method has been called, the associated keyboard input mode instance will be null.