01: /*
02: * $Id: Checkbox.java 497654 2007-01-19 00:21:57Z rgielen $
03: *
04: * Licensed to the Apache Software Foundation (ASF) under one
05: * or more contributor license agreements. See the NOTICE file
06: * distributed with this work for additional information
07: * regarding copyright ownership. The ASF licenses this file
08: * to you under the Apache License, Version 2.0 (the
09: * "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: package org.apache.struts2.components;
22:
23: import javax.servlet.http.HttpServletRequest;
24: import javax.servlet.http.HttpServletResponse;
25:
26: import org.apache.struts2.views.annotations.StrutsTag;
27: import org.apache.struts2.views.annotations.StrutsTagAttribute;
28:
29: import com.opensymphony.xwork2.util.ValueStack;
30:
31: /**
32: * <!-- START SNIPPET: javadoc -->
33: * Renders an HTML input element of type checkbox, populated by the specified property from the ValueStack.
34: * <!-- END SNIPPET: javadoc -->
35: *
36: * <p/> <b>Examples</b>
37: *
38: * <pre>
39: * <!-- START SNIPPET: example -->
40: * JSP:
41: * <s:checkbox label="checkbox test" name="checkboxField1" value="aBoolean" fieldValue="true"/>
42: *
43: * Velocity:
44: * #tag( Checkbox "label=checkbox test" "name=checkboxField1" "value=aBoolean" )
45: *
46: * Resulting HTML (simple template, aBoolean == true):
47: * <input type="checkbox" name="checkboxField1" value="true" checked="checked" />
48: *
49: * <!-- END SNIPPET: example -->
50: * </pre>
51: *
52: */
53: @StrutsTag(name="checkbox",tldTagClass="org.apache.struts2.views.jsp.ui.CheckboxTag",description="Render a checkbox input field")
54: public class Checkbox extends UIBean {
55: final public static String TEMPLATE = "checkbox";
56:
57: protected String fieldValue;
58:
59: public Checkbox(ValueStack stack, HttpServletRequest request,
60: HttpServletResponse response) {
61: super (stack, request, response);
62: }
63:
64: protected String getDefaultTemplate() {
65: return TEMPLATE;
66: }
67:
68: protected void evaluateExtraParams() {
69: if (fieldValue != null) {
70: addParameter("fieldValue", findString(fieldValue));
71: } else {
72: addParameter("fieldValue", "true");
73: }
74: }
75:
76: protected Class getValueClassType() {
77: return Boolean.class; // for checkboxes, everything needs to end up as a Boolean
78: }
79:
80: @StrutsTagAttribute(description="The actual HTML value attribute of the checkbox.",defaultValue="true")
81: public void setFieldValue(String fieldValue) {
82: this.fieldValue = fieldValue;
83: }
84:
85: }
|