1 /**
2 * This file Copyright (c) 2010-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.templating.elements;
35
36 import info.magnolia.cms.beans.config.ServerConfiguration;
37 import info.magnolia.cms.i18n.Messages;
38 import info.magnolia.cms.i18n.MessagesUtil;
39 import info.magnolia.rendering.context.RenderingContext;
40 import info.magnolia.rendering.engine.RenderException;
41 import info.magnolia.rendering.template.RenderableDefinition;
42
43 import java.io.IOException;
44
45 import javax.jcr.Node;
46
47
48 /**
49 * Common super class for templating elements, provides utility methods and defaults.
50 */
51 public abstract class AbstractTemplatingElement implements TemplatingElement {
52
53 private static final String DEFAULT_I18N_BASENAME = "info.magnolia.templating.messages";
54
55 private final ServerConfiguration server;
56 private final RenderingContext renderingContext;
57
58 protected AbstractTemplatingElement(final ServerConfiguration server, final RenderingContext renderingContext) {
59 this.server = server;
60 this.renderingContext = renderingContext;
61 }
62
63 @Override
64 public void begin(Appendable out) throws IOException, RenderException {
65 }
66
67 /**
68 * Override this method if you need to "do something" once the component is rendered, i.e cleanup the context.
69 */
70 @Override
71 public void end(Appendable out) throws IOException, RenderException {
72 }
73
74 /**
75 * Returns the "current content" from the aggregation state. Override this method if your component needs a
76 * different target node.
77 */
78 protected Node currentContent() {
79 return renderingContext.getCurrentContent();
80 }
81
82 protected String getDefinitionMessage(RenderableDefinition definition, String key) {
83 Messages messages = MessagesUtil.chain(definition.getI18nBasename(), MessagesUtil.chainWithDefault(DEFAULT_I18N_BASENAME));
84 return messages.getWithDefault(key, key);
85 }
86
87 protected String getInterfaceMessage(String key) {
88 return MessagesUtil.chainWithDefault(DEFAULT_I18N_BASENAME).getWithDefault(key, key);
89 }
90
91 protected boolean isAdmin() {
92 return server.isAdmin();
93 }
94
95 protected ServerConfiguration getServer() {
96 return server;
97 }
98
99 protected RenderingContext getRenderingContext() {
100 return renderingContext;
101 }
102 }