| org.eclipse.ui.activities.IActivity
All known Subclasses: org.eclipse.ui.internal.activities.ws.CategorizedActivity, org.eclipse.ui.internal.activities.Activity,
| IActivity | | public interface IActivity extends Comparable(Code) | | An instance of this interface is an activity 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 an activity
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. A client may get an IActivity handle that
is currently undefined (
IActivity.isDefined() equals false) and
listen for it to become defined.
This interface is not intended to be extended or implemented by clients.
since:
3.0
See Also: IActivityManager |
| Method Summary | |
| void | addActivityListener(IActivityListener activityListener)
Registers an instance of IActivityListener to listen for
changes to properties of this instance.
Parameters:
activityListener - the instance to register. | | Set | getActivityPatternBindings()
Returns the set of activity pattern bindings for this instance.
This method will return all activity pattern bindings for this instance,
whether or not this instance is defined.
Notification is sent to all registered listeners if this property
changes.
the set of activity pattern bindings. | | Set | getActivityRequirementBindings()
Returns the set of activity requirement bindings for this instance.
This method will return all activity requirement bindings for this
instance, whether or not this instance is defined.
Notification is sent to all registered listeners if this property
changes.
the set of activity requirement bindings. | | String | getDescription()
Returns the description of this instance suitable for display to the user.
Notification is sent to all registered listeners if this property
changes.
the description of this instance. | | String | getId()
Returns the identifier of this instance.
the identifier of this instance. | | String | getName()
Returns the name of this instance suitable for display to the user.
Notification is sent to all registered listeners if this property
changes.
the name of this instance. | | boolean | isDefaultEnabled()
Returns whether or not this instance should be enabled by default.
true, iff this instance should be enabled by default.
throws:
NotDefinedException - if this instance is not defined. | | boolean | isDefined()
Returns whether or not this instance is defined. | | boolean | isEnabled()
Returns whether or not this instance is enabled. | | void | removeActivityListener(IActivityListener activityListener)
Removes an instance of IActivityListener listening
for changes to properties of this instance.
Parameters:
activityListener - the instance to remove. |
| addActivityListener | | void addActivityListener(IActivityListener activityListener)(Code) | | Registers an instance of IActivityListener to listen for
changes to properties of this instance.
Parameters:
activityListener - the instance to register. Must not be null.If an attempt is made to register an instance which isalready registered with this instance, no operation isperformed. |
| getActivityPatternBindings | | Set getActivityPatternBindings()(Code) | | Returns the set of activity pattern bindings for this instance.
This method will return all activity pattern bindings for this instance,
whether or not this instance is defined.
Notification is sent to all registered listeners if this property
changes.
the set of activity pattern bindings. This set may be empty, butis guaranteed not to be null. If this set is notempty, it is guaranteed to only contain instances of IActivityPatternBinding.
See Also: IActivityPatternBinding |
| getActivityRequirementBindings | | Set getActivityRequirementBindings()(Code) | | Returns the set of activity requirement bindings for this instance.
This method will return all activity requirement bindings for this
instance, whether or not this instance is defined.
Notification is sent to all registered listeners if this property
changes.
the set of activity requirement bindings. This set may be empty,but is guaranteed not to be null. If this set isnot empty, it is guaranteed to only contain instances of IActivityRequirementBinding.
See Also: IActivityRequirementBinding |
| getDescription | | String getDescription() throws NotDefinedException(Code) | | Returns the description of this instance suitable for display to the user.
Notification is sent to all registered listeners if this property
changes.
the description of this instance. Guaranteed not to be null.
throws:
NotDefinedException - if this instance is not defined. |
| getId | | String getId()(Code) | | Returns the identifier of this instance.
the identifier of this instance. Guaranteed not to be null. |
| getName | | String getName() throws NotDefinedException(Code) | | Returns the name of this instance suitable for display to the user.
Notification is sent to all registered listeners if this property
changes.
the name of this instance. Guaranteed not to be null.
throws:
NotDefinedException - if this instance is not defined. |
| isDefaultEnabled | | boolean isDefaultEnabled() throws NotDefinedException(Code) | | Returns whether or not this instance should be enabled by default.
true, iff this instance should be enabled by default.
throws:
NotDefinedException - if this instance is not defined.
since:
3.1 |
| isDefined | | boolean isDefined()(Code) | | Returns whether or not this instance is defined. A defined activity
may have a name, description and bindings (both pattern and relational).
Notification is sent to all registered listeners if this property
changes.
true, iff this instance is defined. |
| isEnabled | | boolean isEnabled()(Code) | | Returns whether or not this instance is enabled.
Notification is sent to all registered listeners if this property
changes.
true, iff this instance is enabled. |
| removeActivityListener | | void removeActivityListener(IActivityListener activityListener)(Code) | | Removes an instance of IActivityListener listening
for changes to properties of this instance.
Parameters:
activityListener - the instance to remove. Must not be null.If an attempt is made to remove an instance which is notalready registered with this instance, no operation isperformed. |
|
|