edu.wisc.ssec.mcidasv.startupmanager.options

Class TextOption

java.lang.Object

edu.wisc.ssec.mcidasv.startupmanager.options.AbstractOption

edu.wisc.ssec.mcidasv.startupmanager.options.TextOption

All Implemented Interfaces:

Option

public class TextOption
extends AbstractOption

Field Summary

Fields

Modifier and Type	Field and Description
private String	value Text field value.

Constructor Summary

Constructors

Constructor and Description
TextOption(String id, String label, String defaultValue, OptionMaster.OptionPlatform optionPlatform, OptionMaster.Visibility optionVisibility) Create a startup option that allows the user to supply arbitrary text.

Method Summary

Modifier and Type	Method and Description
void	fromPrefsFormat(String text) Initializes the current option using a relevant variable from the startup script.
JTextField	getComponent() Builds a JTextField containing the text value specified in the constructor.
String	getValue() Returns the user's input (or the default value).
static String	removeOutermostQuotes(String value) If the given String begins and ends with OptionMaster.QUOTE_STRING, this method will return the given String without the "outermost" quote pair.
void	setValue(String newValue) Stores the user's input.
String	toString() String representation of this TextOption.

Methods inherited from class edu.wisc.ssec.mcidasv.startupmanager.options.AbstractOption

getLabel, getOptionId, getOptionPlatform, getOptionType, getOptionVisibility, isValidPrefFormat, onValidPlatform, toPrefsFormat

Methods inherited from class java.lang.Object

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

Field Detail

value

private String value

Text field value.

Constructor Detail

TextOption

public TextOption(String id,
                  String label,
                  String defaultValue,
                  OptionMaster.OptionPlatform optionPlatform,
                  OptionMaster.Visibility optionVisibility)

Create a startup option that allows the user to supply arbitrary text.

NOTE: null is not a permitted value for any of this constructor's parameters.

Parameters:

id - Identifier for this startup option.

label - Brief description suitable for a GUI label.

defaultValue - Default value for this startup option.

optionPlatform - Platforms where this option may be applied.

optionVisibility - Whether or not the option is presented via the GUI.

Method Detail

getComponent

public JTextField getComponent()

Builds a JTextField containing the text value specified in the constructor.

Specified by:

getComponent in interface Option

Specified by:

getComponent in class AbstractOption

Returns:

JTextField to present to the user.

getValue

public String getValue()

Returns the user's input (or the default value).

Specified by:

getValue in interface Option

Specified by:

getValue in class AbstractOption

Returns:

Input or default value.

setValue

public void setValue(String newValue)

Stores the user's input.

Specified by:

setValue in interface Option

Specified by:

setValue in class AbstractOption

Parameters:

newValue - User input. Should not be null; use a zero length String to specify an empty value.

fromPrefsFormat

public void fromPrefsFormat(String text)

Initializes the current option using a relevant variable from the startup script.

Specified by:

fromPrefsFormat in interface Option

Overrides:

fromPrefsFormat in class AbstractOption

Parameters:

text - Line from the startup script that represents the current option. null is not allowed.

Throws:

IllegalArgumentException - if text is not in the proper format for the current platform.

toString

public String toString()

String representation of this TextOption.

Specified by:

toString in interface Option

Specified by:

toString in class AbstractOption

Returns:

String that looks something like "[TextOption@7825114a: optionId=BLAH value=USER INPUT]".

See Also:

toString(), BooleanOption.toString()

removeOutermostQuotes

public static String removeOutermostQuotes(String value)

If the given String begins and ends with OptionMaster.QUOTE_STRING, this method will return the given String without the "outermost" quote pair. Otherwise the String is returned without modification.

Parameters:

value - String from which the outermost pair of quotes should be removed. Cannot be null.

Returns:

Either value with the outermost pair of quotes removed, or value, unmodified.