org.eclipse.fx.ui.keybindings.service

Interface BindingFactory

public interface BindingFactory

Factory to create KeySequence, Binding and KeyStroke instances

Method Summary

Modifier and Type	Method and Description
Binding	createKeyBinding(TriggerSequence sequence, ParameterizedCommand command, java.lang.String schemeId, java.lang.String contextId) Create a binding between the sequence and the command
KeySequence	getKeySequenceInstance()
KeySequence	getKeySequenceInstance(KeyLookup keylookup, java.lang.String sequence) Create a key sequence from the string representation
KeySequence	getKeySequenceInstance(KeySequence keySequence, KeyStroke stroke) Create a sequence from a stroke
KeyStroke	getKeyStrokeInstance(KeyLookup lookup, int modifierKeys, int naturalKey) Create a keystroke from basic data

Method Detail

getKeySequenceInstance

KeySequence getKeySequenceInstance(KeyLookup keylookup,
                                   java.lang.String sequence)
                            throws ParseException

Create a key sequence from the string representation

Parameters:

keylookup - the key lookup

sequence - the sequence string

Returns:

the key sequence

Throws:

ParseException - if the string can not be parsed

getKeySequenceInstance

KeySequence getKeySequenceInstance()

Returns:

a default sequence

getKeySequenceInstance

KeySequence getKeySequenceInstance(KeySequence keySequence,
                                   KeyStroke stroke)

Create a sequence from a stroke

Parameters:

keySequence - the original sequence

stroke - the stroke

Returns:

the new sequence

createKeyBinding

Binding createKeyBinding(TriggerSequence sequence,
                         ParameterizedCommand command,
                         java.lang.String schemeId,
                         java.lang.String contextId)

Create a binding between the sequence and the command

Parameters:

sequence - the sequence

command - the command

schemeId - the scheme

contextId - the context id

Returns:

the binding

getKeyStrokeInstance

KeyStroke getKeyStrokeInstance(KeyLookup lookup,
                               int modifierKeys,
                               int naturalKey)

Create a keystroke from basic data

Parameters:

lookup - the lookup or keys

modifierKeys - the modifier mask

naturalKey - the natural key value

Returns:

the stroke