Commit | Line | Data |
---|---|---|
daa4106c | 1 | /* |
00d2622b KL |
2 | * Jexer - Java Text User Interface |
3 | * | |
e16dda65 | 4 | * The MIT License (MIT) |
00d2622b | 5 | * |
a69ed767 | 6 | * Copyright (C) 2019 Kevin Lamonte |
00d2622b | 7 | * |
e16dda65 KL |
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: | |
00d2622b | 14 | * |
e16dda65 KL |
15 | * The above copyright notice and this permission notice shall be included in |
16 | * all copies or substantial portions of the Software. | |
00d2622b | 17 | * |
e16dda65 KL |
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. | |
00d2622b KL |
25 | * |
26 | * @author Kevin Lamonte [kevin.lamonte@gmail.com] | |
27 | * @version 1 | |
28 | */ | |
29 | package jexer; | |
30 | ||
31 | import jexer.bits.CellAttributes; | |
9f613a0c | 32 | import jexer.bits.StringUtils; |
00d2622b KL |
33 | |
34 | /** | |
35 | * TRadioGroup is a collection of TRadioButtons with a box and label. | |
36 | */ | |
051e2913 | 37 | public class TRadioGroup extends TWidget { |
00d2622b | 38 | |
615a0d99 KL |
39 | // ------------------------------------------------------------------------ |
40 | // Variables -------------------------------------------------------------- | |
41 | // ------------------------------------------------------------------------ | |
42 | ||
00d2622b KL |
43 | /** |
44 | * Label for this radio button group. | |
45 | */ | |
46 | private String label; | |
47 | ||
48 | /** | |
49 | * Only one of my children can be selected. | |
50 | */ | |
51 | private TRadioButton selectedButton = null; | |
52 | ||
00691e80 KL |
53 | /** |
54 | * If true, one of the children MUST be selected. Note package private | |
55 | * access. | |
56 | */ | |
b2efac6e | 57 | boolean requiresSelection = false; |
00691e80 | 58 | |
615a0d99 KL |
59 | // ------------------------------------------------------------------------ |
60 | // Constructors ----------------------------------------------------------- | |
61 | // ------------------------------------------------------------------------ | |
00d2622b KL |
62 | |
63 | /** | |
64 | * Public constructor. | |
65 | * | |
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 | |
70 | */ | |
71 | public TRadioGroup(final TWidget parent, final int x, final int y, | |
72 | final String label) { | |
73 | ||
74 | // Set parent and window | |
9f613a0c | 75 | super(parent, x, y, StringUtils.width(label) + 4, 2); |
00d2622b | 76 | |
00d2622b | 77 | this.label = label; |
00d2622b KL |
78 | } |
79 | ||
615a0d99 KL |
80 | // ------------------------------------------------------------------------ |
81 | // TWidget ---------------------------------------------------------------- | |
82 | // ------------------------------------------------------------------------ | |
83 | ||
d8dc8aea KL |
84 | /** |
85 | * Override TWidget's width: we can only set width at construction time. | |
86 | * | |
87 | * @param width new widget width (ignored) | |
88 | */ | |
89 | @Override | |
90 | public void setWidth(final int width) { | |
91 | // Do nothing | |
92 | } | |
93 | ||
94 | /** | |
95 | * Override TWidget's height: we can only set height at construction | |
96 | * time. | |
97 | * | |
98 | * @param height new widget height (ignored) | |
99 | */ | |
100 | @Override | |
101 | public void setHeight(final int height) { | |
102 | // Do nothing | |
103 | } | |
104 | ||
00d2622b KL |
105 | /** |
106 | * Draw a radio button with label. | |
107 | */ | |
108 | @Override | |
109 | public void draw() { | |
110 | CellAttributes radioGroupColor; | |
111 | ||
7c870d89 | 112 | if (isAbsoluteActive()) { |
00d2622b KL |
113 | radioGroupColor = getTheme().getColor("tradiogroup.active"); |
114 | } else { | |
115 | radioGroupColor = getTheme().getColor("tradiogroup.inactive"); | |
116 | } | |
117 | ||
a69ed767 KL |
118 | drawBox(0, 0, getWidth(), getHeight(), radioGroupColor, radioGroupColor, |
119 | 3, false); | |
00d2622b | 120 | |
9f613a0c | 121 | hLineXY(1, 0, StringUtils.width(label) + 2, ' ', radioGroupColor); |
a69ed767 | 122 | putStringXY(2, 0, label, radioGroupColor); |
00d2622b KL |
123 | } |
124 | ||
615a0d99 KL |
125 | // ------------------------------------------------------------------------ |
126 | // TRadioGroup ------------------------------------------------------------ | |
127 | // ------------------------------------------------------------------------ | |
128 | ||
129 | /** | |
130 | * Get the radio button ID that was selected. | |
131 | * | |
132 | * @return ID of the selected button, or 0 if no button is selected | |
133 | */ | |
134 | public int getSelected() { | |
135 | if (selectedButton == null) { | |
136 | return 0; | |
137 | } | |
138 | return selectedButton.getId(); | |
139 | } | |
140 | ||
00691e80 KL |
141 | /** |
142 | * Set the new selected radio button. 1-based. | |
143 | * | |
144 | * @param id ID of the selected button, or 0 to unselect | |
145 | */ | |
146 | public void setSelected(final int id) { | |
147 | if ((id < 0) || (id > getChildren().size())) { | |
148 | return; | |
149 | } | |
150 | ||
b2efac6e KL |
151 | for (TWidget widget: getChildren()) { |
152 | ((TRadioButton) widget).selected = false; | |
153 | } | |
00691e80 | 154 | if (id == 0) { |
00691e80 KL |
155 | selectedButton = null; |
156 | return; | |
157 | } | |
158 | assert ((id > 0) && (id <= getChildren().size())); | |
159 | TRadioButton button = (TRadioButton) (getChildren().get(id - 1)); | |
b2efac6e | 160 | button.selected = true; |
00691e80 KL |
161 | selectedButton = button; |
162 | } | |
163 | ||
b2efac6e KL |
164 | /** |
165 | * Get the radio button that was selected. | |
166 | * | |
167 | * @return the selected button, or null if no button is selected | |
168 | */ | |
169 | public TRadioButton getSelectedButton() { | |
170 | return selectedButton; | |
171 | } | |
172 | ||
173 | /** | |
174 | * Convenience function to add a radio button to this group. | |
175 | * | |
176 | * @param label label to display next to (right of) the radiobutton | |
177 | * @param selected if true, this will be the selected radiobutton | |
178 | * @return the new radio button | |
179 | */ | |
180 | public TRadioButton addRadioButton(final String label, | |
181 | final boolean selected) { | |
182 | ||
183 | TRadioButton button = addRadioButton(label); | |
184 | setSelected(button.id); | |
185 | return button; | |
186 | } | |
187 | ||
00d2622b KL |
188 | /** |
189 | * Convenience function to add a radio button to this group. | |
190 | * | |
191 | * @param label label to display next to (right of) the radiobutton | |
192 | * @return the new radio button | |
193 | */ | |
194 | public TRadioButton addRadioButton(final String label) { | |
b2efac6e KL |
195 | return new TRadioButton(this, 0, 0, label, 0); |
196 | } | |
197 | ||
198 | /** | |
199 | * Package private method for RadioButton to add itself to a RadioGroup | |
200 | * container. | |
201 | * | |
202 | * @param button the button to add | |
203 | */ | |
204 | void addRadioButton(final TRadioButton button) { | |
205 | super.setHeight(getChildren().size() + 2); | |
206 | button.setX(1); | |
207 | button.setY(getChildren().size()); | |
208 | button.id = getChildren().size(); | |
209 | String label = button.getMnemonic().getRawLabel(); | |
210 | ||
9f613a0c | 211 | if (StringUtils.width(label) + 4 > getWidth()) { |
d8dc8aea | 212 | super.setWidth(StringUtils.width(label) + 7); |
00d2622b | 213 | } |
00691e80 | 214 | |
8afe8fa7 KL |
215 | if (getParent().getLayoutManager() != null) { |
216 | getParent().getLayoutManager().resetSize(this); | |
217 | } | |
218 | ||
00691e80 KL |
219 | // Default to the first item on the list. |
220 | activate(getChildren().get(0)); | |
b2efac6e | 221 | } |
00691e80 | 222 | |
b2efac6e KL |
223 | /** |
224 | * Get the requires selection flag. | |
225 | * | |
226 | * @return true if this radiogroup requires that one of the buttons be | |
227 | * selected | |
228 | */ | |
229 | public boolean getRequiresSelection() { | |
230 | return requiresSelection; | |
231 | } | |
232 | ||
233 | /** | |
234 | * Set the requires selection flag. | |
235 | * | |
236 | * @param requiresSelection if true, then this radiogroup requires that | |
237 | * one of the buttons be selected | |
238 | */ | |
239 | public void setRequiresSelection(final boolean requiresSelection) { | |
240 | this.requiresSelection = requiresSelection; | |
241 | if (requiresSelection) { | |
04050859 | 242 | if ((getChildren().size() > 0) && (selectedButton == null)) { |
b2efac6e KL |
243 | setSelected(1); |
244 | } | |
245 | } | |
00d2622b KL |
246 | } |
247 | ||
248 | } |