|
RSE Release 3.0 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.core.commands.common.EventManager
org.eclipse.jface.action.AbstractAction
org.eclipse.jface.action.Action
org.eclipse.rse.ui.actions.SystemBaseAction
org.eclipse.rse.ui.actions.SystemBaseDialogAction
org.eclipse.rse.ui.actions.SystemBaseWizardAction
public abstract class SystemBaseWizardAction
A specialization for the eclipse Action method, for actions that put up wizards.
This class is most effective when used with actions that extend AbstractSystemWizard
,
or implement ISystemWizard
. It supports
settings that are propogated to the wizard, and wizard pages if they extend AbstractSystemWizardPage
,
or implement ISystemWizardPage
.
SystemBaseAction.allowOnMultipleSelection(boolean)
to false, since most wizard actions are not permitted on multiple selection.
progress-monitor
or not, which is propogated to the wizard.
title
, which is propogated to the wizard.
image
, which is propogated to the wizard.
page-title
, which is propogated to the wizard and the wizard pages.
contextual-help
, which is propogated to the wizard and the wizard pages.
minimum-size
, which is propogated and applied to the wizard.
wasCancelled()
method so the caller can easily determine if the wizard was dismissed or cancelled by the user.
current-viewer
.
To use this class:
AbstractSystemWizard
, and is populated with
pages that extend AbstractSystemWizardPage
.
createWizard()
to instantiate, configure and return your wizard.
postProcessWizard(IWizard)
. You might also override this if you need to set output variables in the action,
after the sucessful completion of the wizard.
Field Summary |
---|
Fields inherited from class org.eclipse.rse.ui.actions.SystemBaseDialogAction |
---|
cancelled, dlgHelpId, needsProgressMonitor, needsProgressMonitorSet, processAll, value |
Fields inherited from class org.eclipse.rse.ui.actions.SystemBaseAction |
---|
allowOnMultipleSelection, arrowCursor, helpId, selectionSensitive, shell, sSelection, traceSelections, traceTarget, viewer, waitCursor |
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 | |
---|---|
protected |
SystemBaseWizardAction(String text,
ImageDescriptor image,
Shell parent)
Constructor for SystemBaseWizardAction when translated label is known. |
protected |
SystemBaseWizardAction(String text,
String tooltip,
ImageDescriptor image,
Shell parent)
Constructor for SystemBaseWizardAction when translated label and tooltip are known. |
protected |
SystemBaseWizardAction(String text,
String tooltip,
String description,
ImageDescriptor image,
Shell parent)
Constructor for SystemBaseWizardAction when translated label and tooltip and description are all known. |
Method Summary | |
---|---|
protected Dialog |
createDialog(Shell shell)
Override of parent's method. |
protected abstract IWizard |
createWizard()
The default processing for the run method calls createDialog, which we override in this class. |
protected WizardDialog |
doCreateWizardDialog(Shell shell,
IWizard wizard)
Creates the dialog instance. |
protected Object |
getDialogValue(Dialog dlg)
By default, we try to get the wizard's value by calling getOutputObject() |
String |
getWizardPageTitle()
Return the page title as set via setWizardPageTitle |
protected void |
postProcessWizard(IWizard wizard)
Typically, the wizard's performFinish method does the work required by a successful finish of the wizard. |
void |
setMinimumPageSize(int width,
int height)
Call this method to set the wizard's dimensions without having to subclass the wizard. |
void |
setWizardImage(ImageDescriptor wizardImage)
Set the wizard image. |
void |
setWizardPageTitle(String pageTitle)
Set the wizard page title. |
void |
setWizardTitle(String title)
Set the wizard title. |
boolean |
wasCancelled()
Returns true if the user cancelled the wizard. |
Methods inherited from class org.eclipse.rse.ui.actions.SystemBaseDialogAction |
---|
getDialogHelpContextId, getNeedsProgressMonitor, getProcessAllSelections, getValue, run, setDialogHelp, setNeedsProgressMonitor, setProcessAllSelections, setValue, wasNeedsProgressMonitorSet |
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.rse.ui.actions.ISystemDialogAction |
---|
getValue, setProcessAllSelections, setValue |
Methods inherited from interface org.eclipse.rse.ui.actions.ISystemAction |
---|
allowOnMultipleSelection, getContextMenuGroup, getHelpContextId, getSelection, getShell, getViewer, isDummy, isSelectionSensitive, setContextMenuGroup, setHelp, setInputs, setSelection, setSelectionSensitive, setShell, setViewer |
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, run, runWithEvent, setAccelerator, setActionDefinitionId, setChecked, setDescription, setDisabledImageDescriptor, setEnabled, setHelpListener, setHoverImageDescriptor, setId, setImageDescriptor, setMenuCreator, setText, setToolTipText |
Methods inherited from interface org.eclipse.jface.viewers.ISelectionChangedListener |
---|
selectionChanged |
Constructor Detail |
---|
protected SystemBaseWizardAction(String text, ImageDescriptor image, Shell parent)
text
- string to display in menu or toolbarimage
- icon to display in menu or toolbar. Can be null.parent
- Shell of parent window. Can be null if you don't know it, but call setShell when you do.protected SystemBaseWizardAction(String text, String tooltip, ImageDescriptor image, Shell parent)
text
- string to display in menu or toolbartooltip
- string to display when user hovers mouse over action.image
- icon to display in menu or toolbar. Can be null.parent
- Shell of parent window. Can be null if you don't know it, but call setShell when you do.protected SystemBaseWizardAction(String text, String tooltip, String description, ImageDescriptor image, Shell parent)
text
- string to display in menu or toolbartooltip
- string to display when user hovers mouse over action.description
- string displayed in status bar of some displays. Longer than tooltip.image
- icon to display in menu or toolbar. Can be null.parent
- Shell of parent window. Can be null if you don't know it, but call setShell when you do.Method Detail |
---|
public void setWizardTitle(String title)
public void setWizardImage(ImageDescriptor wizardImage)
public void setWizardPageTitle(String pageTitle)
This is not used by default, but can be queried via getPageTitle() when constructing pages.
public String getWizardPageTitle()
public void setMinimumPageSize(int width, int height)
protected final Dialog createDialog(Shell shell)
createDialog
in class SystemBaseDialogAction
SystemBaseDialogAction.run()
protected WizardDialog doCreateWizardDialog(Shell shell, IWizard wizard)
createDialog(...)
.
Gives overrides the chance to plug-in their own specialized wizard dialog
implementations.
shell
- The shell to create the dialog in. Must be not null
.wizard
- The wizard to create the wizard dialog for. Must be not null
.
null
.protected abstract IWizard createWizard()
protected Object getDialogValue(Dialog dlg)
getDialogValue
in class SystemBaseDialogAction
dlg
- The dialog object, after it has returned from open.protected void postProcessWizard(IWizard wizard)
public boolean wasCancelled()
wasCancelled
in interface ISystemDialogAction
wasCancelled
in class SystemBaseDialogAction
|
RSE Release 3.0 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |