Provides commonly used predefined event recognizers that work on KeyEventArgs.
Remarks
Type Details
- yfiles module
- view-component
- yfiles-umd modules
- All view modules
- Legacy UMD name
- yfiles.input.KeyEventRecognizers
See Also
Constants
An event recognizer that recognizes when the Alt modifier is active.
Signature Details
function(eventSource: any, evt: EventArgs) : boolean
Parameters
- eventSource - any
- The source of the event.
- evt - EventArgs
- The arguments of the event to be decided to handle.
Returns
- boolean
trueif theevtis considered to be handled.
An event recognizer that recognizes when the Ctrl modifier is being pressed.
Signature Details
function(eventSource: any, evt: EventArgs) : boolean
Parameters
- eventSource - any
- The source of the event.
- evt - EventArgs
- The arguments of the event to be decided to handle.
Returns
- boolean
trueif theevtis considered to be handled.
An event recognizer that recognizes when the Ctrl modifier is active.
Signature Details
function(eventSource: any, evt: EventArgs) : boolean
Parameters
- eventSource - any
- The source of the event.
- evt - EventArgs
- The arguments of the event to be decided to handle.
Returns
- boolean
trueif theevtis considered to be handled.
An event recognizer that recognizes when the Ctrl modifier is being released.
Signature Details
function(eventSource: any, evt: EventArgs) : boolean
Parameters
- eventSource - any
- The source of the event.
- evt - EventArgs
- The arguments of the event to be decided to handle.
Returns
- boolean
trueif theevtis considered to be handled.
An event recognizer that identifies keydown of the Delete key.
Signature Details
function(eventSource: any, evt: EventArgs) : boolean
Parameters
- eventSource - any
- The source of the event.
- evt - EventArgs
- The arguments of the event to be decided to handle.
Returns
- boolean
trueif theevtis considered to be handled.
An event recognizer that identifies keydown of the Escape key.
Signature Details
function(eventSource: any, evt: EventArgs) : boolean
Parameters
- eventSource - any
- The source of the event.
- evt - EventArgs
- The arguments of the event to be decided to handle.
Returns
- boolean
trueif theevtis considered to be handled.
An event recognizer that identifies keypress of the Escape key.
Signature Details
function(eventSource: any, evt: EventArgs) : boolean
Parameters
- eventSource - any
- The source of the event.
- evt - EventArgs
- The arguments of the event to be decided to handle.
Returns
- boolean
trueif theevtis considered to be handled.
An event recognizer that identifies keyup of the Escape key.
Signature Details
function(eventSource: any, evt: EventArgs) : boolean
Parameters
- eventSource - any
- The source of the event.
- evt - EventArgs
- The arguments of the event to be decided to handle.
Returns
- boolean
trueif theevtis considered to be handled.
An event recognizer that identifies keydown of any key.
Signature Details
function(eventSource: any, evt: EventArgs) : boolean
Parameters
- eventSource - any
- The source of the event.
- evt - EventArgs
- The arguments of the event to be decided to handle.
Returns
- boolean
trueif theevtis considered to be handled.
An event recognizer that identifies keypress of any key.
Signature Details
function(eventSource: any, evt: EventArgs) : boolean
Parameters
- eventSource - any
- The source of the event.
- evt - EventArgs
- The arguments of the event to be decided to handle.
Returns
- boolean
trueif theevtis considered to be handled.
An event recognizer that identifies keyup of any key.
Signature Details
function(eventSource: any, evt: EventArgs) : boolean
Parameters
- eventSource - any
- The source of the event.
- evt - EventArgs
- The arguments of the event to be decided to handle.
Returns
- boolean
trueif theevtis considered to be handled.
An event recognizer that recognizes when the Meta modifier is active.
Remarks
Signature Details
function(eventSource: any, evt: EventArgs) : boolean
Parameters
- eventSource - any
- The source of the event.
- evt - EventArgs
- The arguments of the event to be decided to handle.
Returns
- boolean
trueif theevtis considered to be handled.
An event recognizer that recognizes when the Shift modifier is being pressed.
Signature Details
function(eventSource: any, evt: EventArgs) : boolean
Parameters
- eventSource - any
- The source of the event.
- evt - EventArgs
- The arguments of the event to be decided to handle.
Returns
- boolean
trueif theevtis considered to be handled.
An event recognizer that recognizes when the Shift modifier is active.
Signature Details
function(eventSource: any, evt: EventArgs) : boolean
Parameters
- eventSource - any
- The source of the event.
- evt - EventArgs
- The arguments of the event to be decided to handle.
Returns
- boolean
trueif theevtis considered to be handled.
An event recognizer that recognizes when the Shift modifier is being released.
Signature Details
function(eventSource: any, evt: EventArgs) : boolean
Parameters
- eventSource - any
- The source of the event.
- evt - EventArgs
- The arguments of the event to be decided to handle.
Returns
- boolean
trueif theevtis considered to be handled.
Static Methods
Creates an event recognizer for a given key and type using a given set of modifiers.
Parameters
A map of options to pass to the method.
- type - KeyEventType
- The type of the event.
- value - Key
- The key that is subject of the event.
- modifiers - ModifierKeys
- The state of the modifiers that must be set. This is NONE if not set.
Creates an event recognizer that matches if the specified keys are currently down.
Parameters
A map of options to pass to the method.
- key - Key
- The key to create the recognizer for.
- modifiers - ModifierKeys
- The modifier keys that should be down for the recognizer.
Returns
- ↪function(any, EventArgs):boolean
- An event recognizer that uses the gesture.
Signature Details
function(eventSource: any, evt: EventArgs) : booleanA callback that recognizes events.Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.Parameters
- eventSource - any
- The source of the event.
- evt - EventArgs
- The arguments of the event to be decided to handle.
Returns
- boolean
trueif theevtis considered to be handled.