org.trianacode.gui.toolmaker

Class UnitWizard

java.lang.Object

org.trianacode.gui.toolmaker.UnitWizard

All Implemented Interfaces:

WizardListener

public class UnitWizard
extends java.lang.Object
implements WizardListener

A class for creating the template for an Triana tool This class is a stand alone application which can be run independantly of the Triana GUI, but can also be used from within the GUI.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AUTHOR
static java.lang.String	COPYRIGHT
static java.lang.String	CUSTOM_PANEL_TEMPLATE
static java.lang.String[]	DATA_TYPES valid data types
static java.lang.String	DATE
static java.lang.String	DEFAULT_INPUT_NODES
static java.lang.String	DEFAULT_OUTPUT_NODES
static java.lang.String	DEFAULT_TEMPLATE Template file names
static java.lang.String	DEFINE_PARAMS
static java.lang.String	HELPFILE
static java.lang.String	INIT_GUI
static java.lang.String	INIT_PARAMS
static java.lang.String	INPUT_TYPES
static java.lang.String	INPUT_TYPES_HTML
static java.lang.String	INTERNAL
static java.lang.String	MAX_INPUT_NODE
static java.lang.String	MAX_OUTPUT_NODE
static java.lang.String	MIN_INPUT_NODES
static java.lang.String	MIN_OUTPUT_NODES
static java.lang.String	NODE_INPUT_TYPES
static java.lang.String	NODE_OUTPUT_TYPES
static java.lang.String	OUTPUT_POLICY
static java.lang.String	OUTPUT_TYPES
static java.lang.String	OUTPUT_TYPES_HTML
static java.lang.String	PANELNAME
static java.lang.String[]	PARAM_TYPES
static java.lang.String	PARAM_UPDATE_POLICY
static java.lang.String	POPUP
static java.lang.String	PROCESS_CODE
static java.lang.String	RESET_PARAMS
static java.lang.String	TOOLNAME Default template tags
static java.lang.String	TRANSIENT
static java.lang.String	UPDATE_PARAMS
static java.lang.String	USER_ACCESSIBLE valid parameter types
protected WizardWindow	window the wizard window

Constructor Summary

Constructors

Constructor and Description
UnitWizard(ToolTable tools, java.awt.Frame owner)

Method Summary

Methods

Modifier and Type	Method and Description
void	cancelSelected(WizardWindow window) Called when cancel is selected on the wizard
java.lang.String	changeHTMLTags(java.lang.String template) construct an html set of input and output types and replace the tags in the template
void	finishSelected(WizardWindow window) Generate tool code if finish is selected
java.lang.String	getCustomPanelSourcePath()
java.lang.String	getOutputTypesString()
java.lang.String	getParamUpdateString(java.lang.String paramname, java.lang.String updatestr)
java.lang.String	getToolHelpFilePath()
java.lang.String	getToolSourcePath()
void	panelSelected(WizardWindow window, int index) Called when the specified panel index is make visible

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_TEMPLATE

public static final java.lang.String DEFAULT_TEMPLATE

Template file names

See Also:

Constant Field Values

CUSTOM_PANEL_TEMPLATE

public static final java.lang.String CUSTOM_PANEL_TEMPLATE

See Also:

Constant Field Values

TOOLNAME

public static final java.lang.String TOOLNAME

Default template tags

See Also:

Constant Field Values

AUTHOR

public static final java.lang.String AUTHOR

See Also:

Constant Field Values

POPUP

public static final java.lang.String POPUP

See Also:

Constant Field Values

DATE

public static final java.lang.String DATE

See Also:

Constant Field Values

HELPFILE

public static final java.lang.String HELPFILE

See Also:

Constant Field Values

COPYRIGHT

public static final java.lang.String COPYRIGHT

See Also:

Constant Field Values

NODE_INPUT_TYPES

public static final java.lang.String NODE_INPUT_TYPES

See Also:

Constant Field Values

INPUT_TYPES

public static final java.lang.String INPUT_TYPES

See Also:

Constant Field Values

NODE_OUTPUT_TYPES

public static final java.lang.String NODE_OUTPUT_TYPES

See Also:

Constant Field Values

OUTPUT_TYPES

public static final java.lang.String OUTPUT_TYPES

See Also:

Constant Field Values

INPUT_TYPES_HTML

public static final java.lang.String INPUT_TYPES_HTML

See Also:

Constant Field Values

OUTPUT_TYPES_HTML

public static final java.lang.String OUTPUT_TYPES_HTML

See Also:

Constant Field Values

DEFAULT_INPUT_NODES

public static final java.lang.String DEFAULT_INPUT_NODES

See Also:

Constant Field Values

MAX_INPUT_NODE

public static final java.lang.String MAX_INPUT_NODE

See Also:

Constant Field Values

MIN_INPUT_NODES

public static final java.lang.String MIN_INPUT_NODES

See Also:

Constant Field Values

DEFAULT_OUTPUT_NODES

public static final java.lang.String DEFAULT_OUTPUT_NODES

See Also:

Constant Field Values

MAX_OUTPUT_NODE

public static final java.lang.String MAX_OUTPUT_NODE

See Also:

Constant Field Values

MIN_OUTPUT_NODES

public static final java.lang.String MIN_OUTPUT_NODES

See Also:

Constant Field Values

PARAM_UPDATE_POLICY

public static final java.lang.String PARAM_UPDATE_POLICY

See Also:

Constant Field Values

OUTPUT_POLICY

public static final java.lang.String OUTPUT_POLICY

See Also:

Constant Field Values

DEFINE_PARAMS

public static final java.lang.String DEFINE_PARAMS

See Also:

Constant Field Values

INIT_PARAMS

public static final java.lang.String INIT_PARAMS

See Also:

Constant Field Values

RESET_PARAMS

public static final java.lang.String RESET_PARAMS

See Also:

Constant Field Values

UPDATE_PARAMS

public static final java.lang.String UPDATE_PARAMS

See Also:

Constant Field Values

INIT_GUI

public static final java.lang.String INIT_GUI

See Also:

Constant Field Values

PANELNAME

public static final java.lang.String PANELNAME

See Also:

Constant Field Values

PROCESS_CODE

public static final java.lang.String PROCESS_CODE

See Also:

Constant Field Values

DATA_TYPES

public static java.lang.String[] DATA_TYPES

valid data types

USER_ACCESSIBLE

public static java.lang.String USER_ACCESSIBLE

valid parameter types

INTERNAL

public static java.lang.String INTERNAL

TRANSIENT

public static java.lang.String TRANSIENT

PARAM_TYPES

public static java.lang.String[] PARAM_TYPES

window

protected WizardWindow window

the wizard window

Constructor Detail

UnitWizard

public UnitWizard(ToolTable tools,
          java.awt.Frame owner)

Method Detail

getToolSourcePath

public java.lang.String getToolSourcePath()

Returns:

the source file path for the tool

getToolHelpFilePath

public java.lang.String getToolHelpFilePath()

getCustomPanelSourcePath

public java.lang.String getCustomPanelSourcePath()

Returns:

the source file path for the custom panel

finishSelected

public void finishSelected(WizardWindow window)

Generate tool code if finish is selected

Specified by:

finishSelected in interface WizardListener

cancelSelected

public void cancelSelected(WizardWindow window)

Description copied from interface: WizardListener

Called when cancel is selected on the wizard

Specified by:

cancelSelected in interface WizardListener

panelSelected

public void panelSelected(WizardWindow window,
                 int index)

Description copied from interface: WizardListener

Called when the specified panel index is make visible

Specified by:

panelSelected in interface WizardListener

changeHTMLTags

public java.lang.String changeHTMLTags(java.lang.String template)

construct an html set of input and output types and replace the tags in the template

getOutputTypesString

public java.lang.String getOutputTypesString()

Returns:

a String representing an array of the output types

getParamUpdateString

public java.lang.String getParamUpdateString(java.lang.String paramname,
                                    java.lang.String updatestr)

Returns:

a String for updating the specfied parameter