X-Git-Url: http://git.nikiroo.be/?a=blobdiff_plain;f=src%2Fjexer%2FTRadioGroup.java;h=d6bd7ff38ee34c2b71a3546fb1cf1347e29c1dfe;hb=HEAD;hp=c1b652352d1b4b36049be132fed9fa229d96382e;hpb=00d2622b0fff2411dc81ee2a0cc43a5f3f52564c;p=fanfix.git diff --git a/src/jexer/TRadioGroup.java b/src/jexer/TRadioGroup.java index c1b6523..d6bd7ff 100644 --- a/src/jexer/TRadioGroup.java +++ b/src/jexer/TRadioGroup.java @@ -1,29 +1,27 @@ -/** +/* * Jexer - Java Text User Interface * - * License: LGPLv3 or later - * - * This module is licensed under the GNU Lesser General Public License - * Version 3. Please see the file "COPYING" in this directory for more - * information about the GNU Lesser General Public License Version 3. + * The MIT License (MIT) * - * Copyright (C) 2015 Kevin Lamonte + * Copyright (C) 2019 Kevin Lamonte * - * This program 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. + * 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: * - * This program 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. + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. * - * You should have received a copy of the GNU Lesser General Public - * License along with this program; if not, see - * http://www.gnu.org/licenses/, or write to the Free Software - * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA - * 02110-1301 USA + * 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. * * @author Kevin Lamonte [kevin.lamonte@gmail.com] * @version 1 @@ -31,11 +29,16 @@ package jexer; import jexer.bits.CellAttributes; +import jexer.bits.StringUtils; /** * TRadioGroup is a collection of TRadioButtons with a box and label. */ -public final class TRadioGroup extends TWidget { +public class TRadioGroup extends TWidget { + + // ------------------------------------------------------------------------ + // Variables -------------------------------------------------------------- + // ------------------------------------------------------------------------ /** * Label for this radio button group. @@ -48,28 +51,31 @@ public final class TRadioGroup extends TWidget { private TRadioButton selectedButton = null; /** - * Get the radio button ID that was selected. - * - * @return ID of the selected button, or 0 if no button is selected + * If true, one of the children MUST be selected. Note package private + * access. */ - public int getSelected() { - if (selectedButton == null) { - return 0; - } - return selectedButton.getId(); - } + boolean requiresSelection = false; + + // ------------------------------------------------------------------------ + // Constructors ----------------------------------------------------------- + // ------------------------------------------------------------------------ /** - * Set the new selected radio button. Note package private access. + * Public constructor. * - * @param button new button that became selected + * @param parent parent widget + * @param x column relative to parent + * @param y row relative to parent + * @param width width of group + * @param label label to display on the group box */ - void setSelected(final TRadioButton button) { - assert (button.getSelected()); - if (selectedButton != null) { - selectedButton.setSelected(false); - } - selectedButton = button; + public TRadioGroup(final TWidget parent, final int x, final int y, + final int width, final String label) { + + // Set parent and window + super(parent, x, y, width, 2); + + this.label = label; } /** @@ -84,13 +90,34 @@ public final class TRadioGroup extends TWidget { final String label) { // Set parent and window - super(parent); + super(parent, x, y, StringUtils.width(label) + 4, 2); - setX(x); - setY(y); - setHeight(2); this.label = label; - setWidth(label.length() + 4); + } + + // ------------------------------------------------------------------------ + // TWidget ---------------------------------------------------------------- + // ------------------------------------------------------------------------ + + /** + * Override TWidget's width: we can only set width at construction time. + * + * @param width new widget width (ignored) + */ + @Override + public void setWidth(final int width) { + // Do nothing + } + + /** + * Override TWidget's height: we can only set height at construction + * time. + * + * @param height new widget height (ignored) + */ + @Override + public void setHeight(final int height) { + // Do nothing } /** @@ -100,17 +127,80 @@ public final class TRadioGroup extends TWidget { public void draw() { CellAttributes radioGroupColor; - if (getAbsoluteActive()) { + if (isAbsoluteActive()) { radioGroupColor = getTheme().getColor("tradiogroup.active"); } else { radioGroupColor = getTheme().getColor("tradiogroup.inactive"); } - getScreen().drawBox(0, 0, getWidth(), getHeight(), - radioGroupColor, radioGroupColor, 3, false); + drawBox(0, 0, getWidth(), getHeight(), radioGroupColor, radioGroupColor, + 3, false); - getScreen().hLineXY(1, 0, label.length() + 2, ' ', radioGroupColor); - getScreen().putStrXY(2, 0, label, radioGroupColor); + hLineXY(1, 0, StringUtils.width(label) + 2, ' ', radioGroupColor); + putStringXY(2, 0, label, radioGroupColor); + } + + // ------------------------------------------------------------------------ + // TRadioGroup ------------------------------------------------------------ + // ------------------------------------------------------------------------ + + /** + * Get the radio button ID that was selected. + * + * @return ID of the selected button, or 0 if no button is selected + */ + public int getSelected() { + if (selectedButton == null) { + return 0; + } + return selectedButton.getId(); + } + + /** + * Set the new selected radio button. 1-based. + * + * @param id ID of the selected button, or 0 to unselect + */ + public void setSelected(final int id) { + if ((id < 0) || (id > getChildren().size())) { + return; + } + + for (TWidget widget: getChildren()) { + ((TRadioButton) widget).selected = false; + } + if (id == 0) { + selectedButton = null; + return; + } + assert ((id > 0) && (id <= getChildren().size())); + TRadioButton button = (TRadioButton) (getChildren().get(id - 1)); + button.selected = true; + selectedButton = button; + } + + /** + * Get the radio button that was selected. + * + * @return the selected button, or null if no button is selected + */ + public TRadioButton getSelectedButton() { + return selectedButton; + } + + /** + * Convenience function to add a radio button to this group. + * + * @param label label to display next to (right of) the radiobutton + * @param selected if true, this will be the selected radiobutton + * @return the new radio button + */ + public TRadioButton addRadioButton(final String label, + final boolean selected) { + + TRadioButton button = addRadioButton(label); + setSelected(button.id); + return button; } /** @@ -120,14 +210,57 @@ public final class TRadioGroup extends TWidget { * @return the new radio button */ public TRadioButton addRadioButton(final String label) { - int buttonX = 1; - int buttonY = getChildren().size() + 1; - if (label.length() + 4 > getWidth()) { - setWidth(label.length() + 7); + return new TRadioButton(this, 0, 0, label, 0); + } + + /** + * Package private method for RadioButton to add itself to a RadioGroup + * container. + * + * @param button the button to add + */ + void addRadioButton(final TRadioButton button) { + super.setHeight(getChildren().size() + 2); + button.setX(1); + button.setY(getChildren().size()); + button.id = getChildren().size(); + String label = button.getMnemonic().getRawLabel(); + + if (StringUtils.width(label) + 4 > getWidth()) { + super.setWidth(StringUtils.width(label) + 7); + } + + if (getParent().getLayoutManager() != null) { + getParent().getLayoutManager().resetSize(this); + } + + // Default to the first item on the list. + activate(getChildren().get(0)); + } + + /** + * Get the requires selection flag. + * + * @return true if this radiogroup requires that one of the buttons be + * selected + */ + public boolean getRequiresSelection() { + return requiresSelection; + } + + /** + * Set the requires selection flag. + * + * @param requiresSelection if true, then this radiogroup requires that + * one of the buttons be selected + */ + public void setRequiresSelection(final boolean requiresSelection) { + this.requiresSelection = requiresSelection; + if (requiresSelection) { + if ((getChildren().size() > 0) && (selectedButton == null)) { + setSelected(1); + } } - setHeight(getChildren().size() + 3); - return new TRadioButton(this, buttonX, buttonY, label, - getChildren().size() + 1); } }