Class AbstractProjectWizard<M extends MdObject,T extends AbstractProjectWizard.WizardModel<M>>

java.lang.Object
org.eclipse.jface.wizard.Wizard
All Implemented Interfaces:
IDtNewWizard<M>, org.eclipse.core.runtime.IExecutableExtension, org.eclipse.jface.window.IShellProvider, org.eclipse.jface.wizard.IWizard, org.eclipse.ui.INewWizard, org.eclipse.ui.IWorkbenchWizard
Direct Known Subclasses:
AbstractDependentProjectWizard, ConfigurationWizard

public class AbstractProjectWizard<M extends MdObject,T extends AbstractProjectWizard.WizardModel<M>> extends DtAefNewWizard<M>
Abstract wizard of dt projects or their root objects.
  • Field Details

  • Constructor Details

    • AbstractProjectWizard

      public AbstractProjectWizard()
  • Method Details

    • init

      public void init(org.eclipse.ui.IWorkbench workbench, IStructuredSelection selection)
      Description copied from class: DtNewWizard
      Specified by:
      init in interface org.eclipse.ui.IWorkbenchWizard
      Overrides:
      init in class DtNewWizard<M extends MdObject>
    • doAddPages

      public void doAddPages()
      Description copied from class: DtNewWizard
      The DtNewWizard implementation of this wizard method does nothing. Subclasses should extend if extra pages need to be added before the wizard opens. New pages should be added by calling addPage.
      Overrides:
      doAddPages in class DtNewWizard<M extends MdObject>
    • dispose

      public void dispose()
      Specified by:
      dispose in interface org.eclipse.jface.wizard.IWizard
      Overrides:
      dispose in class DtAefNewWizard<M extends MdObject>
    • getPageTitle

      public String getPageTitle()
      Returns:
      the pageTitle
    • getPageDescription

      public String getPageDescription()
      Returns:
      the pageDescription
    • setPageDescription

      public void setPageDescription(String pageDescription)
      Set the wizard main page description.
      Parameters:
      pageDescription - the wizard main page description to set, cannot be null
    • setPageTitle

      public void setPageTitle(String pageTitle)
      Set the wizard main page title.
      Parameters:
      pageTitle - the wizard main page title to set, cannot be null
    • getContextHelpId

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

      protected IModel getModelForPageComponent(NewWizardPageComponent<?> component)
      Description copied from class: DtAefNewWizard
      Returns AEF model for the given component. Override to support components that is added as pages with DtAefNewWizard.addPage(NewWizardPageComponent).
      Overrides:
      getModelForPageComponent in class DtAefNewWizard<M extends MdObject>
      Parameters:
      component - the component
      Returns:
      model for the given component or null.
    • createWizardModel

      protected T createWizardModel()
      Create wizard model.
      Returns:
      a new wizard model, never null
    • getOrCreateWizardModel

      protected final T getOrCreateWizardModel()
      Get wizard model or create if it is not exists.
      Returns:
      a new wizard model, cannot be null
    • needToCreateProject

      protected boolean needToCreateProject()
      Returns whether the wizard needs to create new project during model integration. Default value is false, implementation may change it with setNeedToCreateProject(boolean).
      Returns:
      whether the wizard needs to create new project during model integration
    • setNeedToCreateProject

      protected void setNeedToCreateProject(boolean needToCreateProject)
      Sets whether the wizard needs to create a new project during model integration.
      Parameters:
      needToCreateProject - the flag to set
    • getInitObjectName

      protected String getInitObjectName()
      Returns the wizard new object default name. Can be customized over setObjectNamePrefix() and getExistedNames().
      Returns:
      new object name
    • setObjectNamePrefix

      protected void setObjectNamePrefix(String prefix)
      Set the new object name prefix.
      Parameters:
      new - object name prefix to set, cannot be null
    • getObjectNamePrefix

      protected String getObjectNamePrefix()
      Returns the new object name prefix.
      Returns:
      object name prefix, cannot be null
    • getExistedNames

      protected Collection<String> getExistedNames()
      Returns the existed names for generate init object name.
      Returns:
      collection of already taken names, cannot be null
    • setObjectTypeNameMessage

      protected void setObjectTypeNameMessage(String objectTypeNameMsg)
      Set the object type name for validation messages. For example "Configuration name".
      Parameters:
      object - type name for validation messages to set, cannot be null
    • getProjectPath

      protected Path getProjectPath()
      Returns selected project path in the wizard, not null.
      Returns:
      the selected project path in the wizard, not null.
    • getProjectName

      protected String getProjectName()
      Returns selected project name in the wizard, not null.
      Returns:
      the selected project name in the wizard, not null.
    • getNameValidator

      protected org.eclipse.core.databinding.validation.IValidator getNameValidator()
      Returns validator for creating object name.
      Returns:
      object name validator, cannot be null