Interface PluginWizardDialog.WizardKit

  • All Known Implementing Classes:
    SkeletonKit
    Enclosing class:
    PluginWizardDialog

    public static interface PluginWizardDialog.WizardKit
    A wizard kit allows you to define new kinds of plug-in wizard projects. All registered projects will be listed on the first page of the dialog, and when the user selects a project the matching kit will be used to provide the following pages. If the user finishes the wizard, the matching kit's createTask method will be called to fill in the task folder.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      WizardModel createModel​(Task task)
      Creates a new WizardModel that provides the pages needed to complete the steps of this kit.
      void createTask​(WizardModel model, Task task)
      Fills in an empty task folder using the information filled in by the user in the pages of the provided model.
      java.lang.String getDescription()
      Returns a longer description of the kind of plug-in project that is created with the kit.
      java.lang.String getName()
      Returns the short name of the kit that should be displayed in the list of available kits (plug-in project types).
    • Method Detail

      • getName

        java.lang.String getName()
        Returns the short name of the kit that should be displayed in the list of available kits (plug-in project types).
        Returns:
        the kit name
      • getDescription

        java.lang.String getDescription()
        Returns a longer description of the kind of plug-in project that is created with the kit.
        Returns:
        the kit description (basic HTML allowed)
      • createModel

        WizardModel createModel​(Task task)
        Creates a new WizardModel that provides the pages needed to complete the steps of this kit.
        Parameters:
        task - the task folder that will be filled in if the user completes the wizard
        Returns:
        the new model
      • createTask

        void createTask​(WizardModel model,
                        Task task)
                 throws java.lang.Exception
        Fills in an empty task folder using the information filled in by the user in the pages of the provided model. This will be called when the user finishes the wizard while this kit is active.
        Parameters:
        model - the previously created model that was presented to the user
        task - the empty task folder to be filled in
        Throws:
        java.lang.Exception - if an error occurs while the task is being created that prevents creation of the task