View Javadoc
1   /**
2    * This file Copyright (c) 2015 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.module.blossom.view;
35  
36  import info.magnolia.objectfactory.Components;
37  import info.magnolia.rendering.renderer.ContextAttributeConfiguration;
38  
39  import java.util.HashMap;
40  import java.util.Map;
41  
42  import org.springframework.beans.factory.config.AbstractFactoryBean;
43  
44  /**
45   * Factory bean for creating instances of {@link SiteAwareFreemarkerTemplateViewRenderer}.
46   *
47   * @see SiteAwareFreemarkerTemplateViewRenderer
48   * @since 3.1.1
49   */
50  public class SiteAwareFreemarkerTemplateViewRendererFactoryBean extends AbstractFactoryBean<SiteAwareFreemarkerTemplateViewRenderer> {
51  
52      private Map<String, ContextAttributeConfiguration> contextAttributes = new HashMap<String, ContextAttributeConfiguration>();
53      private boolean exposeModelAsRequestAttributes = true;
54      private boolean exposeSpringMacroHelpers = true;
55  
56      public Map<String, ContextAttributeConfiguration> getContextAttributes() {
57          return contextAttributes;
58      }
59  
60      public void setContextAttributes(Map<String, ContextAttributeConfiguration> contextAttributes) {
61          this.contextAttributes = contextAttributes;
62      }
63  
64      public void addContextAttribute(String name, ContextAttributeConfiguration contextAttributeConfiguration) {
65          this.contextAttributes.put(name, contextAttributeConfiguration);
66      }
67  
68      public void addContextAttribute(String name, Class<?> componentClass) {
69          ContextAttributeConfiguration attributeConfiguration = new ContextAttributeConfiguration();
70          attributeConfiguration.setName(name);
71          attributeConfiguration.setComponentClass(componentClass);
72          addContextAttribute(name, attributeConfiguration);
73      }
74  
75      public boolean isExposeModelAsRequestAttributes() {
76          return exposeModelAsRequestAttributes;
77      }
78  
79      public void setExposeModelAsRequestAttributes(boolean exposeModelAsRequestAttributes) {
80          this.exposeModelAsRequestAttributes = exposeModelAsRequestAttributes;
81      }
82  
83      public boolean isExposeSpringMacroHelpers() {
84          return exposeSpringMacroHelpers;
85      }
86  
87      public void setExposeSpringMacroHelpers(boolean exposeSpringMacroHelpers) {
88          this.exposeSpringMacroHelpers = exposeSpringMacroHelpers;
89      }
90  
91      @Override
92      public Class<?> getObjectType() {
93          return SiteAwareFreemarkerTemplateViewRenderer.class;
94      }
95  
96      @Override
97      protected SiteAwareFreemarkerTemplateViewRenderer createInstance() throws Exception {
98          SiteAwareFreemarkerTemplateViewRenderer renderer = Components.newInstance(SiteAwareFreemarkerTemplateViewRenderer.class);
99          renderer.setExposeModelAsRequestAttributes(exposeModelAsRequestAttributes);
100         renderer.setExposeSpringMacroHelpers(exposeSpringMacroHelpers);
101         renderer.setContextAttributes(contextAttributes);
102         return renderer;
103     }
104 }