org.eclipse.ui.activities
Interface ICategory
-
All Superinterfaces:
-
Comparable
-
public interface ICategory
- extends
Comparable
An instance of this interface is a category as defined by the extension
point 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.
-
Since:
- 3.0
-
See Also:
-
IActivityManager
-
Restriction:
- This interface is not intended to be implemented by clients.
addCategoryListener
void addCategoryListener(
ICategoryListener categoryListener)
- Registers an instance of
ICategoryListener
to listen for
changes to properties of this instance.
-
-
-
Parameters:
-
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.
getCategoryActivityBindings
Set getCategoryActivityBindings()
- Returns the set of category activity bindings for this instance.
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.
-
-
-
Returns:
- the set of category activity bindings. This set may be empty,
but is guaranteed not to be
null
. If this set is
not empty, it is guaranteed to only contain instances of ICategoryActivityBinding
. -
See Also:
-
ICategoryActivityBinding
getId
String getId()
- Returns the identifier of this instance.
-
-
-
Returns:
- the identifier of this instance. Guaranteed not to be
null
.
getName
String getName()
throws
NotDefinedException
- Returns the name of this instance suitable for display to the user.
Notification is sent to all registered listeners if this property
changes.
-
-
-
Returns:
- the name of this instance. Guaranteed not to be
null
.
-
Throws:
-
NotDefinedException
- if this instance is not defined.
getDescription
String getDescription()
throws
NotDefinedException
- Returns the description of this instance suitable for display to the user.
Notification is sent to all registered listeners if this property
changes.
-
-
-
Returns:
- the description of this instance. Guaranteed not to be
null
.
-
Throws:
-
NotDefinedException
- if this instance is not defined.
isDefined
boolean isDefined()
- Returns whether or not this instance is defined.
Notification is sent to all registered listeners if this property
changes.
-
-
-
Returns:
-
true
, iff this instance is defined.
removeCategoryListener
void removeCategoryListener(
ICategoryListener categoryListener)
- Removes an instance of
ICategoryListener
listening
for changes to properties of this instance.
-
-
-
Parameters:
-
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.
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.