KickJava   Java API By Example, From Geeks To Geeks.

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


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  * The inputSecret tag represents an security input field (a text field where the user can enter some text). Default value sets the attribute "value".
20  * If the "styleClass" attribute is present, render its value as the value of the "class" attribute.
21  *
22  * @wapfaces.tag
23  * componentFamily="UIInput"
24  * rendererType="InputSecretRenderer"
25  * tagName="inputSecret"
26  * tagBaseClass="org.apache.myfaces.wap.base.EditableValueHolderTagBase"
27  * bodyContent="JSP"
28  *
29  * @author <a HREF="mailto:Jiri.Zaloudek@ivancice.cz">Jiri Zaloudek</a> (latest modification by $Author: matzew $)
30  * @version $Revision: 1.1 $ $Date: 2004/12/30 09:37:25 $
31  * $Log: InputSecret.java,v $
32  * Revision 1.1 2004/12/30 09:37:25 matzew
33  * added a new RenderKit for WML. Thanks to Jirí Žaloudek
34  *
35  */
36
37
38 public class InputSecret extends javax.faces.component.UIInput {
39         
40     /**
41      * The name of the variable that is set with the result of the user's input.
42      *
43      * @wapfaces.attribute
44      * valueBinding="true"
45      */
46     java.lang.String JavaDoc name;
47     
48     /**
49      * Sets whether the user can leave the input field blank or not. Default is "false"
50      *
51      * @wapfaces.attribute
52      * valueBinding="true"
53      */
54     boolean emptyok;
55     
56     /**
57      * Sets the data format for the input field. Default is "*M".
58      * A = uppercase alphabetic or punctuation characters
59      * a = lowercase alphabetic or punctuation characters
60      * N = numeric characters
61      * X = uppercase characters
62      * x = lowercase characters
63      * M = all characters
64      * m = all characters
65      * f = Any number of characters. Replace the f with one of the letters above to specify what characters the user can enter
66      * nf = Replace the n with a number from 1 to 9 to specify the number of characters the user can enter. Replace the f with one of the letters above to specify what characters the user can enter
67      *
68      * @wapfaces.attribute
69      * valueBinding="true"
70      */
71     java.lang.String JavaDoc format;
72     
73     /**
74      * Sets the maximum number of characters the user can enter in the field
75      *
76      * @wapfaces.attribute
77      * valueBinding="true"
78      */
79     java.lang.String JavaDoc maxlength;
80     
81     /**
82      * Sets the width of the input field
83      *
84      * @wapfaces.attribute
85      * valueBinding="true"
86      */
87     java.lang.String JavaDoc size;
88     
89     /**
90      * Sets the tabbing position for the input field
91      *
92      * @wapfaces.attribute
93      * valueBinding="true"
94      */
95     java.lang.String JavaDoc tabindex;
96     
97     /**
98      * Sets a title for the input field
99      *
100      * @wapfaces.attribute
101      * valueBinding="true"
102      */
103     java.lang.String JavaDoc title;
104     
105     /**
106      * The xml:lang attribute specifies the natural or formal language of an element or its attributes.
107      *
108      * @wapfaces.attribute
109      * valueBinding="true"
110      */
111     java.lang.String JavaDoc xmllang;
112     
113     /**
114      * 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.
115      *
116      * @wapfaces.attribute
117      * valueBinding="true"
118      */
119     java.lang.String JavaDoc styleClass;
120     
121     
122     // ============= ABSTARACT ATTRIBUTES ======================================
123 /**
124      * The component identifier for the associated component.
125      *
126      * @wapfaces.attribute
127      * abstract="true"
128      * inherit="true"
129      */
130     java.lang.String JavaDoc id;
131     
132     /**
133      * Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.
134      *
135      * @wapfaces.attribute
136      * abstract="true"
137      * inherit="true"
138      */
139     boolean rendered;
140         
141     /**
142      * The value binding expression linking this component to a property in a backing bean.
143      *
144      * @wapfaces.attribute
145      * abstract="true"
146      * inherit="true"
147      */
148     java.lang.String JavaDoc binding;
149
150     /**
151      * Converter instance registered with this component.
152      *
153      * @wapfaces.attribute
154      * abstract="true"
155      * inherit="true"
156      */
157     java.lang.String JavaDoc converter;
158
159     /**
160      * 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.
161      *
162      * @wapfaces.attribute
163      * inherit="true"
164      * abstract="true"
165      */
166     java.lang.Object JavaDoc immediate;
167     
168     /**
169      * The current value of this component.
170      *
171      * @wapfaces.attribute
172      * inherit="true"
173      * abstract="true"
174      */
175     java.lang.Object JavaDoc value;
176     
177     /**
178      * Flag indicating that the user is required to provide a submitted value for this input component.
179      *
180      * @wapfaces.attribute
181      * abstract="true"
182      * inherit="true"
183      */
184     java.lang.String JavaDoc required;
185     
186     /**
187      * 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.
188      *
189      * @wapfaces.attribute
190      * abstract="true"
191      * inherit="true"
192      */
193     java.lang.String JavaDoc validator;
194     
195     /**
196      * 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.
197      *
198      * @wapfaces.attribute
199      * abstract="true"
200      * inherit="true"
201      */
202     java.lang.String JavaDoc valueChangeListener;
203        
204 }
205
Popular Tags