View Javadoc

1   /*
2    * $Id: Radio.java 451544 2006-09-30 05:38:02Z mrdon $
3    *
4    * Copyright 2006 The Apache Software Foundation.
5    *
6    * Licensed under the Apache License, Version 2.0 (the "License");
7    * you may not use this file except in compliance with the License.
8    * You may obtain a copy of the License at
9    *
10   *      http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing, software
13   * distributed under the License is distributed on an "AS IS" BASIS,
14   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15   * See the License for the specific language governing permissions and
16   * limitations under the License.
17   */
18  package org.apache.struts2.components;
19  
20  import javax.servlet.http.HttpServletRequest;
21  import javax.servlet.http.HttpServletResponse;
22  
23  import com.opensymphony.xwork2.util.ValueStack;
24  
25  /***
26   * <!-- START SNIPPET: javadoc -->
27   * Render a radio button input field.</p>
28   * <!-- END SNIPPET: javadoc -->
29   *
30   * <p/> <b>Examples</b>
31   * <p/>
32   * <!-- START SNIPPET: exdescription -->
33   * In this example, a radio control is displayed with a list of genders. The gender list is built from attribute
34   * id=genders. The framework calls getGenders() which will return a Map. For examples using listKey and listValue attributes,
35   * see the section select tag. The default selected one will be determined (in this case) by the getMale() method 
36   * in the action class which should retun a value similar to the key of the getGenters() map if that particular 
37   * gender is to be selected.<p/>
38   * <!-- END SNIPPET: exdescription -->
39   * <pre>
40   * <!-- START SNIPPET: example -->
41   * &lt;s:action name="GenderMap" id="genders"/&gt;
42   * &lt;s:radio label="Gender" name="male" list="#genders.genders"/&gt;
43   * <!-- END SNIPPET: example -->
44   * </pre>
45   *
46   * @s.tag name="radio" tld-body-content="JSP" tld-tag-class="org.apache.struts2.views.jsp.ui.RadioTag"
47   * description="Renders a radio button input field"
48   */
49  public class Radio extends ListUIBean {
50      final public static String TEMPLATE = "radiomap";
51  
52      public Radio(ValueStack stack, HttpServletRequest request, HttpServletResponse response) {
53          super(stack, request, response);
54      }
55  
56      protected String getDefaultTemplate() {
57          return TEMPLATE;
58      }
59  }