Package com.iizigo.setup

Class SetupWizard

  • All Implemented Interfaces:
    org.eclipse.jface.window.IShellProvider, org.eclipse.jface.wizard.IWizard
    public class SetupWizard
extends org.eclipse.jface.wizard.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 Summary

      Fields 
      Modifier and TypeFieldDescription
      static booleanDEBUG_ALWAYS_OK
      DEBUG enable always OK.

      • Fields inherited from class org.eclipse.jface.wizard.Wizard

        DEFAULT_IMAGE

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      voidaddPages()
      Adds the required pages.
      booleancanFinish()
      Checks for OK to finish.
      voiddispose()
      Dispose of wizard.
      org.eclipse.jface.wizard.IWizardPagegetNextPage​(org.eclipse.jface.wizard.IWizardPage page)
      Gets the next page: if no languages, no more...
      org.eclipse.jface.wizard.IWizardPagegetPreviousPage​(org.eclipse.jface.wizard.IWizardPage page)
      Gets the previous page.
      booleanperformCancel()
      The Wizard implementation of this IWizard method does nothing and returns true.
      booleanperformFinish()
      Finishes the dialog.
      static java.lang.Stringshow​(IDesignerLicenseSystem licSys)
      Shows the wizard the first time if required.

      • Methods inherited from class org.eclipse.jface.wizard.Wizard

        addPage, createPageControls, getContainer, getDefaultPageImage, getDialogSettings, getPage, getPageCount, getPages, getShell, getStartingPage, getTitleBarColor, getWindowTitle, isHelpAvailable, needsPreviousAndNextButtons, needsProgressMonitor, setContainer, setDefaultPageImageDescriptor, setDialogSettings, setForcePreviousAndNextButtons, setHelpAvailable, setNeedsProgressMonitor, setTitleBarColor, setWindowTitle

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • DEBUG_ALWAYS_OK

        public static final boolean DEBUG_ALWAYS_OK
        DEBUG enable always OK.

    • Method Detail

      • show

        public static java.lang.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 org.eclipse.jface.wizard.IWizard
        Overrides:
        dispose in class org.eclipse.jface.wizard.Wizard

      • addPages

        public void addPages()
        Adds the required pages.
        Specified by:
        addPages in interface org.eclipse.jface.wizard.IWizard
        Overrides:
        addPages in class org.eclipse.jface.wizard.Wizard

      • getNextPage

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

      • getPreviousPage

        public org.eclipse.jface.wizard.IWizardPage getPreviousPage​(org.eclipse.jface.wizard.IWizardPage page)
        Gets the previous page.
        Specified by:
        getPreviousPage in interface org.eclipse.jface.wizard.IWizard
        Overrides:
        getPreviousPage in class org.eclipse.jface.wizard.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 org.eclipse.jface.wizard.IWizard
        Overrides:
        canFinish in class org.eclipse.jface.wizard.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 org.eclipse.jface.wizard.IWizard
        Overrides:
        performCancel in class org.eclipse.jface.wizard.Wizard

      • performFinish

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