|
Eclipse Platform Release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
IActivityManager
Method Summary | |
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. |
Methods inherited from interface java.lang.Comparable |
compareTo |
Method Detail |
public 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.public 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
public String getId()
null
.public String getName() throws NotDefinedException
Notification is sent to all registered listeners if this property changes.
null
.
NotDefinedException
- if this instance is not defined.public String getDescription() throws NotDefinedException
Notification is sent to all registered listeners if this property changes.
null
.
NotDefinedException
- if this instance is not defined.public boolean isDefined()
Notification is sent to all registered listeners if this property changes.
true
, iff this instance is defined.public 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.
|
Eclipse Platform Release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2004. All rights reserved.