View Javadoc

1   /*
2    * $Id: TemplateRenderingContext.java 451544 2006-09-30 05:38:02Z mrdon $
3    *
4    * Copyright 2006 The Apache Software Foundation.
5    *
6    * Licensed under the Apache License, Version 2.0 (the "License");
7    * you may not use this file except in compliance with the License.
8    * You may obtain a copy of the License at
9    *
10   *      http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing, software
13   * distributed under the License is distributed on an "AS IS" BASIS,
14   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15   * See the License for the specific language governing permissions and
16   * limitations under the License.
17   */
18  package org.apache.struts2.components.template;
19  
20  import java.io.Writer;
21  import java.util.Map;
22  
23  import org.apache.struts2.components.UIBean;
24  
25  import com.opensymphony.xwork2.util.ValueStack;
26  
27  /***
28   * Context used when rendering templates.
29   */
30  public class TemplateRenderingContext {
31      Template template;
32      ValueStack stack;
33      Map parameters;
34      UIBean tag;
35      Writer writer;
36  
37      /***
38       * Constructor
39       *
40       * @param template  the template.
41       * @param writer    the writer.
42       * @param stack     OGNL value stack.
43       * @param params    parameters to this template.
44       * @param tag       the tag UI component.
45       */
46      public TemplateRenderingContext(Template template, Writer writer, ValueStack stack, Map params, UIBean tag) {
47          this.template = template;
48          this.writer = writer;
49          this.stack = stack;
50          this.parameters = params;
51          this.tag = tag;
52      }
53  
54      public Template getTemplate() {
55          return template;
56      }
57  
58      public ValueStack getStack() {
59          return stack;
60      }
61  
62      public Map getParameters() {
63          return parameters;
64      }
65  
66      public UIBean getTag() {
67          return tag;
68      }
69  
70      public Writer getWriter() {
71          return writer;
72      }
73  }