edu.wisc.ssec.mcidasv.startupmanager.options

Class FileOption

java.lang.Object

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

edu.wisc.ssec.mcidasv.startupmanager.options.FileOption

All Implemented Interfaces:

Option

public final class FileOption
extends AbstractOption

Represents a file selection.

Field Summary

Fields

Modifier and Type	Field and Description
private JButton	browseButton Used to pop up a JFileChooser.
private static String	BUNDLE_DIR Name of the "bundle" subdirectory of the user path.
static String	BUNDLE_FIELD_TIP Tool tip used by bundleField.
private JTextField	bundleField Shows current default bundle.
private static String	BUTTON_LABEL Label for browseButton.
private boolean	checkbox Current state of enableCheckBox.
private static String	CHECKBOX_LABEL Label for enableCheckBox.
private static Pattern	CLEAN_VALUE_REGEX Regular expression pattern for ensuring that no quote marks are present.
private String	defaultBundle Default path for bundleField.
private boolean	defaultCheckBox Default state of enableCheckBox.
private String	defaultValue Default option value.
private JCheckBox	enableCheckBox Whether or not the default bundle should be used.
private static String	FALSE_STRING Constant that represents string version of the 0 boolean.
private static String	FORMAT Formatting string used by toString().
private String	path Current contents of bundleField.
private static String	TRUE_STRING Constant that represents string version of the 1 boolean.
private static String	USERPATH System property that points to the McIDAS-V user path.

Constructor Summary

Constructors

Constructor and Description
FileOption(String id, String label, String defaultValue, OptionMaster.OptionPlatform platform, OptionMaster.Visibility visibility) Create a new "file option" that allows the user to select a file.

Method Summary

Modifier and Type	Method and Description
static boolean	booleanFromFormat(String value) Convert the strings 1 and 0 to their corresponding boolean values.
private void	browseButtonActionPerformed(ActionEvent event) Handles the user clicking on the browseButton.
String	getBundlePath() Returns a string representating the path to the startup bundle.
String	getCheckBoxValue() Returns a string representation of enableCheckBox.
JComponent	getComponent() Returns the GUI component that represents the option.
String	getValue() Returns a string containing the state of enableCheckBox and bundleField.
static String[]	parseFormat(String format) Attempt to extract something sensible from the value given in "runMcV-Prefs".
private String	selectBundle(String bundleDirectory) Show a JFileChooser dialog that allows the user to select a bundle.
void	setValue(String newValue) Forces the value of the option to the data specified.
String	toString() Friendly string representation of the option.

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

fromPrefsFormat, 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

BUTTON_LABEL

private static final String BUTTON_LABEL

Label for browseButton.

See Also:

Constant Field Values

CHECKBOX_LABEL

private static final String CHECKBOX_LABEL

Label for enableCheckBox.

See Also:

Constant Field Values

USERPATH

private static final String USERPATH

System property that points to the McIDAS-V user path.

See Also:

Constant Field Values

BUNDLE_DIR

private static final String BUNDLE_DIR

Name of the "bundle" subdirectory of the user path.

See Also:

Constant Field Values

TRUE_STRING

private static final String TRUE_STRING

Constant that represents string version of the 1 boolean.

See Also:

Constant Field Values

FALSE_STRING

private static final String FALSE_STRING

Constant that represents string version of the 0 boolean.

See Also:

Constant Field Values

CLEAN_VALUE_REGEX

private static final Pattern CLEAN_VALUE_REGEX

Regular expression pattern for ensuring that no quote marks are present.

FORMAT

private static final String FORMAT

Formatting string used by toString().

See Also:

Constant Field Values

BUNDLE_FIELD_TIP

public static final String BUNDLE_FIELD_TIP

Tool tip used by bundleField.

See Also:

Constant Field Values

defaultValue

private final String defaultValue

Default option value. See OptionMaster.blahblah.

defaultCheckBox

private final boolean defaultCheckBox

Default state of enableCheckBox.

defaultBundle

private final String defaultBundle

Default path for bundleField.

bundleField

private JTextField bundleField

Shows current default bundle. Empty means there isn't one. May be null!

browseButton

private JButton browseButton

Used to pop up a JFileChooser. May be null!

enableCheckBox

private JCheckBox enableCheckBox

Whether or not the default bundle should be used. May be null!

checkbox

private boolean checkbox

Current state of enableCheckBox.

path

private String path

Current contents of bundleField. Value may be null!

Constructor Detail

FileOption

public FileOption(String id,
                  String label,
                  String defaultValue,
                  OptionMaster.OptionPlatform platform,
                  OptionMaster.Visibility visibility)

Create a new "file option" that allows the user to select a file.

Parameters:

id - Option ID.

label - Option label (used in GUI).

defaultValue - Default option value.

platform - Platform restrictions for the option.

visibility - Visibility restrictions for the option.

Method Detail

browseButtonActionPerformed

private void browseButtonActionPerformed(ActionEvent event)

Handles the user clicking on the browseButton.

Parameters:

event - Currently ignored.

selectBundle

private String selectBundle(String bundleDirectory)

Show a JFileChooser dialog that allows the user to select a bundle.

Parameters:

bundleDirectory - Initial directory for the JFileChooser.

Returns:

Either the path to the user's chosen bundle, or defaultValue if the user cancelled.

getComponent

public JComponent getComponent()

Returns the GUI component that represents the option.

Specified by:

getComponent in interface Option

Specified by:

getComponent in class AbstractOption

Returns:

GUI representation of this option.

getValue

public String getValue()

Returns a string containing the state of enableCheckBox and bundleField.

Results should look like 0;/path/to/bundle.mcv.

Specified by:

getValue in interface Option

Specified by:

getValue in class AbstractOption

Returns:

Current value of the option.

getCheckBoxValue

public String getCheckBoxValue()

Returns a string representation of enableCheckBox.

Returns:

Either 1 or 0 depending upon the state of enableCheckBox.

getBundlePath

public String getBundlePath()

Returns a string representating the path to the startup bundle.

Returns:

If bundleField is null, defaultBundle is returned. Otherwise the contents of the text field are returned.

setValue

public void setValue(String newValue)

Forces the value of the option to the data specified.

Specified by:

setValue in interface Option

Specified by:

setValue in class AbstractOption

Parameters:

newValue - New value to use.

toString

public String toString()

Friendly string representation of the option.

Specified by:

toString in interface Option

Specified by:

toString in class AbstractOption

Returns:

String containing relevant info about the option.

See Also:

TextOption.toString(), BooleanOption.toString()

parseFormat

public static String[] parseFormat(String format)

Attempt to extract something sensible from the value given in "runMcV-Prefs".

Expected format is something like "0;/path/to/bundle.mcv" or "1;". The first example would signify that enableCheckBox is not selected, and the contents of bundleField are /path/to/bundle.mcv. The second example would signify that enableCheckBox is selected, and the contents of bundleField should be an empty string.

Parameters:

format - See method description for details. null not allowed.

Returns:

Two element array where the first element is the state of enableCheckBox and the second is the bundle path. Note that the bundle path may be empty.

See Also:

booleanFromFormat(String)

booleanFromFormat

public static boolean booleanFromFormat(String value)

Convert the strings 1 and 0 to their corresponding boolean values.

Parameters:

value - String to convert. null or empty strings accepted.

Returns:

Returns true if value is 1. Otherwise returns false.