dropdownoptionformbean.java

A Java web application, based on Struts and Hibernate, that serves as an online running log. Users m

/* @LICENSE_COPYRIGHT@ */
package net.sf.irunninglog.servlet.formbean;

/**
 * Form bean used to represent a value (option) in a HTML drop-down (select)
 * input.  This bean stores values for the value to be displayed to the user,
 * the value to be submitted if selected, and a flag indicating whether an
 * option is the default selection.
 *
 * @author <a href="mailto:[e-mail]">Allan Lewis</a>
 * @version $Revision: 1.1.1.1 $ $Date: 2005/06/23 01:49:00 $
 * @since iRunningLog 1.0
 */
public final class DropDownOptionFormBean extends FormBean {

    /** String to be used as the value for the drop-down option. */
    private String mValue;
    /** String to be used as the display value for the drop-down option. */
    private String mDisplayValue;
    /** Flag indicating whether or not this option is the default selection. */
    private boolean mDefault;

    /**
     * Get the display value for this drop-down option.
     *
     * @return The display value for this drop-down
     */
    public String getDisplayValue() {
        return mDisplayValue;
    }

    /**
     * Set the display value for this drop-down.
     *
     * @param value The value to be set as the drop-down's display value
     */
    public void setDisplayValue(String value) {
        mDisplayValue = value;
    }

    /**
     * Get the value for this drop-down option.
     *
     * @return The value for this drop-down
     */
    public String getValue() {
        return mValue;
    }

    /**
     * Set the display value for this drop-down.
     *
     * @param value The value to be set as the drop-down's display value
     */
    public void setValue(String value) {
        mValue = value;
    }

    /**
     * Determine whether this drop down option is the default selection.
     *
     * @return True if this option is the default, false otherwise
     */
    public boolean isDefault() {
        return mDefault;
    }

    /**
     * Set whether or not this option should be the default selection.
     *
     * @param value A boolean indicating whether or not this option is the
     *              default selection.
     */
    public void setDefault(boolean value) {
        mDefault = value;
    }

}