com.anrisoftware.prefdialog.fields.checkbox.CheckBoxField Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2013-2015 Erwin Müller 
 *
 * This file is part of prefdialog-corefields.
 *
 * prefdialog-corefields is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by the
 * Free Software Foundation, either version 3 of the License, or (at your
 * option) any later version.
 *
 * prefdialog-corefields is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with prefdialog-corefields. If not, see .
 */
package com.anrisoftware.prefdialog.fields.checkbox;

import java.beans.PropertyVetoException;

import javax.inject.Inject;
import javax.swing.JCheckBox;

import com.anrisoftware.prefdialog.annotations.CheckBox;
import com.anrisoftware.prefdialog.fields.fieldbutton.AbstractFieldButtonField;
import com.google.inject.assistedinject.Assisted;

/**
 * Check box field.
 * 
 * @see CheckBox
 * @see CheckBoxFieldFactory
 * 
 * @author Erwin Mueller, [email protected]
 * @since 3.0
 */
@SuppressWarnings("serial")
public class CheckBoxField extends AbstractFieldButtonField {

    private final CheckBoxFieldLogger log;

    /**
     * @see CheckBoxFieldFactory#create(Object, String)
     */
    @Inject
    CheckBoxField(CheckBoxFieldLogger logger, @Assisted Object parentObject,
            @Assisted String fieldName) {
        super(new JCheckBox(), parentObject, fieldName);
        this.log = logger;
    }

    /**
     * Sets the boolean value for the check-box.
     * 
     * @param value
     *            the new boolean value. {@code true} for a checked check-box
     *            and {@code false} for unchecked.
     * 
     * @throws PropertyVetoException
     *             if the user input is not valid.
     * 
     * @throws IllegalArgumentException
     *             if the value is not a boolean value.
     */
    @Override
    public void setValue(Object value) throws PropertyVetoException {
        super.setValue(value);
        log.checkValue(this, value);
        getComponent().setSelected((Boolean) value);
    }

    /**
     * Sets the check-box selected.
     * 
     * @param flag
     *            set to {@code true} to select the check-box.
     * 
     * @throws PropertyVetoException
     *             if the user input is not valid.
     */
    public void setSelected(boolean flag) throws PropertyVetoException {
        setValue(flag);
    }
}