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

import java.util.Random;

/**
 * 
 * 
 * Renders a local or an remote tab for tabbedPanel
 * 
 * 
 * 
 * 

 * Examples
 * 
 * 
 * 
 * 
 * <s:url id="remoteurl1" action="myremoteactionone"/>
 * <sj:tab id="tab1" target="tone" label="My Local Tab for div tone"/>
 * <sj:tab id="tab2" href="%{remoteurl1}" label="My Remote Tab"/>
 * <div id="tone"> Test 1 </div>
 * 
 * 
 * 
 *
 * @author Johannes Geppert
 */
@StrutsTag(name = "tab", tldTagClass = "com.jgeppert.struts2.jquery.views.jsp.ui.TabTag", description = "Render Tab for Tabbed Pannel providing content from remote call via AJAX")
public class Tab extends AbstractRemoteBean {

    public static final String TEMPLATE = "tab";
    public static final String TEMPLATE_CLOSE = "tab-close";
    public static final String COMPONENT_NAME = Tab.class.getName();
    private final static transient Random RANDOM = new Random();

    protected String target;
    protected String closable;

    public Tab(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();
        TabbedPanel parentTabbedPanel = (TabbedPanel) findAncestor(TabbedPanel.class);
        if (parentTabbedPanel != null) {
            addParameter("parentTabbedPanel", findString(parentTabbedPanel.getId()));
        }

        if (target != null) addParameter("target", findString(target));
        if (closable != null) addParameter("closable", findValue(closable, 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 = "tab_" + 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 = "id of target div for tab")
    public void setTarget(String target) {
        this.target = target;
    }

    @StrutsTagAttribute(description = "If true then tab is closable.", defaultValue = "false", type = "Boolean")
    public void setClosable(String closable) {
        this.closable = closable;
    }

}