Package org.eclipse.jdt.ui.actions
Class AbstractOpenWizardAction
- java.lang.Object
-
- org.eclipse.core.commands.common.EventManager
-
- org.eclipse.jface.action.AbstractAction
-
- org.eclipse.jface.action.Action
-
- org.eclipse.jdt.ui.actions.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.
-
-
Field Summary
-
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
Constructors Modifier Constructor Description protected
AbstractOpenWizardAction()
Creates the action.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected abstract INewWizard
createWizard()
Creates and configures the wizard.protected boolean
doCreateProjectFirstOnEmptyWorkspace(Shell shell)
Opens the new project dialog if the workspace is empty.IJavaElement
getCreatedElement()
Returns the created element ornull
if the wizard has not run or was canceled.protected IStructuredSelection
getSelection()
Returns the configured selection.protected Shell
getShell()
Returns the configured shell.void
run()
void
setSelection(IStructuredSelection selection)
Configures the selection to be used as initial selection of the wizard.void
setShell(Shell shell)
Configures the shell to be used as parent shell by the wizard.-
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
-
-
-
-
Method Detail
-
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 usingsetSelection(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 ornull
to use the selection of the active workbench window
-
getShell
protected Shell getShell()
Returns the configured shell. If no shell has been configured usingsetShell(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 ornull
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 onrun()
.- Parameters:
shell
- the shell to use- Returns:
- returns
true
when a project has been created, orfalse
when the new project has been canceled.
-
getCreatedElement
public IJavaElement getCreatedElement()
Returns the created element ornull
if the wizard has not run or was canceled.- Returns:
- the created element or
null
-
-