com.jgeppert.struts2.jquery.components.CheckboxList Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of struts2-jquery-plugin Show documentation
There is a newer version: 5.0.3
Show newest version
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *  http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package com.jgeppert.struts2.jquery.components;

import java.util.Random;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.apache.struts2.views.annotations.StrutsTag;
import org.apache.struts2.views.annotations.StrutsTagAttribute;
import org.apache.struts2.views.annotations.StrutsTagSkipInheritance;

import com.opensymphony.xwork2.util.ValueStack;

/**
 * 
 * 
 * A tag that creates an Button Set from a Checkbox List.
 * 
 * 
 * 
 * Examples
 * 
 * 
 * 
 * 
 * Create a Buttonset from Checkbox List.
 * 
 * 
 *  * <div id="formResult" class="result ui-widget-content ui-corner-all">Submit form bellow.</div>
 *   
 *   <s:form id="form" action="echo" theme="xhtml">
 *         <sj:checkboxlist
 *             id="checkboxbuttonset"
 *                 tooltip="Choose your Friends"
 *                 label="Friends"
 *                 list="{'Patrick', 'Jason', 'Jay', 'Toby', 'Rene'}"
 *                 name="echo"/>
 *             <sj:submit 
 *               targets="formResult" 
 *               value="AJAX Submit" 
 *               indicator="indicator"
 *               button="true"
 *               />
 *   </s:form>
 *   <img id="indicator" src="images/indicator.gif" alt="Loading..." style="display:none"/>
 * 
 * 
 * 
 * 
 * @author Johannes Geppert
 * 
 */

@StrutsTag(name = "checkboxlist", tldTagClass = "com.jgeppert.struts2.jquery.views.jsp.ui.CheckboxListTag", description = "Render a Button Set from a given checkbox list", allowDynamicAttributes = true)
public class CheckboxList extends AbstractFormListElement {

  public static final String            TEMPLATE       = "checkboxlist";
  public static final String            TEMPLATE_CLOSE = "checkboxlist-close";
  public static final String            COMPONENT_NAME = CheckboxList.class.getName();
  final private static transient Random RANDOM         = new Random();
  public static final String            JQUERYACTION   = "buttonset";

  protected String                      buttonset;

  public CheckboxList(ValueStack stack, HttpServletRequest request, HttpServletResponse response) {
    super(stack, request, response);
  }

  public String getDefaultOpenTemplate()
  {
    return TEMPLATE;
  }

  protected String getDefaultTemplate()
  {
    return TEMPLATE_CLOSE;
  }

  public void evaluateExtraParams()
  {
    super.evaluateExtraParams();

    addParameter("jqueryaction", JQUERYACTION);

    if (buttonset != null) addParameter("buttonset", findValue(buttonset, Boolean.class));

    if ((this.id == null || this.id.length() == 0))
    {
      // resolves Math.abs(Integer.MIN_VALUE) issue reported by FindBugs
      // http://findbugs.sourceforge.net/bugDescriptions.html#RV_ABSOLUTE_VALUE_OF_RANDOM_INT
      int nextInt = RANDOM.nextInt();
      nextInt = nextInt == Integer.MIN_VALUE ? Integer.MAX_VALUE : Math.abs(nextInt);
      this.id = "checkbox_" + String.valueOf(nextInt);
      addParameter("id", this.id);
    }
  }

  @Override
  @StrutsTagSkipInheritance
  public void setTheme(String theme)
  {
    super.setTheme(theme);
  }

  @Override
  public String getTheme()
  {
    return "jquery";
  }

  @StrutsTagAttribute(description = "Disable or enable the jQuery UI buttonset feature.", defaultValue = "true", type = "Boolean")
  public void setButtonset(String buttonset)
  {
    this.buttonset = buttonset;
  }

}