DMDirc-Plugins/src/com/dmdirc/addons/ui_swing/components/ParamModePanel.java

/*
 * Copyright (c) 2006-2010 Chris Smith, Shane Mc Cormack, Gregory Holmes
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package com.dmdirc.addons.ui_swing.components;

import com.dmdirc.addons.ui_swing.UIUtilities;
import com.dmdirc.addons.ui_swing.components.validating.ValidatingJTextField;
import com.dmdirc.config.ConfigManager;
import com.dmdirc.config.prefs.validator.RegexStringValidator;

import java.awt.Component;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;

import javax.swing.JCheckBox;
import javax.swing.JPanel;

import net.miginfocom.swing.MigLayout;

/**
 * A component to encapsulate one parameter-requiring channel mode, displaying
 * the user a checkbox, the mode's name, and a text field.
 */
public final class ParamModePanel extends JPanel implements ActionListener {

    /**
     * A version number for this class. It should be changed whenever the class
     * structure is changed (or anything else that would prevent serialized
     * objects being unserialized with the new class).
     */
    private static final long serialVersionUID = 1;
    /** The checkbox used in this mode panel. */
    private final JCheckBox checkBox;
    /** The textfield for the value of the mode. */
    private final ValidatingJTextField textField;
    /** the mode this component represents. */
    private final String mode;
    /** Original mode value. */
    private final String originalValue;

    /**
     * Creates a new instance of ParamModePanel.
     * @param thisMode The mode that this panel should deal with
     * @param state The current state of the mode
     * @param value The current value of the mode
     * @param configManager The config manager to use to get mode names
     */
    public ParamModePanel(final String thisMode, final boolean state,
            final String value, final ConfigManager configManager) {
        super();
        this.mode = thisMode;
        this.originalValue = value;
        String text;
        String tooltip;
        if (configManager.hasOptionString("server", "mode" + mode)) {
            tooltip = "Mode " + mode + ": " + configManager.getOption(
                    "server", "mode" + mode);
        } else {
            tooltip = "Mode " + mode + ": Unknown";
        }

        setLayout(new MigLayout("fill"));

        text = "Mode " + mode + ": ";

        if (configManager.hasOptionString("server", "mode" + mode)) {
            text = configManager.getOption("server", "mode" + mode) +
                    " [+"+mode+"]: ";
        }

        checkBox = new JCheckBox(text, state);
        checkBox.setToolTipText(tooltip);
        checkBox.setOpaque(UIUtilities.getTabbedPaneOpaque());
        add(checkBox);

        textField = new ValidatingJTextField(new RegexStringValidator("^[^ ]*$",
                "Cannot contain spaces"));
        textField.setText(value);
        add(textField, "growx, pushx");

        if (!state) {
            textField.setEnabled(false);
        }

        checkBox.addActionListener(this);
    }

    /**
     * Called when our checkbox is toggled.
     * @param actionEvent associated action event
     */
    @Override
    public void actionPerformed(final ActionEvent actionEvent) {
        textField.setEnabled(checkBox.isSelected());
        if (checkBox.isSelected()) {
            textField.requestFocusInWindow();
        } else {
            textField.setText(originalValue);
        }

    }

    /**
     * returns the state of this component.
     * @return boolean state of mode
     */
    public boolean getState() {
        return checkBox.isSelected() && textField.validateText();
    }

    /**
     * returns the parameter of this mode if enabled, else returns an empty
     * string.
     * @return String mode parameter or "" if unset
     */
    public String getValue() {
        return textField.getText();
    }

    /**
     * Returns the name of the mode this component represents.
     * @return String name of the mode
     */
    public String getModeName() {
        return checkBox.getText();
    }

    /**
     * Returns the mode this component represents.
     * @return String mode
     */
    public String getMode() {
        return mode;
    }

    /**
     * Returns the checkbox component.
     * 
     * @return Checkbox component.
     */
    public Component getCheckboxComponent() {
        return checkBox;
    }

    /**
     * Returns the value component.
     * 
     * @return Value component
     */
    public Component getValueComponent() {
        return textField;
    }
}