View Javadoc

1   /**
2    * This file Copyright (c) 2003-2010 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.controlx.impl;
35  
36  import info.magnolia.cms.gui.controlx.Control;
37  import info.magnolia.cms.gui.controlx.Renderer;
38  import info.magnolia.cms.i18n.Messages;
39  import info.magnolia.cms.i18n.MessagesManager;
40  import info.magnolia.freemarker.FreemarkerUtil;
41  
42  import java.util.HashMap;
43  import java.util.Map;
44  
45  import org.apache.commons.lang.StringUtils;
46  
47  
48  /**
49   * Used the classname by default to get the template to render.
50   * @author Philipp Bracher
51   * @version $Revision: 32667 $ ($Author: gjoseph $)
52   */
53  public class TemplatedRenderer implements Renderer {
54  
55      private String templateName;
56  
57      /**
58       * Uses the controls class name to construct the template name
59       */
60      public TemplatedRenderer() {
61      }
62  
63      /**
64       * @param templateName
65       */
66      public TemplatedRenderer(String templateName) {
67          this.templateName = templateName;
68      }
69  
70      /**
71       * Render the using the template. The control is passed under the name 'this' and the renderer class is passed under
72       * the name 'renderer'
73       */
74      public String render(Control control) {
75          Map data = new HashMap();
76          data.put("this", control);
77          data.put("renderer", this);
78          return FreemarkerUtil.process(this.getTemplateName(control), data);
79      }
80  
81      /**
82       * Get the message from the renderer. Uses getMessages().
83       * @param key
84       * @return the string found, or the key if not found
85       */
86      public String getMessage(String key) {
87          return getMessages().getWithDefault(key, key);
88      }
89  
90      /**
91       * Get the messages used for the rendering. By default the standard messages are returned.
92       * @return the messages
93       */
94      public Messages getMessages() {
95          return MessagesManager.getMessages();
96      }
97  
98      /**
99       * @return
100      */
101     protected String getTemplateName(Control control) {
102         if (this.templateName == null) {
103             return "/" + StringUtils.replace(control.getClass().getName(), ".", "/") + ".html";
104         }
105 
106         return this.templateName;
107     }
108 
109     /**
110      * @return Returns the templateName.
111      */
112     public String getTemplateName() {
113         return this.templateName;
114     }
115 
116     /**
117      * @param templateName The templateName to set.
118      */
119     public void setTemplateName(String templateName) {
120         this.templateName = templateName;
121     }
122 
123 }