View Javadoc

1   /**
2    * This file Copyright (c) 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.templating.elements;
35  
36  import info.magnolia.cms.beans.config.ServerConfiguration;
37  import info.magnolia.context.MgnlContext;
38  import info.magnolia.context.WebContext;
39  import info.magnolia.rendering.context.RenderingContext;
40  import info.magnolia.rendering.engine.AppendableOnlyOutputProvider;
41  import info.magnolia.rendering.engine.RenderException;
42  import info.magnolia.rendering.engine.RenderingEngine;
43  
44  import java.io.IOException;
45  import java.util.HashMap;
46  import java.util.Map;
47  
48  import javax.jcr.Node;
49  
50  /**
51   * Renders a piece of content.
52   *
53   * @version $Id$
54   */
55  public class RenderElement extends AbstractContentTemplatingElement {
56  
57      private boolean editable;
58      private String template;
59      private Map<String, Object> contextAttributes = new HashMap<String, Object>();
60      private final RenderingEngine renderingEngine;
61      private Node content;
62  
63      public RenderElement(ServerConfiguration server, RenderingContext renderingContext, RenderingEngine renderingEngine) {
64          super(server, renderingContext);
65          this.renderingEngine = renderingEngine;
66      }
67  
68      @Override
69      public void begin(Appendable out) throws IOException, RenderException {
70          content = getTargetContent();
71  
72          if(isAdmin()){
73              new MarkupHelper(out).openComment("cms:component").append(" -->\n");
74          }
75  
76          // TODO not sure how to pass editable
77  
78          WebContext webContext = MgnlContext.getWebContext();
79          webContext.push(webContext.getRequest(), webContext.getResponse());
80          setAttributesInWebContext(contextAttributes, WebContext.LOCAL_SCOPE);
81          try {
82              renderingEngine.render(content, new AppendableOnlyOutputProvider(out));
83          } finally {
84              webContext.pop();
85              webContext.setPageContext(null);
86              restoreAttributesInWebContext(contextAttributes, WebContext.LOCAL_SCOPE);
87          }
88      }
89  
90      @Override
91      public void end(Appendable out) throws IOException, RenderException {
92          if(isAdmin()){
93              new MarkupHelper(out).closeComment("cms:component");
94          }
95      }
96  
97      public boolean getEditable() {
98          return editable;
99      }
100 
101     public void setEditable(boolean editable) {
102         this.editable = editable;
103     }
104 
105     public String getTemplate() {
106         return template;
107     }
108 
109     public void setTemplate(String template) {
110         this.template = template;
111     }
112 
113 
114     public Map<String, Object> getContextAttributes() {
115         return contextAttributes;
116     }
117 
118     public void setContextAttributes(Map<String, Object> contextAttributes) {
119         this.contextAttributes = contextAttributes;
120     }
121 
122 }