View Javadoc

1   /*
2    * $Id: Password.java 651946 2008-04-27 13:41:38Z apetrelli $
3    *
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *  http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  package org.apache.struts2.components;
23  
24  import javax.servlet.http.HttpServletRequest;
25  import javax.servlet.http.HttpServletResponse;
26  
27  import org.apache.struts2.views.annotations.StrutsTag;
28  import org.apache.struts2.views.annotations.StrutsTagAttribute;
29  
30  import com.opensymphony.xwork2.util.ValueStack;
31  
32  /***
33   * <!-- START SNIPPET: javadoc -->
34   * Render an HTML input tag of type password.</p>
35   * <!-- END SNIPPET: javadoc -->
36   *
37   * <p/> <b>Examples</b>
38   * <p/>
39   * <!-- START SNIPPET: exdescription -->
40   * In this example, a password control is displayed. For the label, we are calling ActionSupport's getText() to
41   * retrieve password label from a resource bundle.<p/>
42   * <!-- END SNIPPET: exdescription -->
43   * <pre>
44   * <!-- START SNIPPET: example -->
45   * &lt;s:password label="%{text('password')}" name="password" size="10" maxlength="15" /&gt;
46   * <!-- END SNIPPET: example -->
47   * </pre>
48   *
49   */
50  @StrutsTag(
51      name="password",
52      tldTagClass="org.apache.struts2.views.jsp.ui.PasswordTag",
53      description="Render an HTML input tag of type password",
54      allowDynamicAttributes=true)
55  public class Password extends TextField {
56      final public static String TEMPLATE = "password";
57  
58      protected String showPassword;
59  
60      public Password(ValueStack stack, HttpServletRequest request, HttpServletResponse response) {
61          super(stack, request, response);
62      }
63  
64      protected String getDefaultTemplate() {
65          return TEMPLATE;
66      }
67  
68      public void evaluateExtraParams() {
69          super.evaluateExtraParams();
70  
71          if (showPassword != null) {
72              addParameter("showPassword", findValue(showPassword, Boolean.class));
73          }
74      }
75  
76      @StrutsTagAttribute(description="Whether to show input", type="Boolean", defaultValue="false")
77      public void setShowPassword(String showPassword) {
78          this.showPassword = showPassword;
79      }
80  
81  }