Package org.eclipse.ui.contexts
Class EnabledSubmission
- java.lang.Object
-
- org.eclipse.ui.contexts.EnabledSubmission
-
- All Implemented Interfaces:
Comparable
@Deprecated public final class EnabledSubmission extends Object implements Comparable
Deprecated.Please useIContextService.activateContext
instead.An instance of this class represents a request to enabled a context. An enabled submission specifies a list of conditions under which it would be appropriate for a particular context to be enabled. These conditions include things like the active part or the active shell. So, it is possible to say things like: "when the java editor is active, please consider enabling the 'editing java' context".
The workbench considers all of the submissions it has received and choses the ones it views as the best possible match.
This class is not intended to be extended by clients.
Note: this class has a natural ordering that is inconsistent with equals.
- Since:
- 3.0
- See Also:
IWorkbenchContextSupport
,IContextService
-
-
Constructor Summary
Constructors Constructor Description EnabledSubmission(String activePartId, Shell activeShell, IWorkbenchPartSite activeWorkbenchPartSite, String contextId)
Deprecated.Creates a new instance of this class.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description int
compareTo(Object object)
Deprecated.String
getActivePartId()
Deprecated.Returns the identifier of the part that must be active for this request to be considered.Shell
getActiveShell()
Deprecated.Returns the shell that must be active for this request to be considered.IWorkbenchPartSite
getActiveWorkbenchPartSite()
Deprecated.Returns the workbench part site of the part that must be active for this request to be considered.String
getContextId()
Deprecated.Returns the identifier of the context to be enabled.String
toString()
Deprecated.
-
-
-
Constructor Detail
-
EnabledSubmission
public EnabledSubmission(String activePartId, Shell activeShell, IWorkbenchPartSite activeWorkbenchPartSite, String contextId)
Deprecated.Creates a new instance of this class.- Parameters:
activePartId
- the identifier of the part that must be active for this request to be considered. May benull
.activeShell
- the shell that must be active for this request to be considered. May benull
.activeWorkbenchPartSite
- the workbench part site of the part that must be active for this request to be considered. May benull
.contextId
- the identifier of the context to be enabled. Must not benull
.
-
-
Method Detail
-
compareTo
public int compareTo(Object object)
Deprecated.- Specified by:
compareTo
in interfaceComparable
- See Also:
Comparable.compareTo(java.lang.Object)
-
getActivePartId
public String getActivePartId()
Deprecated.Returns the identifier of the part that must be active for this request to be considered.- Returns:
- the identifier of the part that must be active for this request to be
considered. May be
null
.
-
getActiveShell
public Shell getActiveShell()
Deprecated.Returns the shell that must be active for this request to be considered.- Returns:
- the shell that must be active for this request to be considered. May
be
null
.
-
getActiveWorkbenchPartSite
public IWorkbenchPartSite getActiveWorkbenchPartSite()
Deprecated.Returns the workbench part site of the part that must be active for this request to be considered.- Returns:
- the workbench part site of the part that must be active for this
request to be considered. May be
null
.
-
getContextId
public String getContextId()
Deprecated.Returns the identifier of the context to be enabled.- Returns:
- the identifier of the context to be enabled. Guaranteed not to be
null
.
-
toString
public String toString()
Deprecated.- Overrides:
toString
in classObject
- See Also:
Object.toString()
-
-