View Javadoc

    1   /*
    2    * $Id: Radio.java 497654 2007-01-19 00:21:57Z rgielen $
    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  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
    28  import com.opensymphony.xwork2.util.ValueStack;
    29
    30  /***
    31   * <!-- START SNIPPET: javadoc -->
    32   * Render a radio button input field.</p>
    33   * <!-- END SNIPPET: javadoc -->
    34   *
    35   * <p/> <b>Examples</b>
    36   * <p/>
    37   * <!-- START SNIPPET: exdescription -->
    38   * In this example, a radio control is displayed with a list of genders. The gender list is built from attribute
    39   * id=genders. The framework calls getGenders() which will return a Map. For examples using listKey and listValue attributes,
    40   * see the section select tag. The default selected one will be determined (in this case) by the getMale() method
    41   * in the action class which should retun a value similar to the key of the getGenters() map if that particular
    42   * gender is to be selected.<p/>
    43   * <!-- END SNIPPET: exdescription -->
    44   * <pre>
    45   * <!-- START SNIPPET: example -->
    46   * &lt;s:action name="GenderMap" id="genders"/&gt;
    47   * &lt;s:radio label="Gender" name="male" list="#genders.genders"/&gt;
    48   * <!-- END SNIPPET: example -->
    49   * </pre>
    50   *
    51   */
    52  @StrutsTag(name="radio", tldTagClass="org.apache.struts2.views.jsp.ui.RadioTag", description="Renders a radio button input field")
    53  public class Radio extends ListUIBean {
    54      final public static String TEMPLATE = "radiomap";
    55
    56      public Radio(ValueStack stack, HttpServletRequest request, HttpServletResponse response) {
    57          super(stack, request, response);
    58      }
    59
    60      protected String getDefaultTemplate() {
    61          return TEMPLATE;
    62      }
    63  }