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