Class AbstractOpenWizardAction

All Implemented Interfaces:
IAction
Direct Known Subclasses:
OpenNewAnnotationWizardAction, OpenNewClassWizardAction, OpenNewEnumWizardAction, OpenNewInterfaceWizardAction, OpenNewJavaProjectWizardAction, OpenNewPackageWizardAction, OpenNewRecordWizardAction, OpenNewSourceFolderWizardAction

public abstract class AbstractOpenWizardAction extends Action

Abstract base classed used for the open wizard actions.

Note: This class is for internal use only. Clients should not use this class.

Since:
3.2
Restriction:
This class is not intended to be subclassed by clients.
  • Constructor Details

    • AbstractOpenWizardAction

      protected AbstractOpenWizardAction()
      Creates the action.
  • Method Details

    • run

      public void run()
      Specified by:
      run in interface IAction
      Overrides:
      run in class Action
    • createWizard

      protected abstract INewWizard createWizard() throws CoreException
      Creates and configures the wizard. This method should only be called once.
      Returns:
      returns the created wizard.
      Throws:
      CoreException - exception is thrown when the creation was not successful.
    • getSelection

      protected IStructuredSelection getSelection()
      Returns the configured selection. If no selection has been configured using setSelection(IStructuredSelection), the currently selected element of the active workbench is returned.
      Returns:
      the configured selection
    • setSelection

      public void setSelection(IStructuredSelection selection)
      Configures the selection to be used as initial selection of the wizard.
      Parameters:
      selection - the selection to be set or null to use the selection of the active workbench window
    • getShell

      protected Shell getShell()
      Returns the configured shell. If no shell has been configured using setShell(Shell), the shell of the currently active workbench is returned.
      Returns:
      the configured shell
    • setShell

      public void setShell(Shell shell)
      Configures the shell to be used as parent shell by the wizard.
      Parameters:
      shell - the shell to be set or null to use the shell of the active workbench window
    • doCreateProjectFirstOnEmptyWorkspace

      protected boolean doCreateProjectFirstOnEmptyWorkspace(Shell shell)
      Opens the new project dialog if the workspace is empty. This method is called on run().
      Parameters:
      shell - the shell to use
      Returns:
      returns true when a project has been created, or false when the new project has been canceled.
    • getCreatedElement

      public IJavaElement getCreatedElement()
      Returns the created element or null if the wizard has not run or was canceled.
      Returns:
      the created element or null