1 /**
2 * This file Copyright (c) 2015-2018 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.context.WebContext;
38 import info.magnolia.objectfactory.Components;
39 import info.magnolia.rendering.context.RenderingContext;
40 import info.magnolia.rendering.engine.RenderException;
41 import info.magnolia.rendering.template.TemplateDefinition;
42 import info.magnolia.templating.module.TemplatingModule;
43
44 import java.io.IOException;
45
46 import javax.inject.Inject;
47 import javax.inject.Provider;
48 import javax.jcr.Node;
49
50 /**
51 * Creates the <code>cms:page</code> tag.
52 */
53 public class PageElement extends AbstractContentTemplatingElement {
54
55 public static final String CMS_PAGE_TAG = "cms:page";
56
57 @Inject
58 public PageElement(ServerConfiguration server, RenderingContext renderingContext, Provider<TemplatingModule> templatingModuleProvider, WebContext webContext) {
59 super(server, renderingContext, templatingModuleProvider, webContext);
60 }
61
62 /**
63 * @deprecated since 6.1. Use {@link #PageElement(info.magnolia.cms.beans.config.ServerConfiguration, info.magnolia.rendering.context.RenderingContext, javax.inject.Provider, info.magnolia.context.WebContext)} instead.
64 */
65 @Deprecated
66 public PageElement(ServerConfiguration server, RenderingContext renderingContext) {
67 this(server, renderingContext, () -> Components.getComponent(TemplatingModule.class), Components.getComponent(WebContext.class));
68 }
69
70 @Override
71 public void begin(Appendable out) throws IOException, RenderException {
72 if (!renderComments()) { // override renderComments() method when adding extra condition to make sure it's in sync with adding comments in end() method
73 return;
74 }
75
76 Node content = getPassedContent();
77 if (content == null) {
78 content = currentContent();
79 }
80 setContent(content);
81
82 setTemplateDefinition(getRequiredTemplateDefinition());
83
84 MarkupHelper helper = new MarkupHelper(out);
85 helper.openComment(CMS_PAGE_TAG);
86 setPageEditorAttributes(helper, "page");
87 helper.append(" -->\n");
88 helper.closeComment(CMS_PAGE_TAG);
89
90 }
91
92 @Override
93 public void end(Appendable out) throws IOException, RenderException {
94 if (!renderComments()) { // override renderComments() method when adding extra condition to make sure it's in sync with adding comments in begin() method
95 }
96 }
97
98 private TemplateDefinition getRequiredTemplateDefinition() {
99 return (TemplateDefinition) getRenderingContext().getRenderableDefinition();
100 }
101 }