org.eclipse.fx.ui.keybindings.e4

Interface EBindingService

public interface EBindingService

Service to interact with key bindings

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACTIVE_SCHEME_TAG Tag used for the active scheme
static java.lang.String	DEFAULT_SCHEME_ID Name of the default scheme
static java.lang.String	DELETED_BINDING_TAG Tag prefix for the deleted
static java.lang.String	DIALOG_CONTEXT_ID The id used in the context
static java.lang.String	LOCALE_ATTR_TAG Tag prefix for the locale
static java.lang.String	MODEL_TO_BINDING_KEY Key used to store the binding in the transient map
static java.lang.String	PLATFORM_ATTR_TAG Tag prefix for the platform
static java.lang.String	SCHEME_ID_ATTR_TAG Tag prefix for the scheme
static java.lang.String	TYPE_ATTR_TAG Tag prefix for the type

Method Summary

Modifier and Type	Method and Description
void	activateBinding(@NonNull Binding binding) Activate the binding
Binding	createBinding(@NonNull TriggerSequence sequence, @NonNull org.eclipse.core.commands.ParameterizedCommand command, @NonNull java.lang.String contextId, @NonNull java.util.Map<java.lang.String,java.lang.String> attributes) Create a binding between a sequence and a command
@Nullable TriggerSequence	createSequence(@NonNull java.lang.String sequence) Create a trigger sequence from a string definition
void	deactivateBinding(@NonNull Binding binding) Deactivate the binding
@NonNull java.util.Collection<Binding>	getActiveBindings()
@NonNull java.util.Collection<Binding>	getAllConflicts()
@Nullable TriggerSequence	getBestSequenceFor(@NonNull org.eclipse.core.commands.ParameterizedCommand command) Find the best sequence for the command
@NonNull java.util.Collection<Binding>	getBindingsFor(@NonNull org.eclipse.core.commands.ParameterizedCommand cmd) Find all bindings for the command
@Nullable java.util.Collection<Binding>	getConflictsFor(@NonNull TriggerSequence sequence) Get the conflicts for a sequence
@NonNull java.util.Collection<Binding>	getPartialMatches(@NonNull TriggerSequence sequence) Find all partial matches
@Nullable Binding	getPerfectMatch(@NonNull TriggerSequence trigger) Get the perfect match for the trigger
@NonNull java.util.Collection<TriggerSequence>	getSequencesFor(@NonNull org.eclipse.core.commands.ParameterizedCommand command) Find all sequences for the give command
boolean	isPartialMatch(@NonNull TriggerSequence keySequence) Check if the sequence is partially matched
boolean	isPerfectMatch(@NonNull TriggerSequence sequence) Check if there is a perfect match

Field Detail

DIALOG_CONTEXT_ID

static final java.lang.String DIALOG_CONTEXT_ID

The id used in the context

See Also:

Constant Field Values

DEFAULT_SCHEME_ID

static final java.lang.String DEFAULT_SCHEME_ID

Name of the default scheme

See Also:

Constant Field Values

MODEL_TO_BINDING_KEY

static final java.lang.String MODEL_TO_BINDING_KEY

Key used to store the binding in the transient map

See Also:

Constant Field Values

ACTIVE_SCHEME_TAG

static final java.lang.String ACTIVE_SCHEME_TAG

Tag used for the active scheme

See Also:

Constant Field Values

SCHEME_ID_ATTR_TAG

static final java.lang.String SCHEME_ID_ATTR_TAG

Tag prefix for the scheme

See Also:

Constant Field Values

LOCALE_ATTR_TAG

static final java.lang.String LOCALE_ATTR_TAG

Tag prefix for the locale

See Also:

Constant Field Values

PLATFORM_ATTR_TAG

static final java.lang.String PLATFORM_ATTR_TAG

Tag prefix for the platform

See Also:

Constant Field Values

TYPE_ATTR_TAG

static final java.lang.String TYPE_ATTR_TAG

Tag prefix for the type

See Also:

Constant Field Values

DELETED_BINDING_TAG

static final java.lang.String DELETED_BINDING_TAG

Tag prefix for the deleted

See Also:

Constant Field Values

Method Detail

createBinding

Binding createBinding(@NonNull TriggerSequence sequence,
                      @NonNull org.eclipse.core.commands.ParameterizedCommand command,
                      @NonNull java.lang.String contextId,
                      @NonNull java.util.Map<java.lang.String,java.lang.String> attributes)

Create a binding between a sequence and a command

Parameters:

sequence - the sequence

command - the command

contextId - the context id

attributes - the attributes

Returns:

the binding

activateBinding

void activateBinding(@NonNull Binding binding)

Activate the binding

Parameters:

binding - the binding to activate

deactivateBinding

void deactivateBinding(@NonNull Binding binding)

Deactivate the binding

Parameters:

binding - the binding to deactivate

createSequence

@Nullable TriggerSequence createSequence(@NonNull java.lang.String sequence)

Create a trigger sequence from a string definition

Parameters:

sequence - a string definition

Returns:

a trigger sequence

getConflictsFor

@Nullable java.util.Collection<Binding> getConflictsFor(@NonNull TriggerSequence sequence)

Get the conflicts for a sequence

Parameters:

sequence - the sequence

Returns:

the bindings

getAllConflicts

@NonNull java.util.Collection<Binding> getAllConflicts()

Returns:

all conflicts

getPerfectMatch

@Nullable Binding getPerfectMatch(@NonNull TriggerSequence trigger)

Get the perfect match for the trigger

Parameters:

trigger - the trigger

Returns:

the binding

isPartialMatch

boolean isPartialMatch(@NonNull TriggerSequence keySequence)

Check if the sequence is partially matched

Parameters:

keySequence - the sequence

Returns:

true if a partial match

isPerfectMatch

boolean isPerfectMatch(@NonNull TriggerSequence sequence)

Check if there is a perfect match

Parameters:

sequence - the sequence

Returns:

true if a perfect match

getBestSequenceFor

@Nullable TriggerSequence getBestSequenceFor(@NonNull org.eclipse.core.commands.ParameterizedCommand command)

Find the best sequence for the command

Parameters:

command - the command

Returns:

the sequence

getSequencesFor

@NonNull java.util.Collection<TriggerSequence> getSequencesFor(@NonNull org.eclipse.core.commands.ParameterizedCommand command)

Find all sequences for the give command

Parameters:

command - the command

Returns:

all sequences

getPartialMatches

@NonNull java.util.Collection<Binding> getPartialMatches(@NonNull TriggerSequence sequence)

Find all partial matches

Parameters:

sequence - the sequence

Returns:

the matches

getActiveBindings

@NonNull java.util.Collection<Binding> getActiveBindings()

Returns:

all active bindings

getBindingsFor

@NonNull java.util.Collection<Binding> getBindingsFor(@NonNull org.eclipse.core.commands.ParameterizedCommand cmd)

Find all bindings for the command

Parameters:

cmd - the command

Returns:

the bindings