org.eclipse.ui.commands
Interface IKeyConfiguration
-
All Superinterfaces:
-
Comparable
Deprecated. Please use the bindings support in the "org.eclipse.jface"
plug-in instead.
-
public interface IKeyConfiguration
- extends
Comparable
An instance of IKeyConfiguration
is a handle representing a
key configuration as defined by the extension point
org.eclipse.ui.commands
. The identifier of the handle is
identifier of the key configuration being represented.
An instance of IKeyConfiguration
can be obtained from an
instance of ICommandManager
for any identifier, whether or not
a key configuration with that identifier defined in the plugin registry.
The handle-based nature of this API allows it to work well with runtime
plugin activation and deactivation. If a key configuration is defined, that
means that its corresponding plug-in is active. If the plug-in is then
deactivated, the configuration will still exist but it will be undefined.
An attempt to use an undefined key configuration will result in a
NotDefinedException
being thrown.
This interface is not intended to be extended or implemented by clients.
-
Since:
- 3.0
-
See Also:
-
IKeyConfigurationListener
,
ICommandManager
,
Scheme
-
Restriction:
- This interface is not intended to be implemented by clients.
Method Summary
|
void
|
addKeyConfigurationListener
(
IKeyConfigurationListener keyConfigurationListener)
Deprecated. Registers an instance of IKeyConfigurationListener to
listen for changes to attributes of this instance. |
String
|
getDescription
()
Deprecated.
Returns the description of the key configuration represented by this
handle, suitable for display to the user. |
String
|
getId
()
Deprecated. Returns the identifier of this handle. |
String
|
getName
()
Deprecated.
Returns the name of the key configuration represented by this handle,
suitable for display to the user. |
String
|
getParentId
()
Deprecated.
Returns the identifier of the parent of the key configuration
represented by this handle. |
boolean
|
isActive
()
Deprecated.
Returns whether or not this command is active. |
boolean
|
isDefined
()
Deprecated.
Returns whether or not the key configuration represented by this handle
is defined. |
void
|
removeKeyConfigurationListener
(
IKeyConfigurationListener keyConfigurationListener)
Deprecated. Unregisters an instance of IKeyConfigurationListener
listening for changes to attributes of this instance. |
addKeyConfigurationListener
void addKeyConfigurationListener(
IKeyConfigurationListener keyConfigurationListener)
-
Deprecated.
- Registers an instance of
IKeyConfigurationListener
to
listen for changes to attributes of this instance.
-
-
-
Parameters:
-
keyConfigurationListener
- the instance of IKeyConfigurationListener
to
register. Must not be null
. If an attempt is
made to register an instance of IKeyConfigurationListener
which is already registered with this instance, no operation
is performed.
getDescription
String getDescription()
throws
NotDefinedException
-
Deprecated.
-
Returns the description of the key configuration represented by this
handle, suitable for display to the user.
Notification is sent to all registered listeners if this attribute
changes.
-
-
-
Returns:
- the description of the key configuration represented by this
handle. Guaranteed not to be
null
.
-
Throws:
-
NotDefinedException
- if the key configuration represented by this handle is not
defined.
getId
String getId()
-
Deprecated.
- Returns the identifier of this handle.
-
-
-
Returns:
- the identifier of this handle. Guaranteed not to be
null
.
getName
String getName()
throws
NotDefinedException
-
Deprecated.
-
Returns the name of the key configuration represented by this handle,
suitable for display to the user.
Notification is sent to all registered listeners if this attribute
changes.
-
-
-
Returns:
- the name of the key configuration represented by this handle.
Guaranteed not to be
null
.
-
Throws:
-
NotDefinedException
- if the key configuration represented by this handle is not
defined.
getParentId
String getParentId()
throws
NotDefinedException
-
Deprecated.
-
Returns the identifier of the parent of the key configuration
represented by this handle.
Notification is sent to all registered listeners if this attribute
changes.
-
-
-
Returns:
- the identifier of the parent of the key configuration
represented by this handle. May be
null
.
-
Throws:
-
NotDefinedException
- if the key configuration represented by this handle is not
defined.
isActive
boolean isActive()
-
Deprecated.
-
Returns whether or not this command is active. Instances of
ICommand
are activated and deactivated by the instance of
ICommandManager
from whence they were brokered.
Notification is sent to all registered listeners if this attribute
changes.
-
-
-
Returns:
-
true
, iff this command is active.
isDefined
boolean isDefined()
-
Deprecated.
-
Returns whether or not the key configuration represented by this handle
is defined.
Notification is sent to all registered listeners if this attribute
changes.
-
-
-
Returns:
-
true
, iff the key configuration represented by
this handle is defined.
removeKeyConfigurationListener
void removeKeyConfigurationListener(
IKeyConfigurationListener keyConfigurationListener)
-
Deprecated.
- Unregisters an instance of
IKeyConfigurationListener
listening for changes to attributes of this instance.
-
-
-
Parameters:
-
keyConfigurationListener
- the instance of IKeyConfigurationListener
to
unregister. Must not be null
. If an attempt is
made to unregister an instance of
IKeyConfigurationListener
which is not already
registered with this instance, no operation is performed.
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.