Remote Systems
v6.4.1

com.ibm.etools.systems.core.ui.wizards
Interface ISystemWizard

All Superinterfaces:
ISystemPromptDialog
All Known Subinterfaces:
ISystemFilterWizard, SystemFilterPoolWizardInterface
All Known Implementing Classes:
AbstractSystemWizard, SystemFilterNewFilterPoolWizard

public interface ISystemWizard
extends ISystemPromptDialog

Suggested interface for wizards launchable via remote system explorer.


Field Summary
static String copyright
           
 
Method Summary
 String getHelpContextId()
          Return the help Id as set in setHelp(String)
 int getMinimumPageHeight()
           
 int getMinimumPageWidth()
           
 SystemWizardDialog getSystemWizardDialog()
          Return the result of setSystemWizardDialog
 Viewer getViewer()
          Get the Viewer that called this wizard.
 String getWizardPageTitle()
          Return the page title as set via setWizardPageTitle
 void setHelp(String id)
          Set the help context Id (infoPop) for this wizard.
 void setMinimumPageSize(int width, int height)
          Get current selection of viewer, at time wizard launched, as set by setSelection(IStructuredSelection selection)
 void setSystemWizardDialog(SystemWizardDialog dlg)
          Called from SystemWizardDialog when it is used as the hosting dialog
 void setViewer(Viewer v)
          Set the Viewer that called this wizard.
 void setWizardPageTitle(String pageTitle)
          Set the wizard page title.
 void updateSize()
          Exposes this nice new 2.0 capability to the public.
 
Methods inherited from interface com.ibm.etools.systems.core.ui.dialogs.ISystemPromptDialog
getInputObject, getOutputObject, publicConvertHeightInCharsToPixels, publicConvertWidthInCharsToPixels, setInputObject, wasCancelled
 

Field Detail

copyright

public static final String copyright
See Also:
Constant Field Values
Method Detail

setMinimumPageSize

public void setMinimumPageSize(int width,
                               int height)
Get current selection of viewer, at time wizard launched, as set by setSelection(IStructuredSelection selection)


getMinimumPageWidth

public int getMinimumPageWidth()

getMinimumPageHeight

public int getMinimumPageHeight()

setHelp

public void setHelp(String id)
Set the help context Id (infoPop) for this wizard. This must be fully qualified by plugin ID.

Same as #setHelp(String)

See Also:
#getHelpContextId()

getHelpContextId

public String getHelpContextId()
Return the help Id as set in setHelp(String)


setViewer

public void setViewer(Viewer v)
Set the Viewer that called this wizard. It is good practice for actions to call this so wizard can directly access the originating viewer if needed.


getViewer

public Viewer getViewer()
Get the Viewer that called this wizard. This will be null unless set by the action that started this wizard.


setWizardPageTitle

public void setWizardPageTitle(String pageTitle)
Set the wizard page title. Using this makes it possible to avoid subclassing. The page title goes below the wizard title, and can be unique per page. However, typically the wizard page title is the same for all pages... eg "Filter".

This is not used by default, but can be queried via getPageTitle() when constructing pages.


getWizardPageTitle

public String getWizardPageTitle()
Return the page title as set via setWizardPageTitle


setSystemWizardDialog

public void setSystemWizardDialog(SystemWizardDialog dlg)
Called from SystemWizardDialog when it is used as the hosting dialog


getSystemWizardDialog

public SystemWizardDialog getSystemWizardDialog()
Return the result of setSystemWizardDialog


updateSize

public void updateSize()
Exposes this nice new 2.0 capability to the public. Only does anything if being hosted by SystemWizardDialog.


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.