|
| |
|
| java.lang.Object
 org.eclipse.ui.contexts.EnabledSubmission
| EnabledSubmission | | final public class EnabledSubmission implements Comparable(Code) | |
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
See Also: org.eclipse.ui.contexts.IContextService |
| Constructor Summary | |
| public | EnabledSubmission(String activePartId, Shell activeShell, IWorkbenchPartSite activeWorkbenchPartSite, String contextId)
Creates a new instance of this class.
Parameters:
activePartId - the identifier of the part that must be active for thisrequest to be considered. |
| Method Summary | |
| public int | compareTo(Object object)
| | public String | getActivePartId()
Returns the identifier of the part that must be active for this request
to be considered.
the identifier of the part that must be active for this requestto be considered. | | public Shell | getActiveShell()
Returns the shell that must be active for this request to be considered. | | public IWorkbenchPartSite | getActiveWorkbenchPartSite()
Returns the workbench part site of the part that must be active for this
request to be considered.
the workbench part site of the part that must be active for thisrequest to be considered. | | public String | getContextId()
Returns the identifier of the context to be enabled.
the identifier of the context to be enabled. | | public String | toString()
|
| EnabledSubmission | | public EnabledSubmission(String activePartId, Shell activeShell, IWorkbenchPartSite activeWorkbenchPartSite, String contextId)(Code) | | Creates a new instance of this class.
Parameters:
activePartId - the identifier of the part that must be active for thisrequest to be considered. May be null.
Parameters:
activeShell - the shell that must be active for this request to beconsidered. May be null.
Parameters:
activeWorkbenchPartSite - the workbench part site of the part that must be active forthis request to be considered. May be null.
Parameters:
contextId - the identifier of the context to be enabled. Must not benull. |
| getActivePartId | | public String getActivePartId()(Code) | | Returns the identifier of the part that must be active for this request
to be considered.
the identifier of the part that must be active for this requestto be considered. May be null. |
| getActiveShell | | public Shell getActiveShell()(Code) | | Returns the shell that must be active for this request to be considered.
the shell that must be active for this request to be considered.May be null. |
| getActiveWorkbenchPartSite | | public IWorkbenchPartSite getActiveWorkbenchPartSite()(Code) | | Returns the workbench part site of the part that must be active for this
request to be considered.
the workbench part site of the part that must be active for thisrequest to be considered. May be null. |
| getContextId | | public String getContextId()(Code) | | Returns the identifier of the context to be enabled.
the identifier of the context to be enabled. Guaranteed not to benull. |
|
|
|