KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > myfaces > wap > def > SelectOne


1 /*
2  * Copyright 2004 The Apache Software Foundation.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package org.apache.myfaces.wap.def;
17
18 /**
19  * Renders a option list.
20  *
21  * Renders select tag with one option element.
22  * Render the clientId of the component as the value of the "name" attribute. Render "false" as the value of the "multiple" attribute.
23  *
24  * @wapfaces.tag
25  * componentFamily="UISelectOne"
26  * rendererType="SelectOneRenderer"
27  * tagName="selectOne"
28  * tagBaseClass="org.apache.myfaces.wap.base.EditableValueHolderTagBase"
29  * bodyContent="JSP"
30  *
31  * @author <a HREF="mailto:Jiri.Zaloudek@ivancice.cz">Jiri Zaloudek</a> (latest modification by $Author: matzew $)
32  * @version $Revision: 1.1 $ $Date: 2004/12/30 09:37:25 $
33  * $Log: SelectOne.java,v $
34  * Revision 1.1 2004/12/30 09:37:25 matzew
35  * added a new RenderKit for WML. Thanks to Jirí Žaloudek
36  *
37  */
38
39
40 public class SelectOne extends javax.faces.component.UISelectOne {
41
42     /**
43      * The name of the variable that is set with the result of the selection. May also by use to set default value(if any option value matches the value of this variable). If is any option select, don't enforce attribute value to set default value.
44      *
45      * @wapfaces.attribute
46      * valueBinding="true"
47      */
48     java.lang.String JavaDoc name;
49         
50     /**
51      * Sets the tabbing position for the select element.
52      *
53      * @wapfaces.attribute
54      * valueBinding="true"
55      */
56     java.lang.String JavaDoc tabindex;
57     
58     /**
59      * Sets a title for the select element. Some browsers can ignore it.
60      *
61      * @wapfaces.attribute
62      * valueBinding="true"
63      */
64     java.lang.String JavaDoc title;
65     
66     /**
67      * The xml:lang attribute specifies the natural or formal language of an element or its attributes.
68      *
69      * @wapfaces.attribute
70      * valueBinding="true"
71      */
72     java.lang.String JavaDoc xmllang;
73     
74     /**
75      * Space-separated list of style class(es) to be applied when this element is rendered. This value must be passed through as the "class" attribute on generated markup.
76      *
77      * @wapfaces.attribute
78      * valueBinding="true"
79      */
80     java.lang.String JavaDoc styleClass;
81     
82     
83     // ============= ABSTARACT ATTRIBUTES ======================================
84 /**
85      * The component identifier for the associated component.
86      *
87      * @wapfaces.attribute
88      * abstract="true"
89      * inherit="true"
90      */
91     java.lang.String JavaDoc id;
92     
93     /**
94      * Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.
95      *
96      * @wapfaces.attribute
97      * abstract="true"
98      * inherit="true"
99      */
100     boolean rendered;
101         
102     /**
103      * The value binding expression linking this component to a property in a backing bean.
104      *
105      * @wapfaces.attribute
106      * abstract="true"
107      * inherit="true"
108      */
109     java.lang.String JavaDoc binding;
110
111     /**
112      * Converter instance registered with this component.
113      *
114      * @wapfaces.attribute
115      * abstract="true"
116      * inherit="true"
117      */
118     java.lang.String JavaDoc converter;
119
120     /**
121      * Flag indicating that this component's value must be converted and validated immediately (that is, during Apply Request Values phase), rather than waiting until Process Validations phase.
122      *
123      * @wapfaces.attribute
124      * inherit="true"
125      * abstract="true"
126      */
127     boolean immediate;
128     
129     /**
130      * The current value of this component. Is rendered as attribute "value" in the select element. First option item with matching value is selected.
131      *
132      * @wapfaces.attribute
133      * inherit="true"
134      * abstract="true"
135      */
136     java.lang.Object JavaDoc value;
137     
138     /**
139      * Flag indicating that the user is required to provide a submitted value for this input component.
140      *
141      * @wapfaces.attribute
142      * abstract="true"
143      * inherit="true"
144      */
145     boolean required;
146     
147     /**
148      * MethodBinding representing a validator method that will be called during Process Validations to perform correctness checks on the value of this component. The expression must evaluate to a public method that takes FacesContext, UIComponent, and Object parameters, with a return type of void.
149      *
150      * @wapfaces.attribute
151      * abstract="true"
152      * inherit="true"
153      */
154     java.lang.String JavaDoc validator;
155     
156     /**
157      * MethodBinding representing a value change listener method that will be notified when a new value has been set for this input component. The expression must evaluate to a public method that takes a ValueChangeEvent parameter, with a return type of void.
158      *
159      * @wapfaces.attribute
160      * abstract="true"
161      * inherit="true"
162      */
163     java.lang.String JavaDoc valueChangeListener;
164 }
165
Popular Tags