public interface ICategory extends Comparable
org.eclipse.ui.activities
.
An instance of this interface can be obtained from an instance of
IActivityManager
for any identifier, whether or not a category
with that identifier is defined in the extension registry.
The handle-based nature of this API allows it to work well with runtime plugin activation and deactivation, which can cause dynamic changes to the extension registry.
This interface is not intended to be extended or implemented by clients.
IActivityManager
Modifier and Type | Method and Description |
---|---|
void |
addCategoryListener(ICategoryListener categoryListener)
Registers an instance of
ICategoryListener to listen for
changes to properties of this instance. |
Set |
getCategoryActivityBindings()
Returns the set of category activity bindings for this instance.
|
String |
getDescription()
Returns the description of this instance suitable for display to the user.
|
String |
getId()
Returns the identifier of this instance.
|
String |
getName()
Returns the name of this instance suitable for display to the user.
|
boolean |
isDefined()
Returns whether or not this instance is defined.
|
void |
removeCategoryListener(ICategoryListener categoryListener)
Removes an instance of
ICategoryListener listening
for changes to properties of this instance. |
compareTo
void addCategoryListener(ICategoryListener categoryListener)
ICategoryListener
to listen for
changes to properties of this instance.categoryListener
- the instance to register. Must not be null
.
If an attempt is made to register an instance which is
already registered with this instance, no operation is
performed.Set getCategoryActivityBindings()
This method will return all category activity bindings for this instance, whether or not this instance is defined.
Notification is sent to all registered listeners if this property changes.
null
. If this set is
not empty, it is guaranteed to only contain instances of ICategoryActivityBinding
.ICategoryActivityBinding
String getId()
null
.String getName() throws NotDefinedException
Notification is sent to all registered listeners if this property changes.
null
.NotDefinedException
- if this instance is not defined.String getDescription() throws NotDefinedException
Notification is sent to all registered listeners if this property changes.
null
.NotDefinedException
- if this instance is not defined.boolean isDefined()
Notification is sent to all registered listeners if this property changes.
true
, iff this instance is defined.void removeCategoryListener(ICategoryListener categoryListener)
ICategoryListener
listening
for changes to properties of this instance.categoryListener
- the instance to remove. Must not be null
.
If an attempt is made to remove an instance which is not
already registered with this instance, no operation is
performed.
Copyright (c) 2000, 2015 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.