Package com.iizigo.handler

Class CommonHandler

java.lang.Object
org.eclipse.core.commands.common.EventManager
org.eclipse.core.commands.AbstractHandler
com.iizigo.handler.CommonHandler
All Implemented Interfaces:
org.eclipse.core.commands.IHandler, org.eclipse.core.commands.IHandler2
Direct Known Subclasses:
Copy, Cut, Delete, Link, Move, Open, Paste, PasteAfter, PasteBefore, PasteLink, Rename
public abstract class CommonHandler extends org.eclipse.core.commands.AbstractHandler
The common handler check for valid handled state and enabled state for the common action handlers.
Author:
Christopher Mindus

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected SelectionEnabler
    selectionEnabler
    The current selection enabler.

  • Constructor Summary

    Constructors
    Constructor
    Description
    CommonHandler()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected abstract void
    doExecute()
    Performs the operation.
    final Object
    execute(org.eclipse.core.commands.ExecutionEvent event)
    Performs the operation.
    protected org.eclipse.jface.viewers.IStructuredSelection
    getCurrentSelection()
    Gets the current selection.
    protected org.eclipse.swt.widgets.Shell
    getShell()
    Gets the shell.
    static org.eclipse.core.commands.operations.IUndoContext
    getUndoContext(org.eclipse.ui.IWorkbenchPart part)
    Gets the undo context out of a part.
    protected IPropUndoRedo
    getUndoRedo()
    Gets the IPropUndoRedo for an event.
    protected Runnable
    getUpdateStatesRunnable()
    Gets the asynchronous update states runnable.
    boolean
    isHandled()
    Whether this handler is capable of handling delegated responsibilities at this time.
    protected abstract void
    setEnabled(SelectionEnabler se)
    Sets the enabled state for the selection.
    final void
    setEnabled(Object evaluationContext)
    Called by the framework to allow the handler to update its enabled state by extracting the same information available at execution time.

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

    addHandlerListener, dispose, fireHandlerChanged, hasListeners, isEnabled, 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, toString, wait, wait, wait

  • Field Details

    • selectionEnabler

      protected SelectionEnabler selectionEnabler
      The current selection enabler.

  • Constructor Details

    • CommonHandler

      public CommonHandler()

  • Method Details

    • setEnabled

      public final void setEnabled(Object evaluationContext)
      Called by the framework to allow the handler to update its enabled state by extracting the same information available at execution time.
      Specified by:
      setEnabled in interface org.eclipse.core.commands.IHandler2
      Overrides:
      setEnabled in class org.eclipse.core.commands.AbstractHandler
      Parameters:
      evaluationContext - The application context. May be null.

    • isHandled

      public boolean isHandled()
      Whether this handler is capable of handling delegated responsibilities at this time. Subclasses may override this method.
      Specified by:
      isHandled in interface org.eclipse.core.commands.IHandler
      Overrides:
      isHandled in class org.eclipse.core.commands.AbstractHandler
      Returns:
      true

    • getCurrentSelection

      protected org.eclipse.jface.viewers.IStructuredSelection getCurrentSelection()
      Gets the current selection.

    • setEnabled

      protected abstract void setEnabled(SelectionEnabler se)
      Sets the enabled state for the selection.

    • execute

      public final Object execute(org.eclipse.core.commands.ExecutionEvent event)
      Performs the operation.

    • doExecute

      protected abstract void doExecute()
      Performs the operation.

    • getUndoRedo

      protected IPropUndoRedo getUndoRedo()
      Gets the IPropUndoRedo for an event.

    • getShell

      protected org.eclipse.swt.widgets.Shell getShell()
      Gets the shell.

    • getUndoContext

      public static org.eclipse.core.commands.operations.IUndoContext getUndoContext(org.eclipse.ui.IWorkbenchPart part)
      Gets the undo context out of a part.

    • getUpdateStatesRunnable

      protected Runnable getUpdateStatesRunnable()
      Gets the asynchronous update states runnable.