1 /**
2 * This file Copyright (c) 2008-2015 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.templatingkit.templates;
35
36 import info.magnolia.module.templatingkit.functions.STKTemplatingFunctions;
37 import info.magnolia.module.templatingkit.sites.Site;
38 import info.magnolia.module.templatingkit.templates.category.TemplateCategory;
39 import info.magnolia.rendering.model.RenderingModel;
40 import info.magnolia.rendering.model.RenderingModelImpl;
41 import info.magnolia.rendering.template.RenderableDefinition;
42 import info.magnolia.templating.functions.TemplatingFunctions;
43
44 import javax.inject.Inject;
45 import javax.jcr.Node;
46
47 /**
48 * Base abstract class to implement for all template models of STK, meaning for page & areas & component model classes.
49 * Provides helpful methods for all STK template models.
50 *
51 * @param <RD> - an instance of {@link RenderableDefinition}
52 *
53 * @author cringele
54 * @version $Id$
55 */
56 public abstract class AbstractSTKTemplateModel<RD extends RenderableDefinition> extends RenderingModelImpl<RD> implements STKRenderingModel<RD> {
57
58 public static final String DEFAULT_SITEROOT_TEMPLATE_CATEGORY = TemplateCategory.HOME;
59 protected final STKTemplatingFunctions stkFunctions;
60 protected final TemplatingFunctions templatingFunctions;
61
62 @Inject
63 public AbstractSTKTemplateModel(Node content, RD definition, RenderingModel<?> parent, STKTemplatingFunctions stkFunctions, TemplatingFunctions templatingFunctions) {
64 super(content, definition, parent);
65 this.stkFunctions = stkFunctions;
66 this.templatingFunctions = templatingFunctions;
67 }
68
69 @Override
70 public Site getSite() {
71 return stkFunctions.site();
72 }
73
74 @Override
75 public Node getSiteRoot() {
76 return stkFunctions.siteRoot(content, DEFAULT_SITEROOT_TEMPLATE_CATEGORY);
77 }
78 }