Remote Systems
v6.4.1

com.ibm.etools.systems.core.ui.dialogs
Class SystemWizardDialog

java.lang.Object
  extended byWizardDialog
      extended bycom.ibm.etools.systems.core.ui.dialogs.SystemWizardDialog
All Implemented Interfaces:
ISystemPromptDialog
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:

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, Serialized Form

Field 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

copyright

public static final String copyright
See Also:
Constant Field Values

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

Remote Systems
v6.4.1

Copyright © 2005 IBM Corp. All Rights Reserved.

Note: This documentation is for part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.