| org.eclipse.ui.keys.IBindingService
All known Subclasses: org.eclipse.ui.internal.keys.BindingService,
| IBindingService | | public interface IBindingService extends IDisposable(Code) | |
Provides services related to the binding architecture (e.g., keyboard
shortcuts) within the workbench. This service can be used to access the
currently active bindings, as well as the current state of the binding
architecture.
This interface should not be implemented or extended by clients.
since:
3.1 |
| Method Summary | |
| public TriggerSequence[] | getActiveBindingsFor(ParameterizedCommand parameterizedCommand)
Gets the active bindings for a given parameterized command.
Parameters:
parameterizedCommand - The fully-parameterized command for which the active bindingsshould be found; must not be null. | | public TriggerSequence[] | getActiveBindingsFor(String commandId)
Gets the active bindings for a given command identifier. | | public Scheme | getActiveScheme()
Returns the currently active scheme.
The currently active scheme. | | public TriggerSequence | getBestActiveBindingFor(String commandId)
Gets the best active binding for a command. | | public String | getBestActiveBindingFormattedFor(String commandId)
Gets the formatted string representing the best active binding for a
command. | | public Binding[] | getBindings()
Returns the current set of bindings. | | public TriggerSequence | getBuffer()
Returns the current state of the key binding buffer. | | public String | getDefaultSchemeId()
Returns the default scheme identifier for the currently running
application. | | public Scheme[] | getDefinedSchemes()
Returns the array of defined schemes in the workbench. | | public String | getLocale()
Returns the currently active locale. | | public Map | getPartialMatches(TriggerSequence trigger)
Returns all of the possible bindings that start with the given trigger
(but are not equal to the given trigger).
Parameters:
trigger - The prefix to look for; must not be null. | | public Binding | getPerfectMatch(TriggerSequence trigger)
Returns the command identifier for the active binding matching this
trigger, if any.
Parameters:
trigger - The trigger to match; may be null. | | public String | getPlatform()
Returns the currently active platform. | | public Scheme | getScheme(String schemeId)
Retrieves the scheme with the given identifier. | | public boolean | isKeyFilterEnabled()
Tests whether the global key binding architecture is currently active. | | public boolean | isPartialMatch(TriggerSequence trigger)
Returns whether the given trigger sequence is a partial match for the
given sequence.
Parameters:
trigger - The sequence which should be the prefix for some binding;should not be null. | | public boolean | isPerfectMatch(TriggerSequence trigger)
Returns whether the given trigger sequence is a perfect match for the
given sequence.
Parameters:
trigger - The sequence which should match exactly; should not benull. | | public void | openKeyAssistDialog()
Opens the key assistant dialog positioned near the key binding entry in
the status bar. | | public void | readRegistryAndPreferences(ICommandService commandService)
Reads the binding information from the registry and the preferences. | | public void | savePreferences(Scheme activeScheme, Binding[] bindings)
Writes the given active scheme and bindings to the preference store. | | public void | setKeyFilterEnabled(boolean enabled)
Enables or disables the global key binding architecture. |
| DEFAULT_DEFAULT_ACTIVE_SCHEME_ID | | final public static String DEFAULT_DEFAULT_ACTIVE_SCHEME_ID(Code) | | The default default value for the active scheme id. This value can be
overridden using the "plugin_customization.ini" file. The
BindingPersistence code needs to know this value so it can
try to decide if someone overrode the default.
|
| getActiveBindingsFor | | public TriggerSequence[] getActiveBindingsFor(ParameterizedCommand parameterizedCommand)(Code) | | Gets the active bindings for a given parameterized command.
Parameters:
parameterizedCommand - The fully-parameterized command for which the active bindingsshould be found; must not be null. The array of all active bindings for the given command. Thiscollection may be empty, but it is never null. |
| getActiveBindingsFor | | public TriggerSequence[] getActiveBindingsFor(String commandId)(Code) | | Gets the active bindings for a given command identifier. It is assumed
that the command has no parameters.
Parameters:
commandId - The id of the command for which the active bindings should befound; must not be null. The array of all active bindings for the given command. Thiscollection may be empty, but it is never null. |
| getActiveScheme | | public Scheme getActiveScheme()(Code) | | Returns the currently active scheme.
The currently active scheme. This value may (in certain rarecircumstances) be null. |
| getBestActiveBindingFor | | public TriggerSequence getBestActiveBindingFor(String commandId)(Code) | | Gets the best active binding for a command. The best binding is the one
that would be most appropriate to show in a menu. Bindings which belong
to a child scheme are given preference over those in a parent scheme.
Bindings which belong to a particular locale or platform are given
preference over those that do not. The rest of the calculaton is based
most on various concepts of "length", as well as giving some modifier
keys preference (e.g., Alt is less likely to appear than
Ctrl).
Parameters:
commandId - The identifier of the command for which the best activebinding should be retrieved; must not be null. The trigger sequence for the best binding; may benull if no bindings are active for the givencommand.
since:
3.2 |
| getBestActiveBindingFormattedFor | | public String getBestActiveBindingFormattedFor(String commandId)(Code) | | Gets the formatted string representing the best active binding for a
command. The best binding is the one that would be most appropriate to
show in a menu. Bindings which belong to a child scheme are given
preference over those in a parent scheme. The rest of the calculaton is
based most on various concepts of "length", as well as giving some
modifier keys preference (e.g., Alt is less likely to
appear than Ctrl).
Parameters:
commandId - The identifier of the command for which the best activebinding should be retrieved; must not be null. The formatted string for the best binding; may benull if no bindings are active for the givencommand.
since:
3.2 |
| getBindings | | public Binding[] getBindings()(Code) | | Returns the current set of bindings.
The current array of bindings (Binding). |
| getBuffer | | public TriggerSequence getBuffer()(Code) | | Returns the current state of the key binding buffer. This will contain
all of the keys currently awaiting processing. If the system is currently
executing a command (as a result of a key press), then this will contain
the trigger sequence used to execute the command. If the key binding
architecture has seen part of multi-key binding, then this will contain
the part that it has seen. Otherwise, this will return nothing.
The trigger sequence indicating the current state of the keybinding buffer; never null, but may be empty ifthere is nothing in the buffer.
since:
3.2 |
| getDefaultSchemeId | | public String getDefaultSchemeId()(Code) | | Returns the default scheme identifier for the currently running
application.
The default scheme identifier (String); nevernull, but may be empty or point to an undefinedscheme. |
| getDefinedSchemes | | public Scheme[] getDefinedSchemes()(Code) | | Returns the array of defined schemes in the workbench.
The array of schemes (Scheme) that are defined;it may be null, and it may be empty. |
| getLocale | | public String getLocale()(Code) | | Returns the currently active locale.
The current locale. |
| getPartialMatches | | public Map getPartialMatches(TriggerSequence trigger)(Code) | | Returns all of the possible bindings that start with the given trigger
(but are not equal to the given trigger).
Parameters:
trigger - The prefix to look for; must not be null. A map of triggers (TriggerSequence) to bindings (Binding).This map may be empty, but it is never null. |
| getPerfectMatch | | public Binding getPerfectMatch(TriggerSequence trigger)(Code) | | Returns the command identifier for the active binding matching this
trigger, if any.
Parameters:
trigger - The trigger to match; may be null. The binding that matches, if any; null otherwise. |
| getPlatform | | public String getPlatform()(Code) | | Returns the currently active platform.
The current platform. |
| getScheme | | public Scheme getScheme(String schemeId)(Code) | | Retrieves the scheme with the given identifier. If no such scheme exists,
then an undefined scheme with the given id is created.
Parameters:
schemeId - The identifier to find; must not be null. A scheme with the given identifier, either defined or undefined. |
| isKeyFilterEnabled | | public boolean isKeyFilterEnabled()(Code) | | Tests whether the global key binding architecture is currently active.
true if the key bindings are active;false otherwise. |
| isPartialMatch | | public boolean isPartialMatch(TriggerSequence trigger)(Code) | | Returns whether the given trigger sequence is a partial match for the
given sequence.
Parameters:
trigger - The sequence which should be the prefix for some binding;should not be null. true if the trigger can be found in the activebindings; false otherwise. |
| isPerfectMatch | | public boolean isPerfectMatch(TriggerSequence trigger)(Code) | | Returns whether the given trigger sequence is a perfect match for the
given sequence.
Parameters:
trigger - The sequence which should match exactly; should not benull. true if the trigger can be found in the activebindings; false otherwise. |
| openKeyAssistDialog | | public void openKeyAssistDialog()(Code) | | Opens the key assistant dialog positioned near the key binding entry in
the status bar.
|
| readRegistryAndPreferences | | public void readRegistryAndPreferences(ICommandService commandService)(Code) | |
Reads the binding information from the registry and the preferences. This
will overwrite any of the existing information in the binding service.
This method is intended to be called during start-up. When this method
completes, this binding service will reflect the current state of the
registry and preference store.
Parameters:
commandService - Ignored. |
| savePreferences | | public void savePreferences(Scheme activeScheme, Binding[] bindings) throws IOException(Code) | |
Writes the given active scheme and bindings to the preference store. Only
the bindings that are of the Binding.USER type will be
written; the others will be ignored. This should only be used by
applications trying to persist user preferences. If you are trying to
change the active scheme as an RCP application, then you should be using
the plugin_customization.ini file. If you are trying to
switch between groups of bindings dynamically, you should be using
contexts.
This method also updates the active scheme and bindings in the system to
match those written to the preference store.
Parameters:
activeScheme - The scheme which should be persisted; may be null.
Parameters:
bindings - The bindings which should be persisted; may benull.
throws:
IOException - If something goes wrong while writing to the preferencestore.
See Also: org.eclipse.ui.IWorkbenchPreferenceConstants
See Also: org.eclipse.ui.contexts.IContextService |
| setKeyFilterEnabled | | public void setKeyFilterEnabled(boolean enabled)(Code) | |
Enables or disables the global key binding architecture. The architecture
should be enabled by default.
When enabled, keyboard shortcuts are active, and that key events can
trigger commands. This also means that widgets may not see all key events
(as they might be trapped as a keyboard shortcut).
When disabled, no key events will trapped as keyboard shortcuts, and that
no commands can be triggered by keyboard events. (Exception: it is
possible that someone listening for key events on a widget could trigger
a command.)
Parameters:
enabled - Whether the key filter should be enabled. |
|
|