Humboldt Alignment Editor 2.5.0

eu.esdihumboldt.hale.ui.function.contribution.internal
Class AbstractWizardAction<T extends AbstractFunctionWizardContribution>

java.lang.Object
  extended by org.eclipse.core.commands.common.EventManager
      extended by org.eclipse.jface.action.AbstractAction
          extended by org.eclipse.jface.action.Action
              extended by eu.esdihumboldt.hale.ui.function.contribution.internal.AbstractWizardAction<T>
Type Parameters:
T - the parent contribution type
All Implemented Interfaces:
org.eclipse.jface.action.IAction
Direct Known Subclasses:
CellWizardAction, ReplaceFunctionWizardAction, SchemaSelectionWizardAction

public abstract class AbstractWizardAction<T extends AbstractFunctionWizardContribution>
extends org.eclipse.jface.action.Action

Action for creating a function wizard

Author:
Simon Templer

Field Summary
protected  AlignmentService alignmentService
          The alignment service
protected  FunctionWizardDescriptor<?> descriptor
          The function wizard descriptor
protected  T functionContribution
          The parent function wizard contribution
 
Fields inherited from interface org.eclipse.jface.action.IAction
AS_CHECK_BOX, AS_DROP_DOWN_MENU, AS_PUSH_BUTTON, AS_RADIO_BUTTON, AS_UNSPECIFIED, CHECKED, DESCRIPTION, ENABLED, HANDLED, IMAGE, RESULT, TEXT, TOOL_TIP_TEXT
 
Constructor Summary
AbstractWizardAction(T functionContribution, FunctionWizardDescriptor<?> descriptor, AlignmentService alignmentService)
          Constructor
 
Method Summary
protected abstract  FunctionWizard createWizard()
          Create the function wizard
protected abstract  void handleResult(MutableCell cell)
          Handle the wizard result
 boolean isActive()
          Get if the wizard action shall be currently active
 void run()
           
protected  void updateState()
          Update the action state
 
Methods inherited from class org.eclipse.jface.action.Action
convertAccelerator, convertAccelerator, findKeyCode, findKeyString, findModifier, findModifierString, getAccelerator, getActionDefinitionId, getDescription, getDisabledImageDescriptor, getHelpListener, getHoverImageDescriptor, getId, getImageDescriptor, getMenuCreator, getStyle, getText, getToolTipText, isChecked, isEnabled, isHandled, notifyResult, removeAcceleratorText, removeMnemonics, runWithEvent, setAccelerator, setActionDefinitionId, setChecked, setDescription, setDisabledImageDescriptor, setEnabled, setHelpListener, setHoverImageDescriptor, setId, setImageDescriptor, setMenuCreator, setText, setToolTipText
 
Methods inherited from class org.eclipse.jface.action.AbstractAction
addPropertyChangeListener, firePropertyChange, firePropertyChange, removePropertyChangeListener
 
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
 
Methods inherited from interface org.eclipse.jface.action.IAction
addPropertyChangeListener, removePropertyChangeListener
 

Field Detail

functionContribution

protected final T extends AbstractFunctionWizardContribution functionContribution
The parent function wizard contribution


alignmentService

protected final AlignmentService alignmentService
The alignment service


descriptor

protected final FunctionWizardDescriptor<?> descriptor
The function wizard descriptor

Constructor Detail

AbstractWizardAction

public AbstractWizardAction(T functionContribution,
                            FunctionWizardDescriptor<?> descriptor,
                            AlignmentService alignmentService)
Constructor

Parameters:
functionContribution - the parent contribution
descriptor - the function wizard descriptor
alignmentService - the alignment service
Method Detail

run

public void run()
Specified by:
run in interface org.eclipse.jface.action.IAction
Overrides:
run in class org.eclipse.jface.action.Action
See Also:
Action.run()

handleResult

protected abstract void handleResult(MutableCell cell)
Handle the wizard result

Parameters:
cell - the result cell

createWizard

protected abstract FunctionWizard createWizard()
Create the function wizard

Returns:
the function wizard

updateState

protected void updateState()
Update the action state


isActive

public boolean isActive()
Get if the wizard action shall be currently active

Returns:
if the wizard action shall be currently active

Humboldt Alignment Editor 2.5.0

Build 2012-12-03_12-30-59
Revision 9d2dd4b0318cda9f1393b1ddd390f7f792d70a2d