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.rendering.context; 35 36 import java.io.IOException; 37 import java.io.OutputStream; 38 import java.io.Writer; 39 40 import javax.jcr.Node; 41 42 import info.magnolia.rendering.engine.OutputProvider; 43 import info.magnolia.rendering.engine.RenderException; 44 import info.magnolia.rendering.template.RenderableDefinition; 45 import info.magnolia.rendering.util.AppendableWriter; 46 47 48 /** 49 * Provides all information needed in the rendering process. 50 */ 51 public interface RenderingContext { 52 53 Node getMainContent(); 54 55 Node getCurrentContent(); 56 57 RenderableDefinition getRenderableDefinition(); 58 59 OutputProvider getOutputProvider(); 60 61 /** 62 * Pushes the content and renderableDefinition to be used for rendering. Output will be written using the 63 * OutputProvider already set. 64 */ 65 void push(Node content, RenderableDefinition renderableDefinition); 66 67 /** 68 * Pushes the content and renderableDefinition to be used for rendering. 69 * 70 * @param outputProvider the OutputProvider to be used for output or null to use the OutputProvider already set 71 */ 72 void push(Node content, RenderableDefinition renderableDefinition, OutputProvider outputProvider); 73 74 void pop(); 75 76 AppendableWriter getAppendable() throws RenderException, IOException; 77 78 OutputStream getOutputStream() throws RenderException, IOException; 79 80 void handleException(RenderException renderException, Writer out); 81 }