Package org.eclipse.ui.commands
Class AbstractHandler
java.lang.Object
org.eclipse.core.commands.common.EventManager
org.eclipse.core.commands.AbstractHandler
org.eclipse.ui.commands.AbstractHandler
- Direct Known Subclasses:
ActionHandler
Deprecated.
Please use the "org.eclipse.core.commands" plug-in instead. This
API is scheduled for deletion, see Bug 431177 for details
This class is a partial implementation of
IHandler
. This
abstract implementation provides support for handler listeners. You should
subclass from this method unless you want to implement your own listener
support. Subclasses should call
fireHandlerChanged(HandlerEvent)
when the handler
changes. Subclasses should also override
getAttributeValuesByName()
if they have any
attributes.- Since:
- 3.0
- See Also:
- Restriction:
- This class is not intended to be extended by clients.
- Restriction:
- This class is scheduled for deletion.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addHandlerListener
(IHandlerListener handlerListener) Deprecated.void
dispose()
Deprecated.execute
(ExecutionEvent event) Deprecated.protected void
fireHandlerChanged
(HandlerEvent handlerEvent) Deprecated.protected void
fireHandlerChanged
(HandlerEvent handlerEvent) Deprecated.Deprecated.protected final boolean
Deprecated.boolean
Deprecated.boolean
Deprecated.void
removeHandlerListener
(IHandlerListener handlerListener) Deprecated.Methods inherited from class org.eclipse.core.commands.AbstractHandler
addHandlerListener, removeHandlerListener, setBaseEnabled, setEnabled
Methods inherited from class org.eclipse.core.commands.common.EventManager
addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObject
-
Constructor Details
-
AbstractHandler
public AbstractHandler()Deprecated.
-
-
Method Details
-
addHandlerListener
Deprecated.Description copied from interface:IHandler
Registers an instance ofIHandlerListener
to listen for changes to properties of this instance.- Specified by:
addHandlerListener
in interfaceIHandler
- Parameters:
handlerListener
- the instance to register. Must not benull
. If an attempt is made to register an instance which is already registered with this instance, no operation is performed.- See Also:
-
dispose
Deprecated.The default implementation does nothing. Subclasses who attach listeners to other objects are encouraged to detach them in this method. -
execute
Deprecated.Description copied from interface:IHandler
Executes with the map of parameter values by name.- Specified by:
execute
in interfaceIHandler
- Parameters:
event
- An event containing all the information about the current state of the application; must not benull
.- Returns:
- the result of the execution. Reserved for future use, must be
null
. - Throws:
ExecutionException
- if an exception occurred during execution.
-
fireHandlerChanged
Deprecated.Fires an event to all registered listeners describing changes to this instance.- Overrides:
fireHandlerChanged
in classAbstractHandler
- Parameters:
handlerEvent
- the event describing changes to this instance. Must not benull
.
-
fireHandlerChanged
Deprecated.- See Also:
-
getAttributeValuesByName
Deprecated.This simply return an empty map. The default implementation has no attributes.- Specified by:
getAttributeValuesByName
in interfaceIHandler
- Returns:
- the map of attribute values by name. This map may be empty, but is
guaranteed not to be
null
. If this map is not empty, its collection of keys is guaranteed to only contain instances ofString
. - See Also:
-
hasListeners
Deprecated.Returns true iff there is one or more IHandlerListeners attached to this AbstractHandler.- Overrides:
hasListeners
in classAbstractHandler
- Returns:
- true iff there is one or more IHandlerListeners attached to this AbstractHandler
- Since:
- 3.1
-
isEnabled
Deprecated.Description copied from class:AbstractHandler
Whether this handler is capable of executing at this time. Subclasses may override this method. If clients override this method they should also consider overridingAbstractHandler.setEnabled(Object)
so they can be notified about framework execution contexts.- Specified by:
isEnabled
in interfaceIHandler
- Overrides:
isEnabled
in classAbstractHandler
- Returns:
true
- See Also:
-
isHandled
Deprecated.Description copied from class:AbstractHandler
Whether this handler is capable of handling delegated responsibilities at this time. Subclasses may override this method.- Specified by:
isHandled
in interfaceIHandler
- Overrides:
isHandled
in classAbstractHandler
- Returns:
true
-
removeHandlerListener
Deprecated.Description copied from interface:IHandler
Unregisters an instance ofIPropertyListener
listening for changes to properties of this instance.- Specified by:
removeHandlerListener
in interfaceIHandler
- Parameters:
handlerListener
- the instance to unregister. Must not benull
. If an attempt is made to unregister an instance which is not already registered with this instance, no operation is performed.- See Also:
-