LanguageSelector.java

/* ===============================================================================
*
* Part of the InfoGlue Content Management Platform (www.infoglue.org)
*
* ===============================================================================
*
*  Copyright (C)
*
* This program is free software; you can redistribute it and/or modify it under
* the terms of the GNU General Public License version 2, as published by the
* Free Software Foundation. See the file LICENSE.html for more information.
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY, including the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along with
* this program; if not, write to the Free Software Foundation, Inc. / 59 Temple
* Place, Suite 330 / Boston, MA 02111-1307 / USA.
*
* ===============================================================================
*/
package org.infoglue.cms.workflow.taglib;

import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;

import javax.servlet.jsp.JspException;

import org.infoglue.cms.controllers.kernel.impl.simple.LanguageController;
import org.infoglue.cms.entities.management.LanguageVO;

/**
 * This class implements the <iw:languageSelector> tag, which presents an <select ... >...</select> 
 * form element representing a language.
 * The value of the selected element is fetched (with the name of the select element as a key) 
 * from the propertyset associated with the workflow. 
 */
public class LanguageSelector extends ElementTag 
{
	/**
	 * The universal version identifier.
	 */
	private static final long serialVersionUID = 7831749037593672903L;

	/**
	 * The category to use when populating the option elements.
	 */
	private List<LanguageVO> languageVOList = new ArrayList<LanguageVO>();
	
	/**
	 * The selected language. 
	 */
	private String selected;
	
	/**
	 * Default constructor.
	 */
	public LanguageSelector() 
	{
		super();
	}

	/**
	 * Process the end tag. Creates the option elements and writes the select
	 * element to the output stream.
	 * 
	 * @return indication of whether to continue evaluating the JSP page.
	 * @throws JspException if an I/O error occurs when writing to the output stream.
	 */
	public int doEndTag() throws JspException 
	{
		createOptions();
		languageVOList.clear();
		selected   = null;
		return super.doEndTag();
	}
	
	/**
	 * Creates the option elements.
	 */
	private void createOptions()
	{
		try
		{
			List languages = LanguageController.getController().getLanguageVOList();
			for(final Iterator i = languages.iterator(); i.hasNext();) 
			{
				final LanguageVO languageVO = (LanguageVO) i.next();
				final String name           = languageVO.getName();
				final String value          = languageVO.getId().toString();
				
				getElement().addChild("option")
					.addText(name)
					.addAttribute("value", value)
					.addAttribute("selected", "selected", value != null && selected != null && value.equals(selected));
			}
		}
		catch(Exception e)
		{
			e.printStackTrace();
		}
	}
	
	/**
	 * Creates the element to use when constructing this tag.
	 * 
	 * @return the element to use when constructing this tag.
	 */
	protected Element createElement()
	{
		return new Element("select");
	}
	
	/**
	 * Sets the label of the first option element.
	 * 
	 * @param label the label to use.
	 */
	public void setDefaultLabel(final String label) 
	{
		getElement().addChildFirst("option").addText(label);
	}
	
	/**
	 * Sets the name attribute of the select element to the specified value. 
	 * 
	 * @param name the name to use.
	 */
	public void setName(final String name) 
	{
		getElement().addAttribute("name", name);
		selected = getPropertySet().getDataString(name);
	}
	
}