atom.widget.CheckBox Maven / Gradle / Ivy

Go to download
/*
 * Copyright © 2014 Geeoz, and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * The Research Projects is dual-licensed under the GNU General Public
 * License, version 2.0 (GPLv2) and the Geeoz Commercial License.
 *
 * Solely for non-commercial purposes. A purpose is non-commercial only if
 * it is in no manner primarily intended for or directed toward commercial
 * advantage or private monetary compensation.
 *
 * This Geeoz Software is supplied to you by Geeoz in consideration of your
 * agreement to the following terms, and your use, installation, modification
 * or redistribution of this Geeoz Software constitutes acceptance of these
 * terms. If you do not agree with these terms, please do not use, install,
 * modify or redistribute this Geeoz Software.
 *
 * Neither the name, trademarks, service marks or logos of Geeoz may be used
 * to endorse or promote products derived from the Geeoz Software without
 * specific prior written permission from Geeoz.
 *
 * The Geeoz Software is provided by Geeoz on an "AS IS" basis. GEEOZ MAKES NO
 * WARRANTIES, EXPRESS  OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED
 * WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE, REGARDING THE GEEOZ SOFTWARE OR ITS USE AND OPERATION ALONE OR IN
 * COMBINATION WITH YOUR PRODUCTS.
 *
 * IN NO EVENT SHALL GEEOZ BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL
 * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION, MODIFICATION
 * AND/OR DISTRIBUTION OF THE GEEOZ SOFTWARE, HOWEVER CAUSED AND WHETHER UNDER
 * THEORY OF CONTRACT, TORT (INCLUDING NEGLIGENCE), STRICT LIABILITY OR
 * OTHERWISE, EVEN IF GEEOZ HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * A copy of the GNU General Public License is included in the distribution in
 * the file LICENSE and at
 *
 *     http://www.gnu.org/licenses/gpl-2.0.html
 *
 * If you are using the Research Projects for commercial purposes, we
 * encourage you to visit
 *
 *     http://products.geeoz.com/license
 *
 * for more details.
 *
 * This software or hardware and documentation may provide access to
 * or information on content, products, and services from third parties.
 * Geeoz and its affiliates are not responsible for and expressly disclaim
 * all warranties of any kind with respect to third-party content, products,
 * and services. Geeoz and its affiliates will not be responsible for any loss,
 * costs, or damages incurred due to your access to or use of third-party
 * content, products, or services. If a third-party content exists, the
 * additional copyright notices and license terms applicable to portions of the
 * software are set forth in the THIRD_PARTY_LICENSE_README file.
 *
 * Please contact Geeoz or visit www.geeoz.com if you need additional
 * information or have any questions.
 */

package atom.widget;

import atom.widget.constants.WidgetConstants;

import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlRootElement;
import java.util.Objects;

/**
 * A checkbox button is a two-states button that can be either checked or
 * unchecked. When the checkbox button is unchecked, the user can press or click
 * it to check it.
 *
 * @author Alex Voloshyn
 * @author Eugene Shevchenko
 * @author Serge Voloshyn
 * @version 1.5 11/17/14
 */
@XmlRootElement(name = "CheckBox")
public class CheckBox extends Button {
    /**
     * Serial version UID for serialization.
     */
    private static final long serialVersionUID = -8650791185351869800L;
    /**
     * Checked/unchecked flag.
     */
    private boolean checked;

    /**
     * Default constructor.
     */
    public CheckBox() {
        super();
    }

    /**
     * Creates instance with a defined id.
     *
     * @param viewId view identity
     */
    public CheckBox(final String viewId) {
        super(viewId);
    }

    /**
     * Retrieve the checked value that false by default.
     *
     * @return the checked value that false by default
     */
    @XmlAttribute(name = "checked")
    public boolean isChecked() {
        return checked;
    }

    /**
     * Sets the checked value that false by default.
     *
     * @param isChecked the checked value that false by default
     */
    public void setChecked(final boolean isChecked) {
        checked = isChecked;
        fireChange(WidgetConstants.CHECKED_NAME, checked);
    }

    @Override
    public boolean equals(final Object object) {
        boolean areEquals;
        if (this == object) {
            areEquals = true;
        } else {
            if (object instanceof CheckBox) {
                final CheckBox that = (CheckBox) object;
                areEquals = super.equals(that)
                        && Objects.equals(checked, that.checked);
            } else {
                areEquals = false;
            }
        }
        return areEquals;
    }

    @Override
    public int hashCode() {
        return Objects.hash(getViewId(), getText());
    }

    @Override
    public String toString() {
        return String.format(
                "CheckBox { "
                        + "viewId='%s', "
                        + "constraints='%s', "
                        + "styleName='%s', "
                        + "eventBits='%d', "
                        + "element='%s', "
                        + "text='%s' "
                        + "}",
                getViewId(),
                getConstraints(),
                getStyleName(),
                getEventBits(),
                getElement(),
                getText());
    }
}