View Javadoc
1   /**
2    * This file Copyright (c) 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.rendering.context.RenderingContext;
38  import info.magnolia.rendering.engine.RenderException;
39  import info.magnolia.rendering.template.TemplateDefinition;
40  import info.magnolia.templating.freemarker.AbstractDirective;
41  
42  import java.io.IOException;
43  
44  import javax.jcr.Node;
45  
46  import org.apache.commons.lang3.StringUtils;
47  
48  /**
49   * Creates the <code>cms:page</code> tag.
50   */
51  public class PageElement extends AbstractContentTemplatingElement {
52  
53      private static final String CMS_PAGE_TAG = "cms:page";
54      private String dialog;
55  
56      public PageElement(ServerConfiguration server, RenderingContext renderingContext) {
57          super(server, renderingContext);
58      }
59  
60      @Override
61      public void begin(Appendable out) throws IOException, RenderException {
62          if (!renderComments()) { // override renderComments() method when adding extra condition to make sure it's in sync with adding comments in end() method
63              return;
64          }
65  
66          Node content = getPassedContent();
67          if (content == null) {
68              content = currentContent();
69          }
70  
71          TemplateDefinition templateDefinition = getRequiredTemplateDefinition();
72  
73          dialog = resolveDialog(templateDefinition);
74  
75          MarkupHelper helper = new MarkupHelper(out);
76  
77          helper.openComment(CMS_PAGE_TAG);
78          if (content != null) {
79              helper.attribute(AbstractDirective.CONTENT_ATTRIBUTE, getNodePath(content));
80          }
81          if (dialog != null) {
82              helper.attribute("dialog", dialog);
83          }
84          helper.append(" -->\n");
85          helper.closeComment(CMS_PAGE_TAG);
86  
87      }
88  
89      @Override
90      public void end(Appendable out) throws IOException, RenderException {
91          if (!renderComments()) { // override renderComments() method when adding extra condition to make sure it's in sync with adding comments in begin() method
92              return;
93          }
94      }
95  
96      public void setDialog(String dialog) {
97          this.dialog = dialog;
98      }
99  
100     private TemplateDefinition getRequiredTemplateDefinition() {
101         return (TemplateDefinition) getRenderingContext().getRenderableDefinition();
102     }
103 
104     private String resolveDialog(TemplateDefinition component) {
105         if (StringUtils.isNotEmpty(this.dialog)) {
106             return this.dialog;
107         }
108         String dialog = component.getDialog();
109         if (StringUtils.isNotEmpty(dialog)) {
110             return dialog;
111         }
112         return null;
113     }
114 }