Class DtNewWizardPage<M extends org.eclipse.emf.ecore.EObject>

  • All Implemented Interfaces:
    IDtNewWizardPage<M>, org.eclipse.jface.dialogs.IDialogPage, org.eclipse.jface.dialogs.IMessageProvider, org.eclipse.jface.wizard.IWizardPage
    Direct Known Subclasses:
    DtAefNewWizardPage

    public abstract class DtNewWizardPage<M extends org.eclipse.emf.ecore.EObject>
    extends org.eclipse.jface.wizard.WizardPage
    implements IDtNewWizardPage<M>
    Base class for all DT model-related wizard pages.
    • Field Summary

      • Fields inherited from interface org.eclipse.jface.dialogs.IMessageProvider

        ERROR, INFORMATION, NONE, WARNING
    • Constructor Summary

      Constructors 
      Constructor Description
      DtNewWizardPage​(String pageName)
      Instantiates a new DT wizard page.
    • Method Summary

      All Methods Instance Methods Concrete 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 createControl​(org.eclipse.swt.widgets.Composite parent)
      void dispose()
      void finish​(org.eclipse.core.runtime.IProgressMonitor monitor)
      Finishes the page, called at the wizard work end.
      protected IDtNewWizardContext<M> getContext()
      Returns the DT wizard contenxt, provided by the owner DT wizard.
      protected org.eclipse.core.databinding.DataBindingContext getDataBindingContext()
      Returns the wizard page databinding context.
      protected String getHelpContextId()
      Returns help context id to bind help to.
      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 class org.eclipse.jface.wizard.WizardPage

        canFlipToNextPage, getContainer, getDialogSettings, getImage, getName, getNextPage, getPreviousPage, getShell, getWizard, isCurrentPage, isPageComplete, setDescription, setErrorMessage, setImageDescriptor, setMessage, setPageComplete, setPreviousPage, setTitle, setWizard, toString
      • Methods inherited from class org.eclipse.jface.dialogs.DialogPage

        convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, getControl, getDescription, getDialogFontName, getErrorMessage, getFont, getMessage, getMessageType, getTitle, getToolTipText, initializeDialogUnits, isControlCreated, performHelp, setButtonLayoutData, setControl, setMessage, setVisible
      • Methods inherited from interface org.eclipse.jface.dialogs.IDialogPage

        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
    • Constructor Detail

      • DtNewWizardPage

        public DtNewWizardPage​(String pageName)
        Instantiates a new DT wizard page.
        Parameters:
        pageName - the page name, cannot be null
    • Method Detail

      • createControl

        public void createControl​(org.eclipse.swt.widgets.Composite parent)
        Specified by:
        createControl in interface org.eclipse.jface.dialogs.IDialogPage
      • initialize

        public 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.

        Specified by:
        initialize in interface IDtNewWizardPage<M extends org.eclipse.emf.ecore.EObject>
        Parameters:
        context - the DT wizard context to use by the page, cannot null
      • refresh

        public void refresh()
        Refreshes the page, called every time when the page is about to become visible.
        Specified by:
        refresh in interface IDtNewWizardPage<M extends org.eclipse.emf.ecore.EObject>
      • apply

        public void apply()
        Applies page changes to the context, called every time when the page is about to become hidden.
        Specified by:
        apply in interface IDtNewWizardPage<M extends org.eclipse.emf.ecore.EObject>
      • finish

        public void finish​(org.eclipse.core.runtime.IProgressMonitor monitor)
        Finishes the page, called at the wizard work end.
        Specified by:
        finish in interface IDtNewWizardPage<M extends org.eclipse.emf.ecore.EObject>
        Parameters:
        monitor - the monitor to report progress to, cannot null
      • dispose

        public void dispose()
        Specified by:
        dispose in interface org.eclipse.jface.dialogs.IDialogPage
        Overrides:
        dispose in class org.eclipse.jface.dialogs.DialogPage
      • onParentChanged

        public void onParentChanged()
        Description copied from interface: IDtNewWizardPage
        Handles the situation when the parent object of the wizard was changed.
        Specified by:
        onParentChanged in interface IDtNewWizardPage<M extends org.eclipse.emf.ecore.EObject>
      • getHelpContextId

        protected String getHelpContextId()
        Returns help context id to bind help to.
        Returns:
        help context id or null if no help is needed
      • getDataBindingContext

        protected org.eclipse.core.databinding.DataBindingContext getDataBindingContext()
        Returns the wizard page databinding context.
        Returns:
        the wizard page data binding context, never null
      • getContext

        protected IDtNewWizardContext<M> getContext()
        Returns the DT wizard contenxt, provided by the owner DT wizard.
        Returns:
        the wizard context, never null