View Javadoc

1   /**
2    * This file Copyright (c) 2003-2011 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.blossom.view;
35  
36  import java.util.Locale;
37  
38  import org.springframework.web.servlet.view.AbstractUrlBasedView;
39  import org.springframework.web.servlet.view.UrlBasedViewResolver;
40  
41  import info.magnolia.rendering.renderer.Renderer;
42  
43  /**
44   * ViewResolver that will resolve views for templates for rendering using the provided TemplateRenderer.
45   *
46   * @since 1.0
47   */
48  public class TemplateViewResolver extends UrlBasedViewResolver {
49  
50      private Renderer viewRenderer;
51  
52      public TemplateViewResolver() {
53          setViewClass(requiredViewClass());
54      }
55  
56      public void setViewRenderer(Renderer viewRenderer) {
57          this.viewRenderer = viewRenderer;
58      }
59  
60      @Override
61      protected Class requiredViewClass() {
62          return TemplateView.class;
63      }
64  
65      @Override
66      protected AbstractUrlBasedView buildView(String viewName) throws Exception {
67          TemplateView view = (TemplateView) super.buildView(viewName);
68          view.setViewRenderer(viewRenderer);
69          return view;
70      }
71  
72      @Override
73      protected boolean canHandle(String viewName, Locale locale) {
74          if (viewName.startsWith(REDIRECT_URL_PREFIX) || viewName.startsWith(FORWARD_URL_PREFIX)) {
75              return true;
76          }
77          return super.canHandle(viewName, locale);
78      }
79  }