View Javadoc

1   /*
2    * $Id: Checkbox.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   * Renders an HTML input element of type checkbox, populated by the specified property from the ValueStack.
35   * <!-- END SNIPPET: javadoc -->
36   *
37   * <p/> <b>Examples</b>
38   *
39   * <pre>
40   * <!-- START SNIPPET: example -->
41   * JSP:
42   * &lt;s:checkbox label="checkbox test" name="checkboxField1" value="aBoolean" fieldValue="true"/&gt;
43   *
44   * Velocity:
45   * #tag( Checkbox "label=checkbox test" "name=checkboxField1" "value=aBoolean" )
46   *
47   * Resulting HTML (simple template, aBoolean == true):
48   * &lt;input type="checkbox" name="checkboxField1" value="true" checked="checked" /&gt;
49   *
50   * <!-- END SNIPPET: example -->
51   * </pre>
52   *
53   */
54  @StrutsTag(
55      name="checkbox",
56      tldTagClass="org.apache.struts2.views.jsp.ui.CheckboxTag",
57      description="Render a checkbox input field",
58      allowDynamicAttributes=true)
59  public class Checkbox extends UIBean {
60      final public static String TEMPLATE = "checkbox";
61  
62      protected String fieldValue;
63  
64      public Checkbox(ValueStack stack, HttpServletRequest request, HttpServletResponse response) {
65          super(stack, request, response);
66      }
67  
68      protected String getDefaultTemplate() {
69          return TEMPLATE;
70      }
71  
72      protected void evaluateExtraParams() {
73          if (fieldValue != null) {
74              addParameter("fieldValue", findString(fieldValue));
75          } else {
76              addParameter("fieldValue", "true");
77          }
78      }
79  
80      protected Class getValueClassType() {
81          return Boolean.class; // for checkboxes, everything needs to end up as a Boolean
82      }
83  
84      @StrutsTagAttribute(description="The actual HTML value attribute of the checkbox.", defaultValue="true")
85      public void setFieldValue(String fieldValue) {
86          this.fieldValue = fieldValue;
87      }
88  
89  }