Class WizardDialog

  • All Implemented Interfaces:
    org.eclipse.jface.dialogs.IPageChangeProvider, org.eclipse.jface.operation.IRunnableContext, org.eclipse.jface.window.IShellProvider, org.eclipse.jface.wizard.IWizardContainer, org.eclipse.jface.wizard.IWizardContainer2
    Direct Known Subclasses:
    ValidationDialog

    public class WizardDialog
    extends org.eclipse.jface.wizard.WizardDialog
    Customized Wizard Dialog used when no progress bar is used.
    Author:
    Christopher Mindus
    • Nested Class Summary

      • Nested classes/interfaces inherited from class org.eclipse.jface.wizard.WizardDialog

        org.eclipse.jface.wizard.WizardDialog.PageContainerFillLayout
      • Nested classes/interfaces inherited from class org.eclipse.jface.window.Window

        org.eclipse.jface.window.Window.IExceptionHandler
    • Field Summary

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

        WIZ_IMG_ERROR
      • Fields inherited from class org.eclipse.jface.dialogs.TitleAreaDialog

        DLG_IMG_TITLE_BANNER, DLG_IMG_TITLE_ERROR, INFO_MESSAGE, WARNING_MESSAGE
      • Fields inherited from class org.eclipse.jface.dialogs.Dialog

        blockedHandler, buttonBar, DIALOG_DEFAULT_BOUNDS, DIALOG_PERSISTLOCATION, DIALOG_PERSISTSIZE, dialogArea, DLG_IMG_ERROR, DLG_IMG_HELP, DLG_IMG_INFO, DLG_IMG_MESSAGE_ERROR, DLG_IMG_MESSAGE_INFO, DLG_IMG_MESSAGE_WARNING, DLG_IMG_QUESTION, DLG_IMG_WARNING, ELLIPSIS
      • Fields inherited from class org.eclipse.jface.window.Window

        CANCEL, OK, resizeHasOccurred
    • Constructor Summary

      Constructors 
      Constructor Description
      WizardDialog​(org.eclipse.swt.widgets.Shell parentShell, org.eclipse.jface.wizard.Wizard wizard)
      Creates a new wizard dialog for the given wizard.
      WizardDialog​(org.eclipse.swt.widgets.Shell parentShell, org.eclipse.jface.wizard.Wizard wizard, boolean checkStarting)
      Creates a new wizard dialog for the given wizard.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected org.eclipse.swt.widgets.Control createContents​(org.eclipse.swt.widgets.Composite parent)
      The WizardDialog implementation of this Window method calls call IWizard.addPages to allow the current wizard to add extra pages, then super.createContents to create the controls.
      protected org.eclipse.jface.wizard.ProgressMonitorPart createProgressMonitorPart​(org.eclipse.swt.widgets.Composite composite, org.eclipse.swt.layout.GridLayout layout)
      Hook method for subclasses to create a custom progress monitor part.
      void finishPressed()
      Called this method to simulate a finish.
      • Methods inherited from class org.eclipse.jface.wizard.WizardDialog

        addPageChangedListener, addPageChangingListener, backPressed, buttonPressed, cancelPressed, close, configureShell, createButtonsForButtonBar, createDialogArea, firePageChanged, firePageChanging, getButton, getCurrentPage, getProgressMonitor, getSelectedPage, getShellStyle, getWizard, helpPressed, isModal, nextPressed, removePageChangedListener, removePageChangingListener, run, setButtonLayoutData, setMinimumPageSize, setMinimumPageSize, setModal, setPageSize, setPageSize, setShellStyle, setWizard, showPage, update, updateButtons, updateMessage, updateSize, updateSize, updateTitleBar, updateWindowTitle
      • Methods inherited from class org.eclipse.jface.dialogs.TitleAreaDialog

        getErrorMessage, getInitialSize, getMessage, getTitleArea, getTitleImageLabel, setErrorMessage, setMessage, setMessage, setTitle, setTitleAreaColor, setTitleImage
      • Methods inherited from class org.eclipse.jface.dialogs.TrayDialog

        closeTray, createButtonBar, createHelpControl, getLayout, getTray, handleShellCloseEvent, isDialogHelpAvailable, isHelpAvailable, openTray, setDialogHelpAvailable, setHelpAvailable
      • Methods inherited from class org.eclipse.jface.dialogs.Dialog

        applyDialogFont, convertHeightInCharsToPixels, convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, convertWidthInCharsToPixels, create, createButton, dialogFontIsDefault, getBlockedHandler, getButtonBar, getCancelButton, getDialogArea, getDialogBoundsSettings, getDialogBoundsStrategy, getImage, getInitialLocation, getOKButton, initializeBounds, initializeDialogUnits, isResizable, okPressed, setBlockedHandler, setButtonLayoutFormData, shortenText
      • Methods inherited from class org.eclipse.jface.window.Window

        canHandleShellCloseEvent, constrainShellSize, createShell, getConstrainedShellBounds, getContents, getDefaultImage, getDefaultImages, getDefaultOrientation, getParentShell, getReturnCode, getShell, getShellListener, getWindowManager, handleFontChange, open, setBlockOnOpen, setDefaultImage, setDefaultImages, setDefaultModalParent, setDefaultOrientation, setExceptionHandler, setParentShell, setReturnCode, setWindowManager
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • Methods inherited from interface org.eclipse.jface.wizard.IWizardContainer

        getShell
    • Constructor Detail

      • WizardDialog

        public WizardDialog​(org.eclipse.swt.widgets.Shell parentShell,
                            org.eclipse.jface.wizard.Wizard wizard)
        Creates a new wizard dialog for the given wizard.
        Parameters:
        parentShell - The parent shell.
        wizard - The wizard this dialog is working on.
      • WizardDialog

        public WizardDialog​(org.eclipse.swt.widgets.Shell parentShell,
                            org.eclipse.jface.wizard.Wizard wizard,
                            boolean checkStarting)
        Creates a new wizard dialog for the given wizard.
        Parameters:
        parentShell - The parent shell.
        wizard - The wizard this dialog is working on.
        checkStarting - Flag for checking of iizi starting up to display message and dismiss wizard if this is the case.
    • Method Detail

      • createContents

        protected org.eclipse.swt.widgets.Control createContents​(org.eclipse.swt.widgets.Composite parent)
        The WizardDialog implementation of this Window method calls call IWizard.addPages to allow the current wizard to add extra pages, then super.createContents to create the controls. It then calls IWizard.createPageControls to allow the wizard to pre-create their page controls prior to opening, so that the wizard opens to the correct size. And finally it shows the first page.
        Overrides:
        createContents in class org.eclipse.jface.wizard.WizardDialog
      • createProgressMonitorPart

        protected org.eclipse.jface.wizard.ProgressMonitorPart createProgressMonitorPart​(org.eclipse.swt.widgets.Composite composite,
                                                                                         org.eclipse.swt.layout.GridLayout layout)
        Hook method for subclasses to create a custom progress monitor part.
        Overrides:
        createProgressMonitorPart in class org.eclipse.jface.wizard.WizardDialog
        Parameters:
        composite - The parent composite.
        layout - The layout.
        Returns:
        ProgressMonitorPart the progress monitor part
      • finishPressed

        public void finishPressed()
        Called this method to simulate a finish.

        This method might close the dialog if it's OK to do so, i.e. the "performFinish()" method in the dialog returned true.

        Overrides:
        finishPressed in class org.eclipse.jface.wizard.WizardDialog