Package org.eclipse.ui.internal

Class WorkbenchHandlerServiceHandler

java.lang.Object

org.eclipse.core.commands.common.EventManager

org.eclipse.core.commands.AbstractHandler

org.eclipse.core.commands.AbstractHandlerWithState

org.eclipse.e4.core.commands.internal.HandlerServiceHandler

org.eclipse.ui.internal.WorkbenchHandlerServiceHandler

All Implemented Interfaces:

IHandler, IHandler2, IObjectWithState, IStateListener, IElementUpdater

public class WorkbenchHandlerServiceHandler
extends HandlerServiceHandler
implements IElementUpdater

Since:

3.5

Field Summary

Fields inherited from class org.eclipse.e4.core.commands.internal.HandlerServiceHandler

commandId, currentStateHandler

Constructor Summary

Constructors

Constructor	Description
WorkbenchHandlerServiceHandler(String commandId)

Method Summary

Modifier and Type	Method	Description
String	getHandlerLabel()	Return the label for this handler.
void	updateElement(UIElement element, Map parameters)	Whenever the elements for a command are refreshed, this method is called on the active handler for that command.

Methods inherited from class org.eclipse.e4.core.commands.internal.HandlerServiceHandler

addState, dispose, execute, fireHandlerChanged, getExecutionContext, handleStateChange, isEnabled, isHandled, overrideEnabled, removeState, setEnabled, toString

Methods inherited from class org.eclipse.core.commands.AbstractHandlerWithState

getState, getStateIds

Methods inherited from class org.eclipse.core.commands.AbstractHandler

addHandlerListener, hasListeners, removeHandlerListener, setBaseEnabled

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 Details

WorkbenchHandlerServiceHandler

public WorkbenchHandlerServiceHandler(String commandId)

Method Details

updateElement

public void updateElement(UIElement element,
 Map parameters)

Description copied from interface: IElementUpdater

Whenever the elements for a command are refreshed, this method is called on the active handler for that command.

Note: Handlers must never cache the element, which can disappear or be replaced at any time. Everybody should go through the ICommandService refreshElements(*) method.

Specified by:

updateElement in interface IElementUpdater

Parameters:

element - An element for a specific UI element. Will not be null.

parameters - Any parameters registered with the callback. Will not be null, but it may be empty.

getHandlerLabel

public String getHandlerLabel()

Description copied from interface: IHandler

Return the label for this handler. The handler can implement this method to provide a more dynamic label according to the actual action that is performed. When returning null, callers may instead use the invoking command label or a generic label.

Specified by:

getHandlerLabel in interface IHandler

Returns:

name of the Handler, can be null