All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • com.jgeppert.struts2.jquery.components.Slider Maven / Gradle / Ivy

    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 com.opensymphony.xwork2.util.ValueStack;
import org.apache.struts2.views.annotations.StrutsTag;
import org.apache.struts2.views.annotations.StrutsTagAttribute;
import org.apache.struts2.views.annotations.StrutsTagSkipInheritance;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.Arrays;
import java.util.Collection;

/**
 * 
 * 
    
 * A tag that creates an Slider.
 * 
    
 * 
 * 
    
 * Examples
 * 
    
 * 
 * 
     * <sj:slider id="myslider" name="myslider"/>
 * 
    
 * 
 * 
 * 
     * <sj:slider id="myslider2" name="myslider2" value="40" displayValueElement="displayvaluespan" min="20" max="200" animate="true" step="5" cssStyle="margin: 10px;"/>
 * 
    
 * 
 *
 * @author Johannes Geppert
 */
@StrutsTag(name = "slider", tldTagClass = "com.jgeppert.struts2.jquery.views.jsp.ui.SliderTag", description = "Render a Slider", allowDynamicAttributes = true)
public class Slider extends AbstractTopicsBean {

    public static final String JQUERYACTION = "slider";
    public static final String TEMPLATE = "slider";
    public static final String TEMPLATE_CLOSE = "slider-close";

    private static final String PARAM_ANIMATE = "animate";
    private static final String PARAM_MAX = "max";
    private static final String PARAM_MIN = "min";
    private static final String PARAM_ORIENTATION = "orientation";
    private static final String PARAM_STEP = "step";
    private static final String PARAM_DISPLAY_VALUE_ELEMENT = "displayValueElement";
    private static final String PARAM_ON_SLIDE_TOPICS = "onSlideTopics";
    private static final String PARAM_ARRAY_VALUE = "arrayValue";
    private static final String PARAM_RANGE = "range";
    private static final String PARAM_VALUE = "value";
    private static final String PARAM_WIDGETID = "widgetid";

    private static final String ID_PREFIX_SLIDER = "slider_";

    protected String animate;
    protected String max;
    protected String min;
    protected String orientation;
    protected String range;
    protected String step;
    protected String displayValueElement;
    protected String onSlideTopics;

    public Slider(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(PARAM_JQUERY_ACTION, JQUERYACTION);

        addParameterIfPresent(PARAM_ANIMATE, this.animate, Boolean.class);
        addParameterIfPresent(PARAM_MAX, this.max, Integer.class);
        addParameterIfPresent(PARAM_MIN, this.min, Integer.class);
        addParameterIfPresent(PARAM_ORIENTATION, this.orientation);
        addParameterIfPresent(PARAM_RANGE, this.range);
        addParameterIfPresent(PARAM_STEP, this.step, Integer.class);
        addParameterIfPresent(PARAM_DISPLAY_VALUE_ELEMENT, this.displayValueElement);
        addParameterIfPresent(PARAM_ON_SLIDE_TOPICS, this.onSlideTopics);

        Object valueObject = null;
        String strValue = null;

        if (value != null) {
            strValue = value;
        } else {
            if (name != null) {
                strValue = name;
            }
        }
        if (strValue != null) {
            valueObject = findValue(strValue);
        }

        if (valueObject == null && strValue != null) {
            valueObject = strValue;
        }

        if (valueObject != null) {
            if (valueObject instanceof String && ((String) valueObject).startsWith("[")) {
                addParameter(PARAM_ARRAY_VALUE, findString(strValue));
                addParameter(PARAM_RANGE, Boolean.TRUE.toString());
            } else if (valueObject instanceof Collection) {
                @SuppressWarnings("unchecked")
                Collection col = (Collection) valueObject;
                if (col.size() >= 2) {
                    addParameter(PARAM_ARRAY_VALUE, Arrays.toString(col.toArray()));
                    addParameter(PARAM_RANGE, Boolean.TRUE.toString());
                }
            } else if (valueObject instanceof Object[]) {
                Object[] ary = (Object[]) valueObject;
                if (ary.length >= 2) {
                    addParameter(PARAM_ARRAY_VALUE, Arrays.toString(ary));
                    addParameter(PARAM_RANGE, Boolean.TRUE.toString());
                }
            } else {
                addParameter(PARAM_VALUE, findString(strValue));
            }
        }
        addGeneratedIdParam(ID_PREFIX_SLIDER);
        addParameter(PARAM_ID, this.id + "_widget");
        addParameter(PARAM_WIDGETID, this.id);
    }

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

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

    @StrutsTagAttribute(description = "Whether to slide handle smoothly when user click outside handle on the bar. Default: false", defaultValue = "false", type = "Boolean")
    public void setAnimate(String animate) {
        this.animate = animate;
    }

    @StrutsTagAttribute(description = "Initialize a slider with the max option specified. Default: 100", type = "Integer")
    public void setMax(String max) {
        this.max = max;
    }

    @StrutsTagAttribute(description = "The minimum value of the slider. Default: 0", type = "Integer")
    public void setMin(String min) {
        this.min = min;
    }

    @StrutsTagAttribute(description = "Normally you don't need to set this option because the plugin detects the slider orientation automatically. If the orientation is not correctly detected you can set this option to 'horizontal' or 'vertical'. Default: 'auto'")
    public void setOrientation(String orientation) {
        this.orientation = orientation;
    }

    @StrutsTagAttribute(description = "If set to true, the slider will detect if you have two handles and create a stylable range element between these two. Two other possible values are 'min' and 'max'. A min range goes from the slider min to one handle. A max range goes from one handle to the slider max.")
    public void setRange(String range) {
        this.range = range;
    }

    @StrutsTagAttribute(description = "Determines the size or amount of each interval or step the slider takes between min and max. The full specified value range of the slider (max - min) needs to be evenly divisible by the step. Default: 1", type = "Integer")
    public void setStep(String step) {
        this.step = step;
    }

    @Override
    @StrutsTagAttribute(description = "Determines the value of the slider. Default: 0")
    public void setValue(String value) {
        super.setValue(value);
    }

    @StrutsTagAttribute(description = "Element Id to display the value.")
    public void setDisplayValueElement(String displayValueElement) {
        this.displayValueElement = displayValueElement;
    }

    @StrutsTagAttribute(description = "A comma delimited list of topics that published when slide")
    public void setOnSlideTopics(String onSlideTopics) {
        this.onSlideTopics = onSlideTopics;
    }

}
    
    
    
    

    




    
    
    © 2015 - 2024 Weber Informatics LLC | Privacy Policy