Package org.eclipse.ui.commands

Class HandlerSubmission

java.lang.Object

org.eclipse.ui.commands.HandlerSubmission

All Implemented Interfaces:

Comparable

@Deprecated
public final class HandlerSubmission
extends Object
implements Comparable

Deprecated.

Please use IHandlerService.activateHandler instead. This API is scheduled for deletion, see Bug 431177 for details

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:

IWorkbenchCommandSupport, IHandlerService

Restriction:

This class is scheduled for deletion.

Constructor Summary

Constructors

Constructor	Description
HandlerSubmission(String activePartId, Shell activeShell, IWorkbenchPartSite activeWorkbenchPartSite, String commandId, IHandler handler, Priority priority)	Deprecated.

Method Summary

Modifier and Type	Method	Description
int	compareTo(Object object)	Deprecated.
String	getActivePartId()	Deprecated.
Shell	getActiveShell()	Deprecated.
IWorkbenchPartSite	getActiveWorkbenchPartSite()	Deprecated.
String	getCommandId()	Deprecated.
IHandler	getHandler()	Deprecated.
Priority	getPriority()	Deprecated.
String	toString()	Deprecated.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

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 be null.

activeShell - the shell that must be active for this request to be considered. May be null.

activeWorkbenchPartSite - the workbench part site of the part that must be active for this request to be considered. May be null.

commandId - the identifier of the command to be handled. Must not be null.

handler - the handler. Must not be null.

priority - the priority. Must not be null.

Method Detail

compareTo

@Deprecated
public int compareTo(Object object)

Deprecated.

Specified by:

compareTo in interface Comparable

See Also:

Comparable.compareTo(java.lang.Object)

getActivePartId

@Deprecated
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

@Deprecated
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

@Deprecated
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.

getCommandId

@Deprecated
public String 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
public IHandler getHandler()

Deprecated.

Returns the handler.

Returns:

the handler. Guaranteed not to be null.

getPriority

@Deprecated
public Priority getPriority()

Deprecated.

Returns the priority.

Returns:

the priority. Guaranteed not to be null.

toString

public String toString()

Deprecated.

Overrides:

toString in class Object

See Also:

Object.toString()