|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RenderingModel | Line # 48 | 0 | - | 0 | 0 | - |
-1.0
|
||||||||||||||||||||||||||||||||||||||||||||||||||||
No Tests | |||
1 | /** | |
2 | * This file Copyright (c) 2008-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.templating; | |
35 | ||
36 | import info.magnolia.cms.core.Content; | |
37 | ||
38 | ||
39 | /** | |
40 | * A bean tying the current content and the rendering definition. Subclasses | |
41 | * will provide helper methods to the template. The {@link #execute()} method is | |
42 | * executed before the rendering starts. The model is available under the name | |
43 | * <code>model</code>. | |
44 | * @param <RD> - an instance of {@link RenderableDefinition} | |
45 | * @author pbracher | |
46 | * @version $Id: RenderingModel.java 41137 2011-01-06 18:19:25Z gjoseph $ | |
47 | */ | |
48 | public interface RenderingModel <RD extends RenderableDefinition> { | |
49 | /** | |
50 | * A constant used in some special cases where rendering must be skipped, i.e. a redirect template. | |
51 | * It can be used by template models as a return value for the {@link RenderingModel#execute()} method to inform | |
52 | * {@link AbstractRenderer} that it should not render anything in that particular case. | |
53 | */ | |
54 | public static final String SKIP_RENDERING = "skip-rendering"; | |
55 | ||
56 | /** | |
57 | * The model of the parent paragraph or template. | |
58 | */ | |
59 | public RenderingModel getParent(); | |
60 | ||
61 | /** | |
62 | * The content tied to this model. | |
63 | */ | |
64 | public Content getContent(); | |
65 | ||
66 | /** | |
67 | * The renderable (paragraph/template) tied to this model. | |
68 | */ | |
69 | public RD getDefinition(); | |
70 | ||
71 | /** | |
72 | * Called after all properties were set. Can return a string which is passed | |
73 | * to the method. | |
74 | * {@link RenderableDefinition#determineTemplatePath(String, RenderingModel)} | |
75 | */ | |
76 | public String execute(); | |
77 | ||
78 | } |
|