CheckBoxOption.java

Go to the documentation of this file.

/*
 * This file is part of JXClient, the Fullscreen Java Crossfire Client.
 *
 * JXClient is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * JXClient 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 General Public License
 * along with JXClient; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * Copyright (C) 2005-2008 Yann Chachkoff
 * Copyright (C) 2006-2017,2019-2023 Andreas Kirschbaum
 * Copyright (C) 2010-2012,2014-2018,2020-2023 Nicolas Weeger
 */
 
package com.realtime.crossfire.jxclient.settings.options;
 
import org.jetbrains.annotations.NotNull;
 
public abstract class CheckBoxOption extends Option {
 
    @NotNull
    private final String tooltipText;
 
    private boolean checked;
 
    protected CheckBoxOption(@NotNull final String tooltipText) {
        this.tooltipText = tooltipText;
    }
 
    public boolean isChecked() {
        return checked;
    }
 
    public void setChecked(final boolean checked) {
        if (this.checked == checked) {
            return;
        }
 
        this.checked = checked;
        fireStateChangedEvent();
    }
 
    public void toggleChecked() {
        setChecked(!checked);
    }
 
    protected abstract void execute(final boolean checked);
 
    @Override
    protected void fireStateChangedEvent() {
        execute(checked);
        super.fireStateChangedEvent();
    }
 
    public abstract boolean isDefaultChecked();
 
    @NotNull
    public String getTooltipText() {
        return tooltipText;
    }
 
}