org.nanes.slideset.io

Class CommandSkeletonService.CommandTemplateInputPicker

java.lang.Object

org.nanes.slideset.io.CommandSkeletonService.CommandTemplateInputPicker

All Implemented Interfaces:

PluginInputPicker

Enclosing class:

CommandSkeletonService

protected class CommandSkeletonService.CommandTemplateInputPicker
extends Object
implements PluginInputPicker

Field Summary

Fields

Modifier and Type	Field and Description
private CommandTemplate	ct

Constructor Summary

Constructors

Constructor and Description
CommandTemplateInputPicker(CommandTemplate ct)

Method Summary

Modifier and Type	Method and Description
void	addInput(String label, String[] choices, Object[] constantRequest, String[] acceptableValues) Register a plugin input and the options available for assigning its value.
void	getInputChoices(ArrayList<Integer> inputChoices, ArrayList<Object> constants) Get chosen options for assignment of each plugin input value.
void	setHelpPath(String helpPath, HelpLoader helpLoader) Register the documentation path for this plugin.

Methods inherited from class java.lang.Object

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

Field Detail

ct

private final CommandTemplate ct

Constructor Detail

CommandTemplateInputPicker

public CommandTemplateInputPicker(CommandTemplate ct)

Method Detail

addInput

public void addInput(String label,
                     String[] choices,
                     Object[] constantRequest,
                     String[] acceptableValues)

Description copied from interface: PluginInputPicker

Register a plugin input and the options available for assigning its value. This method is invoked sequentially for each input that cannot be filled automatically.

Specified by:

addInput in interface PluginInputPicker

Parameters:

label - Human-readable name of the input, i.e. for labeling a drop-down box.

choices - Human-readable names for each available option for assigning the input value.

constantRequest - If the corresponding option for assigning the input value requires a constant, the default value; otherwise, null. This array must have the same length as choices.

acceptableValues - List of acceptable String values for this input parameter, or null if not applicable (i.e. no list of acceptable values, or parameter does not take a String value).

setHelpPath

public void setHelpPath(String helpPath,
                        HelpLoader helpLoader)

Description copied from interface: PluginInputPicker

Register the documentation path for this plugin. If a documentation path is provided, the PluginInputPicker may provide a way to display it. This method may be called at any point before getInputChoices().

Specified by:

setHelpPath in interface PluginInputPicker

Parameters:

helpPath - Path specifying the documentation resource associated with the plugin whose parameters are being assigned.

helpLoader - HelpLoader which should be used to view the documentation.

getInputChoices

public void getInputChoices(ArrayList<Integer> inputChoices,
                            ArrayList<Object> constants)
                     throws OperationCanceledException

Description copied from interface: PluginInputPicker

Get chosen options for assignment of each plugin input value. This method is invoked after all inputs have been registered. If user input is required, it should block until all selections have been made.

Specified by:

getInputChoices in interface PluginInputPicker

Parameters:

inputChoices - Empty list to be filled with index values of the selected input sources. The order of values corresponds to the order in which the plugin inputs were registered through addInput. The values correspond to the indeces of the selected option in the choices array passed to addInput.

constants - Empty list to be filled with constant values selected, or null if no constant value is required for the selected option.

Throws:

OperationCanceledException - If the user aborts the plugin, for example, by dismissing a dialog box without making the required selections.