View Javadoc

1   /**
2    * This file Copyright (c) 2012-2013 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.ui.framework.app.embedded;
35  
36  import info.magnolia.context.MgnlContext;
37  import info.magnolia.ui.api.app.SubAppContext;
38  import info.magnolia.ui.api.location.Location;
39  import info.magnolia.ui.api.view.View;
40  import info.magnolia.ui.framework.app.BaseSubApp;
41  
42  import javax.inject.Inject;
43  
44  import org.apache.commons.lang.StringUtils;
45  import org.slf4j.Logger;
46  import org.slf4j.LoggerFactory;
47  
48  
49  /**
50   * Sub app for the main tab in an embedded page app.
51   */
52  public class EmbeddedPageSubApp extends BaseSubApp {
53  
54      private static final Logger log = LoggerFactory.getLogger(EmbeddedPageSubApp.class);
55      private Location lastLocation;
56  
57      @Inject
58      public EmbeddedPageSubApp(SubAppContext subAppContext, EmbeddedPageView pageView) {
59          super(subAppContext, pageView);
60      }
61  
62      @Override
63      public View start(Location location) {
64          this.lastLocation = location;
65          String url = location.getParameter();
66          if (StringUtils.isEmpty(url)) {
67              EmbeddedPageSubAppDescriptor subAppDescriptor = ((EmbeddedPageSubAppDescriptor) getSubAppContext().getSubAppDescriptor());
68              url = subAppDescriptor.getUrl();
69          }
70  
71          url = updateUrl(url);
72          getView().setUrl(url);
73          return super.start(location);
74      }
75  
76      /**
77       * Check whether the url has changed, if so update the view to display the new location.
78       */
79      @Override
80      public void locationChanged(Location location) {
81          String url = location.getParameter();
82          if (StringUtils.isNotBlank(url) && !url.equals(lastLocation.getParameter())) {
83              getView().setUrl(updateUrl(url));
84          }
85          this.lastLocation = location;
86          super.locationChanged(location);
87      }
88  
89      @Override
90      public EmbeddedPageView getView() {
91          return (EmbeddedPageView) super.getView();
92      }
93  
94      /**
95       * Add the context path to internal urls.
96       */
97      private String updateUrl(String url) {
98          boolean isInternalPage = !url.startsWith("http");
99  
100         if(isInternalPage) {
101             url = url.startsWith("/") ? MgnlContext.getContextPath() + url : MgnlContext.getContextPath() + "/" + url;
102         }
103         return url;
104     }
105 }