Class WorkbenchHandlerServiceHandler

All Implemented Interfaces:
IHandler, IHandler2, IObjectWithState, IStateListener, IElementUpdater

public class WorkbenchHandlerServiceHandler extends HandlerServiceHandler implements IElementUpdater
Since:
3.5
  • 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