Eclipse Plug-in Developer Guide (Galileo) - NewWizardAction (Eclipse Platform API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Platform
Release 3.5

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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
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

NewWizardAction ()
          Deprecated. use the constructor NewWizardAction(IWorkbenchWindow)

NewWizardAction ( IWorkbenchWindow window)
          Create a new instance of this class.

Method Summary

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.

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 Detail

NewWizardAction

public NewWizardAction(
IWorkbenchWindow window)

Create a new instance of this class.

Parameters:: window -

NewWizardAction

public NewWizardAction()

Deprecated. use the constructor NewWizardAction(IWorkbenchWindow)

Create a new instance of this class

Method Detail

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 -

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.