Interface IContext
- All Superinterfaces:
Comparable
org.eclipse.ui.contexts
.
An instance of this interface can be obtained from an instance of
IContextManager
for any identifier, whether or not an context
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. If a context is defined, that means that
its corresponding plug-in is active. If the plug-in is then deactivated, the
context will still exist but it will be undefined. An attempts to use an
undefined context will result in a NotDefinedException
being
thrown.
This interface is not intended to be extended or implemented by clients.
- Since:
- 3.0
- See Also:
- Restriction:
- This interface is not intended to be implemented by clients.
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addContextListener
(IContextListener contextListener) Deprecated.Registers an instance ofIContextListener
to listen for changes to properties of this instance.getId()
Deprecated.Returns the identifier of this instance.getName()
Deprecated.Returns the name of this instance suitable for display to the user.Deprecated.Returns the identifier of the parent of this instance.boolean
Deprecated.Returns whether or not this instance is defined.boolean
Deprecated.Returns whether or not this instance is enabled.void
removeContextListener
(IContextListener contextListener) Deprecated.Unregisters an instance ofIContextListener
listening for changes to properties of this instance.Methods inherited from interface java.lang.Comparable
compareTo
-
Method Details
-
addContextListener
Deprecated.Registers an instance ofIContextListener
to listen for changes to properties of this instance.- Parameters:
contextListener
- the instance to register. Must not benull
. If an attempt is made to register an instance which is already registered with this instance, no operation is performed.
-
getId
String getId()Deprecated.Returns the identifier of this instance.- Returns:
- the identifier of this instance. Guaranteed not to be
null
.
-
getName
Deprecated.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.
-
getParentId
Deprecated.Returns the identifier of the parent of this instance.Notification is sent to all registered listeners if this property changes.
- Returns:
- the identifier of the parent of this instance. May be
null
. - Throws:
NotDefinedException
- if this instance is not defined.
-
isDefined
boolean isDefined()Deprecated.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.
-
isEnabled
boolean isEnabled()Deprecated.Returns whether or not this instance is enabled.Notification is sent to all registered listeners if this property changes.
- Returns:
- true, iff this instance is enabled.
-
removeContextListener
Deprecated.Unregisters an instance ofIContextListener
listening for changes to properties of this instance.- Parameters:
contextListener
- the instance to unregister. Must not benull
. If an attempt is made to unregister an instance which is not already registered with this instance, no operation is performed.
-