@Deprecated public interface ICategory extends Comparable
A category is a grouping of commands by functional area. For example, in the Eclipse workbench, "Text Editing" is a category containing various commands related to text editing. A category's primary functionality is to control the display of commands to the user. When appropriate, commands displayed to the user (e.g., keys preference page) will be grouped by category.
An instance of ICategory
is a handle representing a category
as defined by the extension point org.eclipse.ui.commands
.
The identifier of the handle is identifier of the category being represented.
An instance of ICategory
can be obtained from an instance of
ICommandManager
for any identifier, whether or not a category
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, which causes dynamic changes to the plugin registry, and therefore, potentially, dynamic changes to the set of category definitions.
This interface is not intended to be extended or implemented by clients.
ICategoryListener
,
ICommandManager
,
Category
Modifier and Type | Method and Description |
---|---|
void |
addCategoryListener(ICategoryListener categoryListener)
Deprecated.
|
String |
getDescription()
Deprecated.
|
String |
getId()
Deprecated.
|
String |
getName()
Deprecated.
|
boolean |
isDefined()
Deprecated.
|
void |
removeCategoryListener(ICategoryListener categoryListener)
Deprecated.
|
compareTo
@Deprecated void addCategoryListener(ICategoryListener categoryListener)
ICategoryListener
to listen for
changes to attributes of this instance.categoryListener
- the instance of ICategoryListener
to register.
Must not be null
. If an attempt is made to
register an instance of ICategoryListener
which is already registered with this instance, no operation
is performed.@Deprecated String getDescription() throws NotDefinedException
Returns the description of the category represented by this handle, suitable for display to the user.
Notification is sent to all registered listeners if this attribute changes.
null
.NotDefinedException
- if the category represented by this handle is not defined.@Deprecated String getId()
null
.@Deprecated String getName() throws NotDefinedException
Returns the name of the category represented by this handle, suitable for display to the user.
Notification is sent to all registered listeners if this attribute changes.
null
.NotDefinedException
- if the category represented by this handle is not defined.@Deprecated boolean isDefined()
Returns whether or not the category represented by this handle is defined.
Notification is sent to all registered listeners if this attribute changes.
true
, iff the category represented by this
handle is defined.@Deprecated void removeCategoryListener(ICategoryListener categoryListener)
ICategoryListener
listening
for changes to attributes of this instance.categoryListener
- the instance of ICategoryListener
to
unregister. Must not be null
. If an attempt
is made to unregister an instance of ICategoryListener
which is not already registered with this instance, no
operation is performed.
Copyright (c) 2000, 2014 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.