Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||||||
RadioGroup |
|
| 2.076923076923077;2.077 |
1 | // Copyright 2004, 2005 The Apache Software Foundation |
|
2 | // |
|
3 | // Licensed under the Apache License, Version 2.0 (the "License"); |
|
4 | // you may not use this file except in compliance with the License. |
|
5 | // You may obtain a copy of the License at |
|
6 | // |
|
7 | // http://www.apache.org/licenses/LICENSE-2.0 |
|
8 | // |
|
9 | // Unless required by applicable law or agreed to in writing, software |
|
10 | // distributed under the License is distributed on an "AS IS" BASIS, |
|
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
|
12 | // See the License for the specific language governing permissions and |
|
13 | // limitations under the License. |
|
14 | ||
15 | package org.apache.tapestry.form; |
|
16 | ||
17 | import org.apache.hivemind.ApplicationRuntimeException; |
|
18 | import org.apache.tapestry.IMarkupWriter; |
|
19 | import org.apache.tapestry.IRequestCycle; |
|
20 | import org.apache.tapestry.Tapestry; |
|
21 | import org.apache.tapestry.valid.ValidatorException; |
|
22 | ||
23 | /** |
|
24 | * A special type of form component that is used to contain {@link Radio}components. The Radio and |
|
25 | * {@link Radio}group components work together to update a property of some other object, much like |
|
26 | * a more flexible version of a {@link PropertySelection}. [ <a |
|
27 | * href="../../../../../ComponentReference/RadioGroup.html">Component Reference </a>] |
|
28 | * <p> |
|
29 | * As of 4.0, this component can be validated. |
|
30 | * |
|
31 | * @author Howard Lewis Ship |
|
32 | * @author Paul Ferraro |
|
33 | */ |
|
34 | 0 | public abstract class RadioGroup extends AbstractFormComponent implements ValidatableField |
35 | { |
|
36 | /** |
|
37 | * A <code>RadioGroup</code> places itself into the {@link IRequestCycle}as an attribute, so |
|
38 | * that its wrapped {@link Radio}components can identify thier state. |
|
39 | */ |
|
40 | ||
41 | private static final String ATTRIBUTE_NAME = "org.apache.tapestry.active.RadioGroup"; |
|
42 | ||
43 | // Cached copy of the value from the selectedBinding |
|
44 | private Object _selection; |
|
45 | ||
46 | // The value from the HTTP request indicating which |
|
47 | // Radio was selected by the user. |
|
48 | private int _selectedOption; |
|
49 | ||
50 | private boolean _rewinding; |
|
51 | ||
52 | private boolean _rendering; |
|
53 | ||
54 | private int _nextOptionId; |
|
55 | ||
56 | public static RadioGroup get(IRequestCycle cycle) |
|
57 | { |
|
58 | 0 | return (RadioGroup) cycle.getAttribute(ATTRIBUTE_NAME); |
59 | } |
|
60 | ||
61 | public int getNextOptionId() |
|
62 | { |
|
63 | 0 | if (!_rendering) |
64 | 0 | throw Tapestry.createRenderOnlyPropertyException(this, "nextOptionId"); |
65 | ||
66 | 0 | return _nextOptionId++; |
67 | } |
|
68 | ||
69 | public boolean isRewinding() |
|
70 | { |
|
71 | 0 | if (!_rendering) |
72 | 0 | throw Tapestry.createRenderOnlyPropertyException(this, "rewinding"); |
73 | ||
74 | 0 | return _rewinding; |
75 | } |
|
76 | ||
77 | /** |
|
78 | * Returns true if the value is equal to the current selection for the group. This is invoked by |
|
79 | * a {@link Radio}during rendering to determine if it should be marked 'checked'. |
|
80 | */ |
|
81 | ||
82 | public boolean isSelection(Object value) |
|
83 | { |
|
84 | 0 | if (!_rendering) |
85 | 0 | throw Tapestry.createRenderOnlyPropertyException(this, "selection"); |
86 | ||
87 | 0 | if (_selection == value) |
88 | 0 | return true; |
89 | ||
90 | 0 | if (_selection == null || value == null) |
91 | 0 | return false; |
92 | ||
93 | 0 | return _selection.equals(value); |
94 | } |
|
95 | ||
96 | /** |
|
97 | * Invoked by the {@link Radio}which is selected to update the property bound to the selected |
|
98 | * parameter. |
|
99 | */ |
|
100 | ||
101 | public void updateSelection(Object value) |
|
102 | { |
|
103 | 0 | getBinding("selected").setObject(value); |
104 | ||
105 | 0 | _selection = value; |
106 | 0 | } |
107 | ||
108 | /** |
|
109 | * Used by {@link Radio}components when rewinding to see if their value was submitted. |
|
110 | */ |
|
111 | ||
112 | public boolean isSelected(int option) |
|
113 | { |
|
114 | 0 | return _selectedOption == option; |
115 | } |
|
116 | ||
117 | /** |
|
118 | * @see org.apache.tapestry.AbstractComponent#prepareForRender(org.apache.tapestry.IRequestCycle) |
|
119 | */ |
|
120 | protected void prepareForRender(IRequestCycle cycle) |
|
121 | { |
|
122 | 0 | if (cycle.getAttribute(ATTRIBUTE_NAME) != null) |
123 | 0 | throw new ApplicationRuntimeException(Tapestry.getMessage("RadioGroup.may-not-nest"), |
124 | this, null, null); |
|
125 | ||
126 | 0 | cycle.setAttribute(ATTRIBUTE_NAME, this); |
127 | ||
128 | 0 | _rendering = true; |
129 | 0 | _nextOptionId = 0; |
130 | 0 | } |
131 | ||
132 | /** |
|
133 | * @see org.apache.tapestry.AbstractComponent#cleanupAfterRender(org.apache.tapestry.IRequestCycle) |
|
134 | */ |
|
135 | protected void cleanupAfterRender(IRequestCycle cycle) |
|
136 | { |
|
137 | 0 | _rendering = false; |
138 | 0 | _selection = null; |
139 | ||
140 | 0 | cycle.removeAttribute(ATTRIBUTE_NAME); |
141 | 0 | } |
142 | ||
143 | /** |
|
144 | * @see org.apache.tapestry.form.AbstractRequirableField#renderFormComponent(org.apache.tapestry.IMarkupWriter, |
|
145 | * org.apache.tapestry.IRequestCycle) |
|
146 | */ |
|
147 | protected void renderFormComponent(IMarkupWriter writer, IRequestCycle cycle) |
|
148 | { |
|
149 | 0 | _rewinding = false; |
150 | ||
151 | // For rendering, the Radio components need to know what the current |
|
152 | // selection is, so that the correct one can mark itself 'checked'. |
|
153 | 0 | _selection = getBinding("selected").getObject(); |
154 | ||
155 | 0 | renderDelegatePrefix(writer, cycle); |
156 | ||
157 | 0 | writer.begin(getTemplateTagName()); |
158 | ||
159 | 0 | renderInformalParameters(writer, cycle); |
160 | ||
161 | 0 | renderDelegateAttributes(writer, cycle); |
162 | ||
163 | 0 | renderBody(writer, cycle); |
164 | ||
165 | 0 | writer.end(); |
166 | ||
167 | 0 | renderDelegateSuffix(writer, cycle); |
168 | ||
169 | 0 | getValidatableFieldSupport().renderContributions(this, writer, cycle); |
170 | 0 | } |
171 | ||
172 | /** |
|
173 | * @see org.apache.tapestry.form.AbstractFormComponent#rewindFormComponent(org.apache.tapestry.IMarkupWriter, |
|
174 | * org.apache.tapestry.IRequestCycle) |
|
175 | */ |
|
176 | protected void rewindFormComponent(IMarkupWriter writer, IRequestCycle cycle) |
|
177 | { |
|
178 | 0 | String value = cycle.getParameter(getName()); |
179 | ||
180 | 0 | if (value == null) |
181 | 0 | _selectedOption = -1; |
182 | else |
|
183 | 0 | _selectedOption = Integer.parseInt(value); |
184 | ||
185 | 0 | _rewinding = true; |
186 | ||
187 | 0 | renderBody(writer, cycle); |
188 | ||
189 | try |
|
190 | { |
|
191 | 0 | getValidatableFieldSupport().validate(this, writer, cycle, _selection); |
192 | } |
|
193 | 0 | catch (ValidatorException e) |
194 | { |
|
195 | 0 | getForm().getDelegate().record(e); |
196 | 0 | } |
197 | 0 | } |
198 | ||
199 | /** |
|
200 | * Injected. |
|
201 | */ |
|
202 | public abstract ValidatableFieldSupport getValidatableFieldSupport(); |
|
203 | ||
204 | /** |
|
205 | * @see org.apache.tapestry.form.AbstractFormComponent#isRequired() |
|
206 | */ |
|
207 | public boolean isRequired() |
|
208 | { |
|
209 | 0 | return getValidatableFieldSupport().isRequired(this); |
210 | } |
|
211 | ||
212 | /** |
|
213 | * This component can not take focus. |
|
214 | */ |
|
215 | protected boolean getCanTakeFocus() |
|
216 | { |
|
217 | 0 | return false; |
218 | } |
|
219 | } |