View Javadoc

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.module.blossom.render;
35  
36  import java.util.Locale;
37  import java.util.Map;
38  import java.util.Stack;
39  
40  import info.magnolia.rendering.context.RenderingContext;
41  
42  /**
43   * Maintains a thread local stack of details that are needed during rendering but can't be passed as method arguments
44   * through the Magnolia render chain. Used by renderers and views.
45   *
46   * @since 1.0
47   */
48  public class RenderContext {
49  
50      private static ThreadLocal<Stack<RenderContext>> stack = new ThreadLocal<Stack<RenderContext>>();
51  
52      public static RenderContext push() {
53          RenderContext context = new RenderContext();
54          Stack<RenderContext> s = stack.get();
55          if (s == null) {
56              s = new Stack<RenderContext>();
57              stack.set(s);
58          }
59          s.push(context);
60          return context;
61      }
62  
63      public static void pop() {
64          Stack<RenderContext> s = stack.get();
65          if (s != null) {
66              s.pop();
67          }
68      }
69  
70      public static RenderContext get() {
71          Stack<RenderContext> s = stack.get();
72          if (s == null || s.isEmpty()) {
73              throw new IllegalStateException();
74          }
75          return s.peek();
76      }
77  
78      private RenderingContext renderingContext;
79      private Map<String, Object> contextObjects;
80      private Map model;
81      private Locale locale;
82      private String templateScript;
83  
84      public RenderingContext getRenderingContext() {
85          return renderingContext;
86      }
87  
88      public void setRenderingContext(RenderingContext renderingContext) {
89          this.renderingContext = renderingContext;
90      }
91  
92      public Map<String, Object> getContextObjects() {
93          return contextObjects;
94      }
95  
96      public void setContextObjects(Map<String, Object> contextObjects) {
97          this.contextObjects = contextObjects;
98      }
99  
100     public Map getModel() {
101         return model;
102     }
103 
104     public void setModel(Map model) {
105         this.model = model;
106     }
107 
108     public Locale getLocale() {
109         return locale;
110     }
111 
112     public void setLocale(Locale locale) {
113         this.locale = locale;
114     }
115 
116     public String getTemplateScript() {
117         return templateScript;
118     }
119 
120     public void setTemplateScript(String templateScript) {
121         this.templateScript = templateScript;
122     }
123 }