|
Eclipse Platform Release 3.7 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.eclipse.core.commands.common.EventManager
org.eclipse.core.commands.AbstractHandler
org.eclipse.jface.commands.ActionHandler
public final class ActionHandler
This class adapts instances of IAction to
IHandler.
| Constructor Summary | |
|---|---|
ActionHandler(IAction action)
Creates a new instance of this class given an instance of IAction. |
|
| Method Summary | |
|---|---|
void |
addHandlerListener(IHandlerListener handlerListener)
Registers an instance of IHandlerListener to listen for
changes to properties of this instance. |
void |
dispose()
Removes the property change listener from the action. |
Object |
execute(ExecutionEvent event)
Executes with the map of parameter values by name. |
IAction |
getAction()
Returns the action associated with this handler |
boolean |
isEnabled()
Whether this handler is capable of executing at this time. |
boolean |
isHandled()
Whether this handler is capable of handling delegated responsibilities at this time. |
void |
removeHandlerListener(IHandlerListener handlerListener)
Unregisters an instance of IHandlerListener listening for
changes to properties of this instance. |
String |
toString()
|
| Methods inherited from class org.eclipse.core.commands.AbstractHandler |
|---|
fireHandlerChanged, hasListeners, setBaseEnabled, setEnabled |
| Methods inherited from class org.eclipse.core.commands.common.EventManager |
|---|
addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObject |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
|---|
public ActionHandler(IAction action)
IAction.
action - the action. Must not be null.| Method Detail |
|---|
public final void addHandlerListener(IHandlerListener handlerListener)
IHandlerIHandlerListener to listen for
changes to properties of this instance.
addHandlerListener in interface IHandleraddHandlerListener in class AbstractHandlerhandlerListener - the instance to register. Must not be null. If
an attempt is made to register an instance which is already
registered with this instance, no operation is performed.IHandler.addHandlerListener(IHandlerListener)public final void dispose()
dispose in interface IHandlerdispose in class AbstractHandlerIHandler.dispose()
public final Object execute(ExecutionEvent event)
throws ExecutionException
IHandler
event - An event containing all the information about the current
state of the application; must not be null.
null.
ExecutionException - if an exception occurred during execution.public final IAction getAction()
public final boolean isEnabled()
AbstractHandlerAbstractHandler.setEnabled(Object) so they can be notified
about framework execution contexts.
isEnabled in interface IHandlerisEnabled in class AbstractHandlertrueAbstractHandler.setEnabled(Object),
AbstractHandler.setBaseEnabled(boolean)public final boolean isHandled()
AbstractHandler
isHandled in interface IHandlerisHandled in class AbstractHandlertruepublic final void removeHandlerListener(IHandlerListener handlerListener)
IHandlerIHandlerListener listening for
changes to properties of this instance.
removeHandlerListener in interface IHandlerremoveHandlerListener in class AbstractHandlerhandlerListener - the instance to unregister. Must not be null.
If an attempt is made to unregister an instance which is not
already registered with this instance, no operation is
performed.IHandler.removeHandlerListener(IHandlerListener)public final String toString()
toString in class Object
|
Eclipse Platform Release 3.7 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2011. All rights reserved.