|
RSE Release 3.0 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.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
public class SystemWizardDialog
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:
wasCancelled()
method for callers to know if the wizard was dismissed or cancelled by the user.
updateSize(IWizardPage)
method that can be called by a page when it dynamically grows the page size.
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.
AbstractSystemWizard
,
SystemBaseWizardAction
Nested Class Summary |
---|
Nested classes/interfaces inherited from class org.eclipse.jface.wizard.WizardDialog |
---|
WizardDialog.PageContainerFillLayout |
Nested classes/interfaces inherited from class org.eclipse.jface.window.Window |
---|
Window.IExceptionHandler |
Field Summary | |
---|---|
protected String |
helpId
|
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,
IWizard wizard)
Constructor |
|
SystemWizardDialog(Shell shell,
IWizard 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 dialog 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 |
setOutputObject(Object outputObject)
For explicitly setting output object after wizard is dismissed. |
void |
updateSize(IWizardPage page)
Exposes this nice new 2.0 capability to the public. |
boolean |
wasCancelled()
Allow caller to determine if window was cancelled or not. |
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 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 |
---|
protected String helpId
Constructor Detail |
---|
public SystemWizardDialog(Shell shell, IWizard wizard)
public SystemWizardDialog(Shell shell, IWizard wizard, Object inputObject)
Method Detail |
---|
public void setInputObject(Object inputObject)
ISystemPromptDialog
setInputObject
in interface ISystemPromptDialog
public Object getInputObject()
ISystemPromptDialog
getInputObject
in interface ISystemPromptDialog
public Object getOutputObject()
ISystemPromptDialog
getOutputObject
in interface ISystemPromptDialog
public void setOutputObject(Object outputObject)
ISystemPromptDialog
setOutputObject
in interface ISystemPromptDialog
public boolean wasCancelled()
ISystemPromptDialog
wasCancelled
in interface ISystemPromptDialog
public void setHelp(String id)
public String getHelpContextId()
protected Control createDialogArea(Composite parent)
createDialogArea
in class WizardDialog
public void updateSize(IWizardPage page)
updateSize
in class WizardDialog
public int publicConvertWidthInCharsToPixels(int chars)
publicConvertWidthInCharsToPixels
in interface ISystemPromptDialog
public int publicConvertHeightInCharsToPixels(int chars)
publicConvertHeightInCharsToPixels
in interface ISystemPromptDialog
|
RSE Release 3.0 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |