/* 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.riotfamily.forms.element;

import java.io.PrintWriter;
import java.util.Map;

import org.riotfamily.common.util.Generics;
import org.riotfamily.forms.CompositeElement;
import org.riotfamily.forms.Element;
import org.riotfamily.forms.TemplateUtils;


/**
 * CompositeElement that is rendered using a template.
 */
public abstract class TemplateElement extends CompositeElement {
	
	private Map<String, Object> renderModel = Generics.newHashMap();
	
	private String template;
	
	public TemplateElement() {
		this("element");
	}
	
	public TemplateElement(String modelKey) {
		this.template = TemplateUtils.getTemplatePath(this);
		setAttribute(modelKey, this);
	}
	
	public TemplateElement(String modelKey, String template) {
		this.template = template;
		setAttribute(modelKey, this);
	}
		
	protected void addComponent(String key, Element element) {
		addComponent(element);
		setAttribute(key, element);
	}
	
	public Map<String, Object> getRenderModel() {
		return renderModel;
	}
	
	public void setAttribute(String key, Object value) {
		renderModel.put(key,value);
	}
	
	public Object getAttribute(String key) {
		return renderModel.get(key);
	}
	
	/**
	 * Returns the name of the template that is used to render the element.
	 */
	protected final String getTemplate() {
		return template;
	}

	/**
	 * Sets the name of the template that is used to render the element.
	 * 
	 * @param name name of the template to use
	 * @see #renderInternal(PrintWriter)
	 * @see org.riotfamily.forms.TemplateRenderer
	 */
	public final void setTemplate(String name) {
		this.template = name;
	}
	
	@Override
	protected void afterFormContextSet() {
		setAttribute("messageResolver", getFormContext().getMessageResolver());
		setAttribute("errors", getForm().getErrors());
	}
	
	@Override
	protected void renderInternal(PrintWriter writer) {
		renderTemplate(writer);
	}
	
	protected void renderTemplate(PrintWriter writer) {
		getFormContext().getTemplateRenderer().render(
				template, renderModel, writer);
	}
}