|
Remote Systems v6.4.1 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.ObjectWizardDialog
com.ibm.etools.systems.core.ui.dialogs.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
,
Serialized FormField Summary | |
---|---|
static String |
copyright
|
protected String |
helpId
|
protected ISystemWizard |
wizard
|
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 java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final String copyright
protected ISystemWizard wizard
protected String helpId
Constructor Detail |
public SystemWizardDialog(Shell shell, ISystemWizard wizard)
public SystemWizardDialog(Shell shell, ISystemWizard wizard, Object inputObject)
Method Detail |
public void setInputObject(Object inputObject)
setInputObject
in interface ISystemPromptDialog
public Object getInputObject()
getInputObject
in interface ISystemPromptDialog
public Object getOutputObject()
getOutputObject
in interface ISystemPromptDialog
public boolean wasCancelled()
wasCancelled
in interface ISystemPromptDialog
public void setHelp(String id)
public String getHelpContextId()
protected Control createDialogArea(Composite parent)
public void updateSize(IWizardPage page)
public int publicConvertWidthInCharsToPixels(int chars)
publicConvertWidthInCharsToPixels
in interface ISystemPromptDialog
public int publicConvertHeightInCharsToPixels(int chars)
publicConvertHeightInCharsToPixels
in interface ISystemPromptDialog
|
Remote Systems v6.4.1 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |