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

/**
 * 
 * 
 * The tabbedpanel widget is primarily an AJAX component, where each tab can
 * either be local content or remote content.
 * 
 * 
 * If the useSelectedTabCookie attribute is set to true, the id of the selected
 * tab is saved in a cookie on activation. When coming back to this view, the
 * cookie is read and the tab will be activated again, unless an actual value
 * for the selectedTab attribute is specified.
 * 
 * 
 * 
 * 
 * Examples
 * 
 * 
 * 
 * 
 *  * <sj:tabbedpanel id="mytabs" animate="true" collapsible="true" useSelectedTabCookie="true"> 
 *  <sj:tab id="tab1" target="tone" label="Tab One"/> 
 *  <sj:tab id="tab2" target="ttwo" label="Tab Two"/> 
 *  <sj:tab id="tab3" target="tthree" label="Tab Three"/> 
 *  <div id="tone"> Test 1 </div> 
 *  <div id="ttwo"> Test 2 </div> 
 *  <div id="tthree"> Test 3 </div>
 * </sj:tabbedpanel>
 * 
 * 
 * 
 * 
 * 
 * 
 *  * <s:url id="remoteurl1" action="myremoteactionone"/> 
 * <s:url id="remoteurl2" action="myremoteactiontwo"/> 
 * <s:url id="remoteurl3" action="myremoteactionthree"/> 
 * <sj:tabbedpanel id="mytabs2" selectedTab="1"> 
 *  <sj:tab id="tab1" href="%{remoteurl1}" label="Tab One"/> 
 *  <sj:tab id="tab2" href="%{remoteurl2}" label="Tab Two"/> 
 *  <sj:tab id="tab3" href="%{remoteurl3}" label="Tab Three"/> 
 * </sj:tabbedpanel>
 * 
 * 
 * 
 * 
 * @author Johannes Geppert
 * 
 */
@StrutsTag(name = "tabbedpanel", tldTagClass = "com.jgeppert.struts2.jquery.views.jsp.ui.TabbedPanelTag", description = "Render a tabbedPanel widget.")
public class TabbedPanel extends AbstractTopicsBean {
	public static final String JQUERYACTION = "tabbedpanel";
	public static final String TEMPLATE = "tabbedpanel";
	public static final String TEMPLATE_CLOSE = "tabbedpanel-close";
	final private static String COMPONENT_NAME = TabbedPanel.class.getName();
	private final static transient Random RANDOM = new Random();

	protected String selectedTab;
	protected String useSelectedTabCookie;
	protected String openOnMouseover;
	protected String collapsible;
	protected String show;
	protected String hide;
	protected String cache;
	protected String disabledTabs;
	protected String sortable;
	protected String onLoadTopics;
	protected String onActivateTopics;
	protected String onBeforeActivateTopics;
	protected String heightStyle;

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

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

		addParameter("jqueryaction", JQUERYACTION);

		if (selectedTab != null)
			addParameter("selectedTab", findValue(selectedTab, Integer.class));
		if (useSelectedTabCookie != null)
			addParameter("useSelectedTabCookie",
					findValue(this.useSelectedTabCookie, Boolean.class));
		if (this.openOnMouseover != null)
			addParameter("openOnMouseover",
					findValue(this.openOnMouseover, Boolean.class));
		if (this.collapsible != null)
			addParameter("collapsible",
					findValue(this.collapsible, Boolean.class));
		if (show != null)
			addParameter("show", findString(show));
		if (hide != null)
			addParameter("hide", findString(hide));
		if (this.cache != null)
			addParameter("cache", findValue(this.cache, Boolean.class));
		if (this.disabledTabs != null)
			addParameter("disabledTabs", findString(this.disabledTabs));
		if (this.onLoadTopics != null)
			addParameter("onLoadTopics", findString(this.onLoadTopics));
		if (this.onActivateTopics!= null)
			addParameter("onActivateTopics", findString(this.onActivateTopics));
		if (this.onBeforeActivateTopics!= null)
			addParameter("onBeforeActivateTopics", findString(this.onBeforeActivateTopics));
		if (this.sortable != null)
			addParameter("sortable", findValue(this.sortable, Boolean.class));
		if (heightStyle != null)
			addParameter("heightStyle", findString(heightStyle));

		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 = "tabbedpanel_" + String.valueOf(nextInt);
			addParameter("id", this.id);
		}
	}

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

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

	public String getDefaultOpenTemplate() {
		return TEMPLATE;
	}

	protected String getDefaultTemplate() {
		return TEMPLATE_CLOSE;
	}

	public String getComponentName() {
		return COMPONENT_NAME;
	}

	@StrutsTagAttribute(description = "The id to assign to the component.", required = true)
	public void setId(String id) {
		// This is required to override tld generation attributes to
		// required=true
		super.setId(id);
	}

	@StrutsTagAttribute(description = "Number of tab that will be selected by default. e.g. 0 for the first tab or 1 for the second tab.", type = "Integer", defaultValue = "0")
	public void setSelectedTab(String selectedTab) {
		this.selectedTab = selectedTab;
	}

	@StrutsTagAttribute(description = "Open Tabs by mouseover event", defaultValue = "false", type = "Boolean")
	public void setOpenOnMouseover(String openOnMouseover) {
		this.openOnMouseover = openOnMouseover;
	}

	@StrutsTagAttribute(description = "Set to true to allow an already selected tab to become unselected again upon reselection", defaultValue = "false", type = "Boolean")
	public void setCollapsible(String collapsible) {
		this.collapsible = collapsible;
	}

	@StrutsTagAttribute(description = "If and how to animate the hiding of the panel. Multiple types supported: Boolean, Number, Object or String (escaped with ' e.g.: 'fold' ")
	public void setShow(String show) {
		this.show = show;
	}

	@StrutsTagAttribute(description = "If and how to animate the showing of the panel. Multiple types supported: Boolean, Number, Object or String (escaped with ' e.g.: 'fold' ")
	public void setHide(String hide) {
		this.hide = hide;
	}

	@StrutsTagAttribute(description = "Store the latest selected tab in a cookie. The cookie is then used to determine the initially selected tab if the selectedTab option is not defined.", defaultValue = "false", type = "Boolean")
	public void setUseSelectedTabCookie(String useSelectedTabCookie) {
		this.useSelectedTabCookie = useSelectedTabCookie;
	}

	@StrutsTagAttribute(description = "Whether or not to cache remote tabs content, e.g. load only once or with every click. Cached content is being lazy loaded, e.g once and only once for the first click.", defaultValue = "false", type = "Boolean")
	public void setCache(String cache) {
		this.cache = cache;
	}

	@StrutsTagAttribute(description = "An array containing the position of the tabs (zero-based index) that should be disabled on initialization. e.g. [1, 2]")
	public void setDisabledTabs(String disabledTabs) {
		this.disabledTabs = disabledTabs;
	}
	@StrutsTagAttribute(description = "A comma delimited list of topics that published after the content of a remote tab has been loaded.", type = "String", defaultValue = "")
	public void setOnLoadTopics(String onLoadTopics) {
		this.onLoadTopics = onLoadTopics;
	}

	@StrutsTagAttribute(description = "A comma delimited list of topics that published after a tab has been activated (after animation completes). If the tabs were previously collapsed.", type = "String", defaultValue = "")
	public void setOnActivateTopics(String onActivateTopics) {
		this.onActivateTopics = onActivateTopics;
	}

	@StrutsTagAttribute(description = "A comma delimited list of topics that published directly after a tab is activated.", type = "String", defaultValue = "")
	public void setOnBeforeActivateTopics(String onBeforeActivateTopics) {
		this.onBeforeActivateTopics = onBeforeActivateTopics;
	}

	@StrutsTagAttribute(description = "Making tabs sortable.", defaultValue = "false", type = "Boolean")
	public void setSortable(String sortable) {
		this.sortable = sortable;
	}

	@StrutsTagAttribute(description = "Controls the height of the accordion and each panel. Possible values 'auto\': All panels will be set to the height of the tallest panel, 'content': Each panel will be only as tall as its content, 'fill': Expand to the available height based on the accordion's parent height.", defaultValue = "auto")
	public void setHeightStyle(String heightStyle) {
		this.heightStyle = heightStyle;
	}
}