org.eclipse.rse.ui.dialogs
Class SystemWizardDialog

java.lang.Object
  org.eclipse.jface.window.Window
      org.eclipse.jface.dialogs.Dialog
          org.eclipse.jface.dialogs.TrayDialog
              org.eclipse.jface.dialogs.TitleAreaDialog
                  org.eclipse.jface.wizard.WizardDialog
                      org.eclipse.rse.ui.dialogs.SystemWizardDialog

All Implemented Interfaces:

IPageChangeProvider, IRunnableContext, IShellProvider, ISystemPromptDialog, IWizardContainer, IWizardContainer2

Direct Known Subclasses:

SystemFilterPoolWizardDialog, SystemFilterWizardDialog

public class SystemWizardDialog

extends WizardDialog

implements ISystemPromptDialog

Base wizard dialog class. Extends Eclipse WizardDialog class to add support for the ISystemPromptDialog interface methods. These make it easy to pass an input object to your wizard, if your wizard implements ISystemWizard.

This class is most effective when used together with AbstractSystemWizard and with SystemBaseWizardAction. Indeed, if you use SystemBaseWizardAction, this class is automatically used for the dialog. It supports propogation of information from the action, to the wizard, to the wizard dialog and to the wizard pages.

The advantages to using this class versus the base JFace WizardDialog class is:

• Supports settings of an input object, which is propogated to the wizard and its pages.
• Supports querying of an output object, as set by the wizard.
• Supports a wasCancelled() method for callers to know if the wizard was dismissed or cancelled by the user.
• Supports setting of the overall contextual help, which is propogated to each page.
• Supports an updateSize(IWizardPage) method that can be called by a page when it dynamically grows the page size.
• When a progress monitor is not required, the real estate for the monitor is reclaimed, reducing the size of the wizard
• Whan a progress monitor is required, registers this with the RSE system registry, so it is using for long-running remote communications requests.

To use this class, simply instantiate it, passing a wizard that implements ISystemWizard, which AbstractSystemWizard does. If you use SystemBaseWizardAction, then this is done for you.

See Also:

AbstractSystemWizard, SystemBaseWizardAction

Nested Class Summary

Nested classes inherited from class org.eclipse.jface.wizard.WizardDialog

WizardDialog.PageContainerFillLayout

Nested classes inherited from class org.eclipse.jface.window.Window

Window.IExceptionHandler

Field Summary

protected String	helpId
protected ISystemWizard	wizard

Fields inherited from class org.eclipse.jface.wizard.WizardDialog

WIZ_IMG_ERROR

Fields inherited from class org.eclipse.jface.dialogs.TitleAreaDialog

DLG_IMG_TITLE_BANNER, DLG_IMG_TITLE_ERROR, INFO_MESSAGE, WARNING_MESSAGE

Fields inherited from class org.eclipse.jface.dialogs.Dialog

blockedHandler, buttonBar, DIALOG_DEFAULT_BOUNDS, DIALOG_PERSISTLOCATION, DIALOG_PERSISTSIZE, dialogArea, DLG_IMG_ERROR, DLG_IMG_HELP, DLG_IMG_INFO, DLG_IMG_MESSAGE_ERROR, DLG_IMG_MESSAGE_INFO, DLG_IMG_MESSAGE_WARNING, DLG_IMG_QUESTION, DLG_IMG_WARNING, ELLIPSIS

Fields inherited from class org.eclipse.jface.window.Window

CANCEL, OK

Constructor Summary

SystemWizardDialog(Shell shell, ISystemWizard wizard)
Constructor

SystemWizardDialog(Shell shell, ISystemWizard wizard, Object inputObject)
Constructor two.

Method Summary

protected Control	createDialogArea(Composite parent) Intercept of parent method so we can automatically register the wizard's progress monitor with the SystemRegistry for all framework progress monitor requests, if user has specified they need a progress monitor for this wizard.
String	getHelpContextId() Get the help context id for this wizard dialog, as set in setHelp
Object	getInputObject() For explicitly getting input object.
Object	getOutputObject() For explicitly getting output object after wizard is dismissed.
int	publicConvertHeightInCharsToPixels(int chars) Expose inherited protected method convertHeightInCharsToPixels as a publicly excessible method
int	publicConvertWidthInCharsToPixels(int chars) Expose inherited protected method convertWidthInCharsToPixels as a publicly excessible method
void	setHelp(String id) Set the help context id for this wizard dialog
void	setInputObject(Object inputObject) For explicitly setting input object.
void	updateSize(IWizardPage page) Exposes this nice new 2.0 capability to the public.
boolean	wasCancelled() Allow caller to determine if wizard was cancelled or not.

Methods inherited from class org.eclipse.jface.wizard.WizardDialog

addPageChangedListener, backPressed, buttonPressed, cancelPressed, close, configureShell, createButtonsForButtonBar, createContents, createProgressMonitorPart, finishPressed, firePageChanged, getButton, getCurrentPage, getProgressMonitor, getSelectedPage, getWizard, helpPressed, nextPressed, removePageChangedListener, run, setMinimumPageSize, setMinimumPageSize, setPageSize, setPageSize, setWizard, showPage, update, updateButtons, updateMessage, updateSize, updateTitleBar, updateWindowTitle

Methods inherited from class org.eclipse.jface.dialogs.TitleAreaDialog

getInitialSize, getTitleArea, getTitleImageLabel, setErrorMessage, setMessage, setMessage, setTitle, setTitleAreaColor, setTitleImage

Methods inherited from class org.eclipse.jface.dialogs.TrayDialog

closeTray, createButtonBar, createHelpControl, getLayout, getTray, isDialogHelpAvailable, isHelpAvailable, openTray, setDialogHelpAvailable, setHelpAvailable

Methods inherited from class org.eclipse.jface.dialogs.Dialog

applyDialogFont, convertHeightInCharsToPixels, convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, convertWidthInCharsToPixels, create, createButton, dialogFontIsDefault, getBlockedHandler, getButtonBar, getCancelButton, getDialogArea, getDialogBoundsSettings, getDialogBoundsStrategy, getImage, getInitialLocation, getOKButton, initializeBounds, initializeDialogUnits, okPressed, setBlockedHandler, setButtonLayoutData, setButtonLayoutFormData, shortenText

Methods inherited from class org.eclipse.jface.window.Window

canHandleShellCloseEvent, constrainShellSize, createShell, getConstrainedShellBounds, getContents, getDefaultImage, getDefaultImages, getDefaultOrientation, getParentShell, getReturnCode, getShell, getShellListener, getShellStyle, getWindowManager, handleFontChange, handleShellCloseEvent, open, setBlockOnOpen, setDefaultImage, setDefaultImages, setDefaultModalParent, setDefaultOrientation, setExceptionHandler, setParentShell, setReturnCode, setShellStyle, setWindowManager

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.wizard.IWizardContainer

getShell

Field Detail

wizard

protected ISystemWizard wizard

helpId

protected String helpId

Constructor Detail

SystemWizardDialog

public SystemWizardDialog(Shell shell,
                          ISystemWizard wizard)

Constructor

SystemWizardDialog

public SystemWizardDialog(Shell shell,
                          ISystemWizard wizard,
                          Object inputObject)

Constructor two. Use when you have an input object at instantiation time.

Method Detail

setInputObject

public void setInputObject(Object inputObject)

For explicitly setting input object. Called by SystemDialogAction

Specified by:

setInputObject in interface ISystemPromptDialog

getInputObject

public Object getInputObject()

For explicitly getting input object.

Specified by:

getInputObject in interface ISystemPromptDialog

getOutputObject

public Object getOutputObject()

For explicitly getting output object after wizard is dismissed. Set by the dialog's processOK method.

Specified by:

getOutputObject in interface ISystemPromptDialog

wasCancelled

public boolean wasCancelled()

Allow caller to determine if wizard was cancelled or not.

Specified by:

wasCancelled in interface ISystemPromptDialog

setHelp

public void setHelp(String id)

Set the help context id for this wizard dialog

getHelpContextId

public String getHelpContextId()

Get the help context id for this wizard dialog, as set in setHelp

createDialogArea

protected Control createDialogArea(Composite parent)

Intercept of parent method so we can automatically register the wizard's progress monitor with the SystemRegistry for all framework progress monitor requests, if user has specified they need a progress monitor for this wizard.

updateSize

public void updateSize(IWizardPage page)

Exposes this nice new 2.0 capability to the public.

publicConvertWidthInCharsToPixels

public int publicConvertWidthInCharsToPixels(int chars)

Expose inherited protected method convertWidthInCharsToPixels as a publicly excessible method

Specified by:

publicConvertWidthInCharsToPixels in interface ISystemPromptDialog

publicConvertHeightInCharsToPixels

public int publicConvertHeightInCharsToPixels(int chars)

Expose inherited protected method convertHeightInCharsToPixels as a publicly excessible method

Specified by:

publicConvertHeightInCharsToPixels in interface ISystemPromptDialog