Package org.eclipse.ui.actions

Class NewWizardAction

java.lang.Object

org.eclipse.core.commands.common.EventManager

org.eclipse.jface.action.AbstractAction

org.eclipse.jface.action.Action

org.eclipse.ui.actions.NewWizardAction

All Implemented Interfaces:

IAction, ActionFactory.IWorkbenchAction

public class NewWizardAction
extends Action
implements ActionFactory.IWorkbenchAction

Invoke the resource creation wizard selection Wizard.

This class may be instantiated; it is not intended to be subclassed.

This method automatically registers listeners so that it can keep its enablement state up to date. Ordinarily, the window's references to these listeners will be dropped automatically when the window closes. However, if the client needs to get rid of an action while the window is still open, the client must call #dispose() to give the action an opportunity to deregister its listeners and to perform any other cleanup.

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

Constructor	Description
NewWizardAction()	Deprecated. use the constructor NewWizardAction(IWorkbenchWindow)
NewWizardAction(IWorkbenchWindow window)	Create a new instance of this class.

Method Summary

Modifier and Type	Method	Description
void	dispose()	Disposes of this action.
String	getCategoryId()	Returns the id of the category of wizards to show or null to show all categories.
void	run()	The default implementation of this IAction method does nothing.
void	setCategoryId(String id)	Sets the id of the category of wizards to show or null to show all categories.
void	setWizardWindowTitle(String windowTitle)	Sets the title of the wizard window

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, getAccelerator, getActionDefinitionId, getDescription, getDisabledImageDescriptor, getHelpListener, getHoverImageDescriptor, getId, getImageDescriptor, getMenuCreator, getStyle, getText, getToolTipText, isChecked, isEnabled, isHandled, removePropertyChangeListener, runWithEvent, setAccelerator, setActionDefinitionId, setChecked, setDescription, setDisabledImageDescriptor, setEnabled, setHelpListener, setHoverImageDescriptor, setId, setImageDescriptor, setMenuCreator, setText, setToolTipText

Constructor Details

NewWizardAction

public NewWizardAction(IWorkbenchWindow window)

Create a new instance of this class.

Parameters:

window - the parent window

NewWizardAction

@Deprecated
public NewWizardAction()

Deprecated.

use the constructor NewWizardAction(IWorkbenchWindow)

Create a new instance of this class

Method Details

getCategoryId

public String getCategoryId()

Returns the id of the category of wizards to show or null to show all categories.

Returns:

String

setCategoryId

public void setCategoryId(String id)

Sets the id of the category of wizards to show or null to show all categories.

Parameters:

id - the wizards's category id; may be null

setWizardWindowTitle

public void setWizardWindowTitle(String windowTitle)

Sets the title of the wizard window

If the title of the wizard window is null, the default wizard window title will be used.

Parameters:

windowTitle - The title of the wizard window, otherwise null (default wizard window title).

Since:

3.6

run

public void run()

Description copied from class: Action

The default implementation of this IAction method does nothing. Subclasses should override this method if they do not need information from the triggering event, or override runWithEvent(Event) if they do.

Specified by:

run in interface IAction

Overrides:

run in class Action

See Also:

• How radio buttons are handled
• How check boxes are handled

dispose

public void dispose()

Description copied from interface: ActionFactory.IWorkbenchAction

Disposes of this action. Once disposed, this action cannot be used. This operation has no effect if the action has already been disposed.

Specified by:

dispose in interface ActionFactory.IWorkbenchAction