com.jgeppert.struts2.jquery.components.Div 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 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;

/**
 * 
 * 
 * This tag generates an HTML div that loads its content using an XMLHttpRequest
 * call, via the jQuery framework.
 * 
 * 
 * 
 * Examples
 * 
 * 
 *  * <sj:div href="%{#url}">Initial Content</sj:div>
 * 
 * 
 * 
 *  * <img id="indicator" src="${pageContext.request.contextPath}/images/indicator.gif" style="display:none"/>
 * <sj:div href="%{#url}" indicator="indicator"> Initial Content </sj:div>
 * 
 * 
 * 
 *  * <sj:div href="%{#url}" effect="highlight" effectOptions="color : '#222222'" effectDuration="3600">
 *  Initial Content
 * </sj:div>
 * 
 * 
 *
 * @author Johannes Geppert
 */
@StrutsTag(name = "div", tldTagClass = "com.jgeppert.struts2.jquery.views.jsp.ui.DivTag", description = "Render HTML div providing content from remote call via AJAX", allowDynamicAttributes = true)
public class Div extends AbstractContainer implements ResizableBean,
        DroppableBean, DraggableBean, SelectableBean {

    public static final String TEMPLATE = "div";
    public static final String TEMPLATE_CLOSE = "div-close";
    public static final String COMPONENT_NAME = Div.class.getName();
    public static final String JQUERYACTION = "container";

    private static final String PARAM_UPDATE_FREQ = "updateFreq";
    private static final String PARAM_DELAY = "delay";

    private static final String ID_PREFIX_DIV = "div_";

    protected String updateFreq;
    protected String delay;

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

        addParameterIfPresent(PARAM_UPDATE_FREQ, this.updateFreq, Number.class);
        addParameterIfPresent(PARAM_DELAY, this.delay, Number.class);

        addGeneratedIdParam(ID_PREFIX_DIV);
    }

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

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

    @StrutsTagAttribute(description = "How often to reload the content (in milliseconds). e.g. 5000", type = "Number")
    public void setUpdateFreq(String updateFreq) {
        this.updateFreq = updateFreq;
    }

    @StrutsTagAttribute(description = "How long to wait before fetching the content (in milliseconds). e.g. 2000", type = "Number")
    public void setDelay(String delay) {
        this.delay = delay;
    }
}