View Javadoc

1   /**
2    * This file Copyright (c) 2010-2012 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.vaadin.magnoliashell.viewport;
35  
36  import info.magnolia.ui.framework.view.View;
37  import info.magnolia.ui.framework.view.ViewPort;
38  import info.magnolia.ui.vaadin.gwt.client.magnoliashell.viewport.VShellViewport;
39  import info.magnolia.ui.vaadin.magnoliashell.BaseMagnoliaShell;
40  import info.magnolia.ui.vaadin.magnoliashell.DeckLayout;
41  
42  import java.util.Iterator;
43  
44  import com.vaadin.ui.ClientWidget;
45  import com.vaadin.ui.ClientWidget.LoadStyle;
46  import com.vaadin.ui.Component;
47  
48  
49  /**
50   * The server side implementation of the shell viewport. MagnoliaShell is capable of holding of such for the shell apps,
51   * one - for the regular apps.
52   */
53  @ClientWidget(value = VShellViewport.class, loadStyle = LoadStyle.EAGER)
54  public class ShellViewport extends DeckLayout implements ViewPort {
55  
56      private String currentShellFragment = "";
57  
58      private final BaseMagnoliaShell parentShell;
59  
60      private View view;
61  
62      public ShellViewport(final BaseMagnoliaShell shell) {
63          super();
64          setSizeFull();
65          display(null);
66          this.parentShell = shell;
67      }
68  
69      public void setCurrentShellFragment(String currentShellFragment) {
70          this.currentShellFragment = currentShellFragment;
71      }
72  
73      public String getCurrentShellFragment() {
74          return currentShellFragment;
75      }
76  
77      @Override
78      public void setView(final View view) {
79          if (view != null) {
80              this.view = view;
81              final Component c = this.view.asVaadinComponent();
82              display(c);
83              parentShell.setActiveViewport(this);
84          }
85      }
86  
87      /**
88       * Viewports need to set visible state on the server first, for being able to resync to client on browser refresh.
89       */
90      @Override
91      public void display(Component content) {
92          super.display(content);
93          Iterator<Component> iterator = getComponentIterator();
94          while (iterator.hasNext()) {
95              Component childComponent = iterator.next();
96              if (childComponent == content) {
97                  childComponent.setVisible(true);
98              } else {
99                  childComponent.setVisible(false);
100             }
101         }
102     }
103 }