| java.lang.Object
 org.eclipse.ui.commands.HandlerSubmission
| HandlerSubmission | | final public class HandlerSubmission implements Comparable(Code) | |
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: org.eclipse.ui.commands.IWorkbenchCommandSupport
See Also: org.eclipse.ui.handlers.IHandlerService |
| Constructor Summary | |
| public | HandlerSubmission(String activePartId, Shell activeShell, IWorkbenchPartSite activeWorkbenchPartSite, String commandId, IHandler handler, Priority priority)
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 | getCommandId()
Returns the identifier of the command to be handled.
the identifier of the command to be handled. | | public IHandler | getHandler()
Returns the handler.
the handler. | | public Priority | getPriority()
Returns the priority.
the priority. | | public String | toString()
|
| HandlerSubmission | | public HandlerSubmission(String activePartId, Shell activeShell, IWorkbenchPartSite activeWorkbenchPartSite, String commandId, IHandler handler, Priority priority)(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:
commandId - the identifier of the command to be handled. Must not benull.
Parameters:
handler - the handler. Must not be null.
Parameters:
priority - the priority. Must not be null. |
| 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. |
| getCommandId | | public String getCommandId()(Code) | | Returns the identifier of the command to be handled.
the identifier of the command to be handled. Guaranteed not to benull. |
| getHandler | | public IHandler getHandler()(Code) | | Returns the handler.
the handler. Guaranteed not to be null. |
| getPriority | | public Priority getPriority()(Code) | | Returns the priority.
the priority. Guaranteed not to be null. |
|
|