View Javadoc
1   /**
2    * This file Copyright (c) 2020 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.rendering.spa.renderer;
35  
36  import info.magnolia.rendering.context.RenderingContext;
37  import info.magnolia.rendering.engine.OutputProvider;
38  import info.magnolia.rendering.engine.RenderingEngine;
39  import info.magnolia.rendering.listeners.AbstractRenderingListener.RenderingListenerReturnCode;
40  import info.magnolia.rendering.template.RenderableDefinition;
41  
42  import javax.inject.Provider;
43  import javax.jcr.Node;
44  import javax.servlet.http.HttpServletResponse;
45  import java.util.Collection;
46  import java.util.LinkedList;
47  import java.util.Map;
48  
49  /**
50   * SPA implementation of {@link RenderingEngine}. Doesn't actually render, only serves as a holder of rendering context for templating elements.
51   */
52  public class AnnotationRenderingEngine implements RenderingEngine {
53  
54      private Provider<RenderingContext> renderingContextProvider;
55  
56      private Boolean autoPopulateFromRequest = false;
57      private Boolean renderEmptyAreas = false;
58  
59      public AnnotationRenderingEngine(Provider<RenderingContext> renderingContextProvider) {
60          this.renderingContextProvider = renderingContextProvider;
61      }
62  
63      @Override
64      public void render(Node node, OutputProvider outputProvider) {
65      }
66  
67      @Override
68      public void render(Node node, Map<String, Object> map, OutputProvider outputProvider) {
69      }
70  
71      @Override
72      public void render(Node node, RenderableDefinition renderableDefinition, Map<String, Object> map, OutputProvider outputProvider) {
73      }
74  
75      @Override
76      public RenderingContext getRenderingContext() {
77          return renderingContextProvider.get();
78      }
79  
80      @Override
81      public Collection<RenderingListenerReturnCode> initListeners(OutputProvider outputProvider, HttpServletResponse httpServletResponse) {
82          return new LinkedList<>();
83      }
84  
85      @Override
86      public Boolean getRenderEmptyAreas() {
87          return this.renderEmptyAreas;
88      }
89  
90      @Override
91      public Boolean getAutoPopulateFromRequest() {
92          return this.autoPopulateFromRequest;
93      }
94  }