1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
|
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2010 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package javax.faces.component;
import javax.faces.model.SelectItem;
/**
* <p><strong class="changed_modified_2_0
* changed_modified_2_0_rev_a">UISelectItem</strong> is a component that
* may be nested inside a {@link UISelectMany} or {@link UISelectOne}
* component, and causes the addition of a {@link SelectItem} instance
* to the list of available options for the parent component. The
* contents of the {@link SelectItem} can be specified in one of the
* following ways:</p> <ul> <li>The <code>value</code> attribute's value
* is an instance of {@link SelectItem}.</li> <li>The associated {@link
* javax.el.ValueExpression} points at a model data item of type {@link
* SelectItem}.</li> <li>A new {@link SelectItem} instance is
* synthesized from the values of the <code>itemDescription</code>,
* <code>itemDisabled</code>, <code>itemLabel</code>, <code
* class="changed_modified_2_0_rev_a">itemEscaped</code>, and
* <code>itemValue</code> attributes.</li> </ul>
*/
public class UISelectItem extends UIComponentBase {
// ------------------------------------------------------ Manifest Constants
/**
* <p>The standard component type for this component.</p>
*/
public static final String COMPONENT_TYPE = "javax.faces.SelectItem";
/**
* <p>The standard component family for this component.</p>
*/
public static final String COMPONENT_FAMILY = "javax.faces.SelectItem";
enum PropertyKeys {
itemDescription,
itemDisabled,
itemEscaped,
itemLabel,
itemValue,
value,
noSelectionOption
}
// ------------------------------------------------------------ Constructors
/**
* <p>Create a new {@link UISelectItem} instance with default property
* values.</p>
*/
public UISelectItem() {
super();
setRendererType(null);
}
// -------------------------------------------------------------- Properties
public String getFamily() {
return (COMPONENT_FAMILY);
}
/**
* <p>Return the description for this selection item.</p>
*/
public String getItemDescription() {
return (String) getStateHelper().eval(PropertyKeys.itemDescription);
}
/**
* <p>Set the description for this selection item.</p>
*
* @param itemDescription The new description
*/
public void setItemDescription(String itemDescription) {
getStateHelper().put(PropertyKeys.itemDescription, itemDescription);
}
/**
* <p>Return the disabled setting for this selection item.</p>
*/
public boolean isItemDisabled() {
return (Boolean) getStateHelper().eval(PropertyKeys.itemDisabled, false);
}
/**
* <p>Set the disabled value for this selection item.</p>
*
* @param itemDisabled The new disabled flag
*/
public void setItemDisabled(boolean itemDisabled) {
getStateHelper().put(PropertyKeys.itemDisabled, itemDisabled);
}
/**
* <p>Return the escape setting for the label of this selection item.</p>
*/
public boolean isItemEscaped() {
return (Boolean) getStateHelper().eval(PropertyKeys.itemEscaped, true);
}
/**
* <p>Set the escape value for the label of this selection item.</p>
*
* @param itemEscaped The new disabled flag
*/
public void setItemEscaped(boolean itemEscaped) {
getStateHelper().put(PropertyKeys.itemEscaped, itemEscaped);
}
/**
* <p>Return the localized label for this selection item.</p>
*/
public String getItemLabel() {
return (String) getStateHelper().eval(PropertyKeys.itemLabel);
}
/**
* <p>Set the localized label for this selection item.</p>
*
* @param itemLabel The new localized label
*/
public void setItemLabel(String itemLabel) {
getStateHelper().put(PropertyKeys.itemLabel, itemLabel);
}
/**
* <p>Return the server value for this selection item.</p>
*/
public Object getItemValue() {
return getStateHelper().eval(PropertyKeys.itemValue);
}
/**
* <p>Set the server value for this selection item.</p>
*
* @param itemValue The new server value
*/
public void setItemValue(Object itemValue) {
getStateHelper().put(PropertyKeys.itemValue, itemValue);
}
/**
* <p>Returns the <code>value</code> property of the
* <code>UISelectItem</code>.</p>
*/
public Object getValue() {
return getStateHelper().eval(PropertyKeys.value);
}
/**
* <p>Sets the <code>value</code> property of the
* <code>UISelectItem</code>.</p>
*
* @param value the new value
*/
public void setValue(Object value) {
getStateHelper().put(PropertyKeys.value, value);
}
/** <p class="changed_added_2_0">Return the value of the
* <code>noSelectionOption</code> property. If the value of this
* property is <code>true</code>, the system interprets the option
* represented by this <code>UISelectItem</code> instance as
* representing a "no selection" option. See {@link
* UISelectOne#validateValue} and {@link UISelectMany#validateValue}
* for usage.</p>
*
* @since 2.0
*/
public boolean isNoSelectionOption() {
return (Boolean) getStateHelper().eval(PropertyKeys.noSelectionOption, false);
}
/**
* <p class="changed_added_2_0">Set the value of the
* <code>noSelectionOption</code> property.</p>
*
* @since 2.0
*/
public void setNoSelectionOption(boolean noSelectionOption) {
getStateHelper().put(PropertyKeys.noSelectionOption, noSelectionOption);
}
}
|
