org.apache.tiles.freemarker.template.InsertTemplateFMModel Maven / Gradle / Ivy

Go to download
/*
 * This file was automatically generated by Apache Tiles Autotag.
 */
package org.apache.tiles.freemarker.template;

import java.io.IOException;
import java.util.Map;

import org.apache.tiles.autotag.core.runtime.ModelBody;
import org.apache.tiles.autotag.core.runtime.AutotagRuntime;

import freemarker.core.Environment;
import freemarker.template.TemplateDirectiveBody;
import freemarker.template.TemplateDirectiveModel;
import freemarker.template.TemplateException;
import freemarker.template.TemplateModel;

/**
 * 
 * Insert a template.
 * 
 * 
 * Insert a template with the possibility to pass parameters (called
 * attributes). A template can be seen as a procedure that can take parameters
 * or attributes. <tiles:insertTemplate> allows to define
 * these attributes and pass them to the inserted jsp page, called template.
 * Attributes are defined using nested tag
 * <tiles:putAttribute> or
 * <tiles:putListAttribute>.
 * 
 * 
 * You must specify template attribute, for inserting a template
 * 
 * 
 * 
 * Example : 
 * 
 * 
 *  * <code>
 *           <tiles:insertTemplate template="/basic/myLayout.jsp" flush="true">
 *              <tiles:putAttribute name="title" value="My first page" />
 *              <tiles:putAttribute name="header" value="/common/header.jsp" />
 *              <tiles:putAttribute name="footer" value="/common/footer.jsp" />
 *              <tiles:putAttribute name="menu" value="/basic/menu.jsp" />
 *              <tiles:putAttribute name="body" value="/basic/helloBody.jsp" />
 *           </tiles:insertTemplate>
 *         </code>
 * 
 */
public class InsertTemplateFMModel implements TemplateDirectiveModel {

    /**
     * The template model.
     */
    private org.apache.tiles.template.InsertTemplateModel model;

    /**
     * Constructor.
     *
     * @param model
     *            The template model.
     */
    public InsertTemplateFMModel(org.apache.tiles.template.InsertTemplateModel model) {
        this.model = model;
    }

    /** {@inheritDoc} */
    @SuppressWarnings("unchecked")
    @Override
    public void execute(Environment env, @SuppressWarnings("rawtypes") Map params, TemplateModel[] loopVars,
            TemplateDirectiveBody body) throws TemplateException, IOException {
        AutotagRuntime runtime = new org.apache.tiles.request.freemarker.autotag.FreemarkerAutotagRuntime();
        if (runtime instanceof TemplateDirectiveModel) {
            ((TemplateDirectiveModel) runtime).execute(env, params, loopVars, body);
        }
        org.apache.tiles.request.Request request = runtime.createRequest();
        ModelBody modelBody = runtime.createModelBody();
        model.execute(
            runtime.getParameter("template", java.lang.String.class, null),
            runtime.getParameter("templateType", java.lang.String.class, null),
            runtime.getParameter("templateExpression", java.lang.String.class, null),
            runtime.getParameter("role", java.lang.String.class, null),
            runtime.getParameter("preparer", java.lang.String.class, null),
            runtime.getParameter("flush", java.lang.Boolean.class, false),
                request, modelBody
        );
    }
}