org.got5.tapestry5.jquery.components.Accordion Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of tapestry5-jquery Show documentation
Tapestry Components Library
The newest version!
//
// Copyright 2010 GOT5 (GO Tapestry 5)
//
// Licensed 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 org.got5.tapestry5.jquery.components;

import java.util.ArrayList;

import org.apache.tapestry5.BindingConstants;
import org.apache.tapestry5.Block;
import org.apache.tapestry5.ComponentResources;
import org.apache.tapestry5.MarkupWriter;
import org.apache.tapestry5.PropertyOverrides;
import org.apache.tapestry5.annotations.AfterRender;
import org.apache.tapestry5.annotations.BeginRender;
import org.apache.tapestry5.annotations.Parameter;
import org.apache.tapestry5.annotations.Property;
import org.apache.tapestry5.annotations.SetupRender;
import org.apache.tapestry5.annotations.SupportsInformalParameters;
import org.apache.tapestry5.internal.TapestryInternalUtils;
import org.apache.tapestry5.ioc.annotations.Inject;
import org.apache.tapestry5.json.JSONObject;
import org.apache.tapestry5.services.javascript.JavaScriptSupport;
import org.got5.tapestry5.jquery.base.AbstractExtendableComponent;
import org.got5.tapestry5.jquery.utils.JQueryAccordionData;
import org.got5.tapestry5.jquery.utils.JQueryUtils;

/**
 * @see jQuery UI Official Documentation
 * 
 * @tapestrydoc
 */
@SupportsInformalParameters
public class Accordion extends AbstractExtendableComponent
{
	
	/**
	 * 
	 */
	@Parameter(defaultPrefix=BindingConstants.LITERAL)
	private String panels;
	
	/**
	 * The number of the accordion tab to activate when the page is displayed on the client.
	 */
	@Parameter(required=true)
	private int activeElementId;
	
	/**
	 * The slider parameters (please refer to jquery-ui documentation)
	 */
	@Parameter
    private JSONObject params;
	
	/**
     * Defines where block and label overrides are obtained from. 
     */
    @Parameter(value = "this", allowNull = false)
    @Property(write = false)
    private PropertyOverrides overrides;
    
    /**
     * @deprecated
     */
    @Property
    @Parameter
    private ArrayList listOfElements;
    
    /**
     * @deprecated
     */
    @Property
    private JQueryAccordionData currentElement;
    
	@Inject
	private ComponentResources resources;

    @Inject
    private JavaScriptSupport javaScriptSupport;
	
    @Property
	private String panel;

    @BeginRender
	void initJs()
    {
        setDefaultMethod("accordion");
    }
	
	@SetupRender
    void startDiv(MarkupWriter writer)
    {
        writer.element("div", "id", getClientId());
    }

	
	@AfterRender
    void afterRender(MarkupWriter writer)
	{
    	resources.renderInformalParameters(writer);

        writer.end();
    	JSONObject data = new JSONObject();
        data.put("id", getClientId());

        if (params == null)
            params = new JSONObject();

        JSONObject defaults = new JSONObject();
        defaults.put("active", activeElementId);

        JQueryUtils.merge(defaults, params);
        data.put("params", defaults);

        javaScriptSupport.require("tjq/ui").invoke("accordion").with(data);

    }

	public Block getCurrentBlock()
	{
		if(resources.isBound("listOfElements"))
			return resources.getContainer().getComponentResources().getBlock(currentElement.getBlockName());
		return overrides.getOverrideBlock(panel);
	}
	
	public String[] getPanels()
	{ 
		return TapestryInternalUtils.splitAtCommas(panels);
	}
	
	/**
	 * First, Tapestry5-jQuery will look for the label in an associated
	 * bundle, with the name of the panel as a key. If the message does not exist
	 * Tapestry5-jQuery will provide a default value :  the name of the panel, with
	 * capital letters and space.
	 * 
	 * @return the label of a tab
	 */
	public String getPanelTitle()
	{
		if(overrides.getOverrideMessages().contains(panel))
		{
			return overrides.getOverrideMessages().get(panel);
		}
		
		return TapestryInternalUtils.toUserPresentable(panel);
	}
	
	public Boolean getJQueryAccordionData(){
		return resources.isBound("listOfElements");
	}
}