Class SetupWizard

All Implemented Interfaces:
IShellProvider, IWizard

public class SetupWizard extends Wizard
Wizard used when a UI component is about to be added. This wizard provides a mechanism to pop-up a dialog box so the user can fill in the name of the component, VS connections, etc.
Author:
Christopher Mindus
  • Field Details

    • DEBUG_ALWAYS_OK

      public static final boolean DEBUG_ALWAYS_OK
      DEBUG enable always OK.
  • Method Details

    • show

      public static String show(IDesignerLicenseSystem licSys)
      Shows the wizard the first time if required.
      Parameters:
      licSys - The license system.
      Returns:
      Error message, null for for cancel, empty string for OK.
    • dispose

      public void dispose()
      Dispose of wizard.
      Specified by:
      dispose in interface IWizard
      Overrides:
      dispose in class Wizard
    • addPages

      public void addPages()
      Adds the required pages.
      Specified by:
      addPages in interface IWizard
      Overrides:
      addPages in class Wizard
    • getNextPage

      public IWizardPage getNextPage(IWizardPage page)
      Gets the next page: if no languages, no more...
      Specified by:
      getNextPage in interface IWizard
      Overrides:
      getNextPage in class Wizard
      Parameters:
      page - current page.
      Returns:
      Next page, or null for already on last page.
    • getPreviousPage

      public IWizardPage getPreviousPage(IWizardPage page)
      Gets the previous page.
      Specified by:
      getPreviousPage in interface IWizard
      Overrides:
      getPreviousPage in class Wizard
      Parameters:
      page - current page.
      Returns:
      Previous page, or null for already on first page.
    • canFinish

      public boolean canFinish()
      Checks for OK to finish.
      Specified by:
      canFinish in interface IWizard
      Overrides:
      canFinish in class Wizard
      Returns:
      true for OK to finish, false if not OK.
    • performCancel

      public boolean performCancel()
      The Wizard implementation of this IWizard method does nothing and returns true. Subclasses should re-implement this method if they need to perform any special cancel processing for their wizard.
      Specified by:
      performCancel in interface IWizard
      Overrides:
      performCancel in class Wizard
    • performFinish

      public boolean performFinish()
      Finishes the dialog.
      Specified by:
      performFinish in interface IWizard
      Specified by:
      performFinish in class Wizard
      Returns:
      true to indicate the finish request was accepted, and false to indicate that the finish request was refused.