Interface IWizardPageFragment


  • public interface IWizardPageFragment
    The wizard page fragment allows clients to extend existing wizard pages with UI content and wizard finish logic.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      boolean canFinish()
      Returns whether this wizard could be finished without further user interaction.
      void createPageControls​(org.eclipse.jface.wizard.IWizard wizard, org.eclipse.swt.widgets.Composite parent)
      Creates this wizard's page additional controls in the given parent control.
      void dispose()
      Disposes of this wizard and frees all UI resources.
      void performAfrerFinish​(org.eclipse.jface.wizard.IWizard wizard, org.eclipse.core.runtime.IProgressMonitor monitor)
      Performs any actions appropriate in response to the user having pressed the Finish button after actual wizard finish is performed.
      void performBeforeFinish​(org.eclipse.jface.wizard.IWizard wizard, org.eclipse.core.runtime.IProgressMonitor monitor)
      Performs any actions appropriate in response to the user having pressed the Finish button before actual wizard finish is performed.
      void refreshPageControls​(org.eclipse.jface.wizard.IWizard wizard)
      Refreshes the page additional controls state according to the wizard state.
    • Method Detail

      • canFinish

        boolean canFinish()
        Returns whether this wizard could be finished without further user interaction. The result of this method is typically used by the wizard container to enable or disable the Finish button.
        Returns:
        true if the wizard could be finished, and false otherwise
      • createPageControls

        void createPageControls​(org.eclipse.jface.wizard.IWizard wizard,
                                org.eclipse.swt.widgets.Composite parent)
        Creates this wizard's page additional controls in the given parent control. The wizard page calls this method to create the controls for the wizard's pages before the wizard is opened.
        Parameters:
        wizard - the parent wizard instance, cannot be null
        parent - the parent control, cannot be null
      • refreshPageControls

        void refreshPageControls​(org.eclipse.jface.wizard.IWizard wizard)
        Refreshes the page additional controls state according to the wizard state. The method is called by the wizard.
        Parameters:
        wizard - the parent wizard instance, cannot be null
      • performBeforeFinish

        void performBeforeFinish​(org.eclipse.jface.wizard.IWizard wizard,
                                 org.eclipse.core.runtime.IProgressMonitor monitor)
                          throws org.eclipse.core.runtime.CoreException
        Performs any actions appropriate in response to the user having pressed the Finish button before actual wizard finish is performed.
        Parameters:
        wizard - the parent wizard instance, cannot be null
        Throws:
        org.eclipse.core.runtime.CoreException - if finish performing failed
      • performAfrerFinish

        void performAfrerFinish​(org.eclipse.jface.wizard.IWizard wizard,
                                org.eclipse.core.runtime.IProgressMonitor monitor)
                         throws org.eclipse.core.runtime.CoreException
        Performs any actions appropriate in response to the user having pressed the Finish button after actual wizard finish is performed.
        Parameters:
        wizard - the parent wizard instance, cannot be null
        Throws:
        org.eclipse.core.runtime.CoreException - if finish performing failed
      • dispose

        void dispose()
        Disposes of this wizard and frees all UI resources.