2 * Jexer - Java Text User Interface
4 * The MIT License (MIT)
6 * Copyright (C) 2019 Kevin Lamonte
8 * Permission is hereby granted, free of charge, to any person obtaining a
9 * copy of this software and associated documentation files (the "Software"),
10 * to deal in the Software without restriction, including without limitation
11 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
12 * and/or sell copies of the Software, and to permit persons to whom the
13 * Software is furnished to do so, subject to the following conditions:
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
21 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
23 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
24 * DEALINGS IN THE SOFTWARE.
26 * @author Kevin Lamonte [kevin.lamonte@gmail.com]
31 import jexer
.bits
.CellAttributes
;
32 import jexer
.bits
.StringUtils
;
35 * TRadioGroup is a collection of TRadioButtons with a box and label.
37 public class TRadioGroup
extends TWidget
{
39 // ------------------------------------------------------------------------
40 // Variables --------------------------------------------------------------
41 // ------------------------------------------------------------------------
44 * Label for this radio button group.
49 * Only one of my children can be selected.
51 private TRadioButton selectedButton
= null;
54 * If true, one of the children MUST be selected. Note package private
57 boolean requiresSelection
= true;
59 // ------------------------------------------------------------------------
60 // Constructors -----------------------------------------------------------
61 // ------------------------------------------------------------------------
66 * @param parent parent widget
67 * @param x column relative to parent
68 * @param y row relative to parent
69 * @param label label to display on the group box
71 public TRadioGroup(final TWidget parent
, final int x
, final int y
,
74 // Set parent and window
75 super(parent
, x
, y
, StringUtils
.width(label
) + 4, 2);
80 // ------------------------------------------------------------------------
81 // TWidget ----------------------------------------------------------------
82 // ------------------------------------------------------------------------
85 * Draw a radio button with label.
89 CellAttributes radioGroupColor
;
91 if (isAbsoluteActive()) {
92 radioGroupColor
= getTheme().getColor("tradiogroup.active");
94 radioGroupColor
= getTheme().getColor("tradiogroup.inactive");
97 drawBox(0, 0, getWidth(), getHeight(), radioGroupColor
, radioGroupColor
,
100 hLineXY(1, 0, StringUtils
.width(label
) + 2, ' ', radioGroupColor
);
101 putStringXY(2, 0, label
, radioGroupColor
);
104 // ------------------------------------------------------------------------
105 // TRadioGroup ------------------------------------------------------------
106 // ------------------------------------------------------------------------
109 * Get the radio button ID that was selected.
111 * @return ID of the selected button, or 0 if no button is selected
113 public int getSelected() {
114 if (selectedButton
== null) {
117 return selectedButton
.getId();
121 * Set the new selected radio button. Note package private access.
123 * @param button new button that became selected
125 void setSelected(final TRadioButton button
) {
126 assert (button
.isSelected());
127 if ((selectedButton
!= null) && (selectedButton
!= button
)) {
128 selectedButton
.setSelected(false);
130 selectedButton
= button
;
134 * Set the new selected radio button. 1-based.
136 * @param id ID of the selected button, or 0 to unselect
138 public void setSelected(final int id
) {
139 if ((id
< 0) || (id
> getChildren().size())) {
144 for (TWidget widget
: getChildren()) {
145 ((TRadioButton
) widget
).setSelected(false);
147 selectedButton
= null;
150 assert ((id
> 0) && (id
<= getChildren().size()));
151 TRadioButton button
= (TRadioButton
) (getChildren().get(id
- 1));
152 button
.setSelected(true);
153 selectedButton
= button
;
157 * Convenience function to add a radio button to this group.
159 * @param label label to display next to (right of) the radiobutton
160 * @return the new radio button
162 public TRadioButton
addRadioButton(final String label
) {
164 int buttonY
= getChildren().size() + 1;
165 if (StringUtils
.width(label
) + 4 > getWidth()) {
166 setWidth(StringUtils
.width(label
) + 7);
168 setHeight(getChildren().size() + 3);
169 TRadioButton button
= new TRadioButton(this, buttonX
, buttonY
, label
,
170 getChildren().size() + 1);
172 // Default to the first item on the list.
173 activate(getChildren().get(0));