|
org.eclipse.jface.bindings.keys
Class KeyBinding
java.lang.Object
org.eclipse.jface.bindings.Binding
org.eclipse.jface.bindings.keys.KeyBinding
-
public final class KeyBinding
- extends
Binding
A keyboard shortcut. This is a binding between some keyboard input and the
triggering of a command. This object is immutable.
-
Since:
- 3.1
KeyBinding
public KeyBinding(
KeySequence keySequence,
ParameterizedCommand command,
String schemeId,
String contextId,
String locale,
String platform,
String windowManager,
int type)
- Constructs a new instance of
KeyBinding .
-
Parameters:
-
keySequence - The key sequence which should trigger this binding. This value
must not be null . It also must be a complete,
non-empty key sequence. -
command - The parameterized command to which this binding applies; this
value may be null if the binding is meant to
"unbind" a previously defined binding. -
schemeId - The scheme to which this binding belongs; this value must not
be null . -
contextId - The context to which this binding applies; this value must not
be null . -
locale - The locale to which this binding applies; this value may be
null if it applies to all locales. -
platform - The platform to which this binding applies; this value may be
null if it applies to all platforms. -
windowManager - The window manager to which this binding applies; this value
may be null if it applies to all window
managers. This value is currently ignored. -
type - The type of binding. This should be either SYSTEM
or USER .
getKeySequence
public final
KeySequence getKeySequence()
- Returns the key sequence which triggers this binding. The key sequence
will not be
null , empty or incomplete.
-
-
Returns:
- The key sequence; never
null .
getTriggerSequence
public
TriggerSequence getTriggerSequence()
-
Description copied from class:
Binding
- Returns the sequence of trigger for a given binding. The triggers can be
anything, but above all it must be hashable. This trigger sequence is
used by the binding manager to distinguish between different bindings.
-
-
Specified by:
-
getTriggerSequence
in class
Binding
-
-
Returns:
- The object representing an input event that will trigger this
binding; must not be
null .
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.
|
|