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.sample.app.editor;
35  
36  import info.magnolia.sample.app.editor.location.EditorLocation;
37  import info.magnolia.ui.framework.app.BaseSubApp;
38  import info.magnolia.ui.api.app.SubAppContext;
39  import info.magnolia.event.EventBus;
40  import info.magnolia.ui.api.app.SubAppEventBus;
41  import info.magnolia.ui.api.location.Location;
42  import info.magnolia.ui.api.view.View;
43  
44  import javax.inject.Inject;
45  import javax.inject.Named;
46  
47  /**
48   * SubApp for editor tabs in sample app.
49   */
50  public class SampleEditorSubApp extends BaseSubApp implements SampleEditorView.Listener {
51  
52      private final SampleEditorView view;
53  
54      @Inject
55      public SampleEditorSubApp(final SubAppContext subAppContext, final SampleEditorView view, final @Named(SubAppEventBus.NAME) EventBus subAppEventBus) {
56          super(subAppContext, view);
57          this.view = view;
58      }
59  
60      @Override
61      public String getCaption() {
62          return "Editor " + view.getName();
63      }
64  
65      @Override
66      public View start(Location location) {
67          super.start(location);
68          this.view.setName(location.getParameter());
69          this.view.setListener(this);
70          return view;
71      }
72  
73      /**
74       * Overwrite supportsLocation to implement custom handling of subApp opening.
75       * Will take care of the location change in case the current view name equals the new view name.
76       *
77       * @param location the new location
78       * @return true if current SubApp should handle the location update
79       */
80      @Override
81      public boolean supportsLocation(Location location) {
82          EditorLocation newLocation = EditorLocation.wrap(location);
83          return view.getName().equals(newLocation.getViewName());
84      }
85  }