Interface IDtNewWizardPage<M extends org.eclipse.emf.ecore.EObject>

  • All Superinterfaces:
    org.eclipse.jface.dialogs.IDialogPage, org.eclipse.jface.wizard.IWizardPage
    All Known Implementing Classes:
    DtAefNewWizardPage, DtNewWizardPage

    public interface IDtNewWizardPage<M extends org.eclipse.emf.ecore.EObject>
    extends org.eclipse.jface.wizard.IWizardPage
    Defines public contract of a DT wizard page. Pages can be used and added to the DT wizard programmically, but can be also described in plugin.xml as existing wizard extensions. Described pages will be contributed and added to defined DT wizard. They will be appended after programmically added pages in DT wizards.

    Following is an example definition of DT wizard extension with an extension page:

     <extension point="com._1c.g5.v8.dt.ui.dtNewWizardExtensions">
       <page
         class="com.exampe.wizards.page.ExamplePage"
         id="com.exampe.wizards.page.examplePageId"
         wizardId="com._1c.g5.v8.dt.md.ui.newV8project">
       </page>
     </extension>
    This interface is intended to be implemented by clients. Optionally, may be registered in plugin.xml as extension by clients.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void apply()
      Applies page changes to the context, called every time when the page is about to become hidden.
      void createPageControls​(org.eclipse.swt.widgets.Composite container)
      Creates page controls, called before the #initialize().
      void finish​(org.eclipse.core.runtime.IProgressMonitor monitor)
      Finishes the page, called at the wizard work end.
      void initialize​(IDtNewWizardContext<M> context)
      Initializes the page, called once at wizard creation.
      void onParentChanged()
      Handles the situation when the parent object of the wizard was changed.
      void refresh()
      Refreshes the page, called every time when the page is about to become visible.
      • Methods inherited from interface org.eclipse.jface.dialogs.IDialogPage

        createControl, dispose, getControl, getDescription, getErrorMessage, getImage, getMessage, getTitle, performHelp, setDescription, setImageDescriptor, setTitle, setVisible
      • Methods inherited from interface org.eclipse.jface.wizard.IWizardPage

        canFlipToNextPage, getName, getNextPage, getPreviousPage, getWizard, isPageComplete, setPreviousPage, setWizard
    • Method Detail

      • initialize

        void initialize​(IDtNewWizardContext<M> context)
        Initializes the page, called once at wizard creation. Wizard context and page controls are already available at this time.

        Page may use the given wizard context to work with the creating model instance or to manage wizard state.

        Parameters:
        context - the DT wizard context to use by the page, cannot null
      • refresh

        void refresh()
        Refreshes the page, called every time when the page is about to become visible.
      • apply

        void apply()
        Applies page changes to the context, called every time when the page is about to become hidden.
      • finish

        void finish​(org.eclipse.core.runtime.IProgressMonitor monitor)
        Finishes the page, called at the wizard work end.
        Parameters:
        monitor - the monitor to report progress to, cannot null
      • createPageControls

        void createPageControls​(org.eclipse.swt.widgets.Composite container)
        Creates page controls, called before the #initialize().
        Parameters:
        container - the container to host controls, cannot null
      • onParentChanged

        void onParentChanged()
        Handles the situation when the parent object of the wizard was changed.