Package resources.projects.pluginwizard

Class SkeletonKit

java.lang.Object

resources.projects.pluginwizard.SkeletonKit

All Implemented Interfaces:

PluginWizardDialog.WizardKit

public class SkeletonKit
extends java.lang.Object
implements PluginWizardDialog.WizardKit

A plug-in wizard kit that creates basic skeleton code for a plug-in.

Since:

3.0

Author:

Chris Jennings

Constructor Summary

Constructors

Constructor	Description
SkeletonKit()	Creates a new plug-in wizard kit for creating basic plug-ins.

Method Summary

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SkeletonKit

public SkeletonKit()

Creates a new plug-in wizard kit for creating basic plug-ins.

Method Detail

getName

public java.lang.String getName()

Description copied from interface: PluginWizardDialog.WizardKit

Returns the short name of the kit that should be displayed in the list of available kits (plug-in project types).

Specified by:

getName in interface PluginWizardDialog.WizardKit

Returns:

the kit name

getDescription

public java.lang.String getDescription()

Description copied from interface: PluginWizardDialog.WizardKit

Returns a longer description of the kind of plug-in project that is created with the kit.

Specified by:

getDescription in interface PluginWizardDialog.WizardKit

Returns:

the kit description (basic HTML allowed)

createModel

public WizardModel createModel(Task task)

Description copied from interface: PluginWizardDialog.WizardKit

Creates a new WizardModel that provides the pages needed to complete the steps of this kit.

Specified by:

createModel in interface PluginWizardDialog.WizardKit

Parameters:

task - the task folder that will be filled in if the user completes the wizard

Returns:

the new model

createTask

public void createTask(WizardModel model,
                       Task task)
                throws java.lang.Exception

Description copied from interface: PluginWizardDialog.WizardKit

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.

Specified by:

createTask in interface PluginWizardDialog.WizardKit

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