Package org.eclipse.ui.commands
Class HandlerSubmission
java.lang.Object
org.eclipse.ui.commands.HandlerSubmission
- All Implemented Interfaces:
Comparable
Deprecated.
An instance of this class represents a request to handle a command. A handler submission specifies a list of conditions under which it would be appropriate for a particular command to have a particular handler. These conditions include things like the active part or the active shell. So, it is possible to say things like: "when my part is active, please consider calling these classes when you want to perform a cut, copy or paste".
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:
- Restriction:
- This class is scheduled for deletion.
-
Constructor Summary
ConstructorDescriptionHandlerSubmission
(String activePartId, Shell activeShell, IWorkbenchPartSite activeWorkbenchPartSite, String commandId, IHandler handler, Priority priority) Deprecated. -
Method Summary
Modifier and TypeMethodDescriptionint
Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.toString()
Deprecated.
-
Constructor Details
-
HandlerSubmission
@Deprecated public HandlerSubmission(String activePartId, Shell activeShell, IWorkbenchPartSite activeWorkbenchPartSite, String commandId, IHandler handler, Priority priority) 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
.commandId
- the identifier of the command to be handled. Must not benull
.handler
- the handler. Must not benull
.priority
- the priority. Must not benull
.
-
-
Method Details
-
compareTo
Deprecated.- Specified by:
compareTo
in interfaceComparable
- See Also:
-
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
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
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
.
-
getCommandId
Deprecated.Returns the identifier of the command to be handled.- Returns:
- the identifier of the command to be handled. Guaranteed not to be
null
.
-
getHandler
Deprecated.Returns the handler.- Returns:
- the handler. Guaranteed not to be
null
.
-
getPriority
Deprecated.Returns the priority.- Returns:
- the priority. Guaranteed not to be
null
.
-
toString
Deprecated.
-
IHandlerService.activateHandler
instead. This API is scheduled for deletion, see Bug 431177 for details