1 /**
2 * This file Copyright (c) 2011-2013 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.rendering.context;
35
36 import info.magnolia.rendering.engine.OutputProvider;
37 import info.magnolia.rendering.engine.RenderException;
38 import info.magnolia.rendering.template.AreaDefinition;
39 import info.magnolia.rendering.template.RenderableDefinition;
40 import info.magnolia.rendering.util.AppendableWriter;
41
42 import java.io.IOException;
43 import java.io.OutputStream;
44 import java.util.List;
45 import java.util.Map;
46
47 import javax.jcr.Node;
48
49
50 /**
51 * Provides all information needed in the rendering process.
52 */
53 public interface RenderingContext {
54
55 Node getMainContent();
56
57 Node getCurrentContent();
58
59 RenderableDefinition getRenderableDefinition();
60
61 AreaDefinition getParentAreaDefinition();
62
63 OutputProvider getOutputProvider();
64
65 /**
66 * Pushes the content and renderableDefinition to be used for rendering. Output will be written using the
67 * OutputProvider already set.
68 */
69 void push(Node content, RenderableDefinition renderableDefinition);
70
71 /**
72 * Pushes the content and renderableDefinition to be used for rendering.
73 *
74 * @param outputProvider the OutputProvider to be used for output or null to use the OutputProvider already set
75 */
76 void push(Node content, RenderableDefinition renderableDefinition, OutputProvider outputProvider);
77
78 void pop();
79
80 AppendableWriter getAppendable() throws IOException;
81
82 OutputStream getOutputStream() throws IOException;
83
84 void handleException(RenderException renderException);
85
86 void addListener(RenderingListener renderingListener);
87
88 void setListeners(List<RenderingListener> listeners);
89
90 // should be called before renderingEngine.render(...)
91 void before(Node content, RenderableDefinition definition, Map<String, Object> contextObjects, OutputProvider out);
92
93 // should be called after renderingEngine.render(...)
94 void after(Node content, RenderableDefinition definition, Map<String, Object> contextObjects, OutputProvider out);
95
96 }