1 /**
2 * This file Copyright (c) 2003-2011 Magnolia International
3 * Ltd. (http://www.magnolia-cms.com). All rights reserved.
4 *
5 *
6 * This file is dual-licensed under both the Magnolia
7 * Network Agreement and the GNU General Public License.
8 * You may elect to use one or the other of these licenses.
9 *
10 * This file is distributed in the hope that it will be
11 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12 * implied warranty of MERCHANTABILITY or FITNESS FOR A
13 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14 * Redistribution, except as permitted by whichever of the GPL
15 * or MNA you select, is prohibited.
16 *
17 * 1. For the GPL license (GPL), you can redistribute and/or
18 * modify this file under the terms of the GNU General
19 * Public License, Version 3, as published by the Free Software
20 * Foundation. You should have received a copy of the GNU
21 * General Public License, Version 3 along with this program;
22 * if not, write to the Free Software Foundation, Inc., 51
23 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24 *
25 * 2. For the Magnolia Network Agreement (MNA), this file
26 * and the accompanying materials are made available under the
27 * terms of the MNA which accompanies this distribution, and
28 * is available at http://www.magnolia-cms.com/mna.html
29 *
30 * Any modifications to this file must keep this entire header
31 * intact.
32 *
33 */
34 package info.magnolia.cms.gui.control;
35
36 import freemarker.template.TemplateException;
37 import info.magnolia.freemarker.FreemarkerHelper;
38
39 import java.io.IOException;
40 import java.io.PrintWriter;
41 import java.io.Writer;
42 import java.util.Map;
43
44 import org.apache.commons.lang.StringUtils;
45 import org.slf4j.Logger;
46 import org.slf4j.LoggerFactory;
47
48
49 /**
50 * Class for a generic control renderered by freemarker.
51 * @author Manuel Molaschi
52 * @version $Id: $
53 */
54 public class FreemarkerControl extends ControlImpl {
55
56 /**
57 * Logger.
58 */
59 private static Logger log = LoggerFactory.getLogger(FreemarkerControl.class);
60
61 /**
62 * Constructor
63 * @param valueType ControlImpl.VALUETYPE_MULTIPLE or ControlImpl.VALUETYPE_SINGLE
64 */
65 public FreemarkerControl(int valueType) {
66 this.setValueType(valueType);
67 }
68
69 /**
70 * Draw control on writer
71 * @param out writer to write on
72 * @param path path of freemarker template. The template will be automatically searched in classpath or in
73 * filesystem
74 * @param parameters map of parameters to be used in template
75 * @throws IOException exception in template loading
76 * @throws TemplateException exception in template rendering
77 */
78 public void drawHtml(Writer out, String path, Map parameters) throws IOException, TemplateException {
79
80 if (path.startsWith("classpath:")) {
81 path = StringUtils.substringAfter(path, "classpath:");
82 }
83
84 // render
85 FreemarkerHelper.getInstance().render(path, parameters, out);
86
87 // write generic html save info
88 ((PrintWriter) out).print(this.getHtmlSaveInfo());
89 }
90 }