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

Go to download
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.5
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 Spinner. BETA
 * 
 * 
 * 
 * Examples
 * 
 * 
 * 
 * 
 * A simple Spinner.
 * 
 * 
 *  * <sj:spinner name="spinner1" id="spinner1"/>
 * 
 * 
 * 
 * 
 * 
 * 
 * A Spinner max=50 and step=2.
 * 
 * 
 *  *     <sj:spinner
 *       name="spinner2"
 *       id="spinner2"
 *       min="5"
 *       max="50"
 *       step="2"
 *       value="25"/>
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * A Spinner with currency format and mouse wheel support.
 * 
 * 
 *  * <sj:spinner
 *       name="spinner3"
 *       id="spinner3"
 *       min="0.00"
 *       max="5.00"
 *       step="0.15"
 *       value="2.50"
 *       suffix="$"
 *       mouseWheel="true"/>
 *     <br/>
 * 
 * 
 * 
 * 
 * @author Johannes Geppert
 * 
 */
@StrutsTag(name = "spinner", tldTagClass = "com.jgeppert.struts2.jquery.views.jsp.ui.SpinnerTag", description = "Render a Spinner. BETA", allowDynamicAttributes = true)
public class Spinner extends Textfield {

  public static final String            JQUERYACTION   = "spinner";
  public static final String            TEMPLATE       = "spinner";
  public static final String            TEMPLATE_CLOSE = "spinner-close";
  final private static transient Random RANDOM         = new Random();

  protected String                      max;
  protected String                      min;
  protected String                      step;
  protected String                      prefix;
  protected String                      suffix;
  protected String                      showOn;
  protected String                      point;
  protected String                      mouseWheel;

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

  public String getDefaultOpenTemplate()
  {
    return TEMPLATE;
  }

  protected String getDefaultTemplate()
  {
    return TEMPLATE_CLOSE;
  }

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

    addParameter("jqueryaction", JQUERYACTION);

    if (max != null) addParameter("max", findValue(max, Number.class));
    if (min != null) addParameter("min", findValue(min, Number.class));
    if (step != null) addParameter("step", findValue(step, Number.class));
    if (prefix != null) addParameter("prefix", findString(prefix));
    if (suffix != null) addParameter("suffix", findString(suffix));
    if (showOn != null) addParameter("showOn", findString(showOn));
    if (point != null) addParameter("point", findString(point));
    if (mouseWheel != null) addParameter("mouseWheel", findValue(mouseWheel, 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 = "spinner_" + 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 = "maximum value allowed", type = "Number")
  public void setMax(String max)
  {
    this.max = max;
  }

  @StrutsTagAttribute(description = "minimum value allowed", type = "Number")
  public void setMin(String min)
  {
    this.min = min;
  }

  @StrutsTagAttribute(description = "size of step to take when spinning", type = "Number", defaultValue = "1")
  public void setStep(String step)
  {
    this.step = step;
  }

  @StrutsTagAttribute(description = "Character prefix before the number.")
  public void setPrefix(String prefix)
  {
    this.prefix = prefix;
  }

  @StrutsTagAttribute(description = "Character suffix after the number.")
  public void setSuffix(String suffix)
  {
    this.suffix = suffix;
  }

  @StrutsTagAttribute(description = "Defines when the spin buttons are visible. always, focus, hover, both", defaultValue = "always")
  public void setShowOn(String showOn)
  {
    this.showOn = showOn;
  }

  @StrutsTagAttribute(description = "Decimal point character.", defaultValue = ".")
  public void setPoint(String point)
  {
    this.point = point;
  }

  @StrutsTagAttribute(description = "If true then mouse wheel events will be attached.", type = "Boolean")
  public void setMouseWheel(String mouseWheel)
  {
    this.mouseWheel = mouseWheel;
  }
}