View Javadoc
1   /**
2    * This file Copyright (c) 2010-2018 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.gwt.client.magnoliashell.viewport.widget;
35  
36  import info.magnolia.ui.vaadin.gwt.client.magnoliashell.viewport.TransitionDelegate;
37  
38  import com.google.gwt.user.client.ui.FlowPanel;
39  import com.google.gwt.user.client.ui.Widget;
40  
41  /**
42   * An overlay that displays the open app in the shell on top of each other.
43   *
44   * @param <T> type of {@link TransitionDelegate} which backs up a concrete viewport widget
45   */
46  public class ViewportWidget<T extends TransitionDelegate> extends FlowPanel {
47  
48      private Widget visibleChild;
49  
50      private T transitionDelegate;
51  
52      public ViewportWidget() {
53          super();
54          addStyleName("v-viewport");
55      }
56  
57      public T getTransitionDelegate() {
58          return transitionDelegate;
59      }
60  
61      public void setTransitionDelegate(T transitionDelegate) {
62          this.transitionDelegate = transitionDelegate;
63      }
64  
65      public Widget getVisibleChild() {
66          return visibleChild;
67      }
68  
69      public void showChild(Widget w) {
70          if (w != visibleChild) {
71              transitionDelegate.setVisibleChild(w);
72              visibleChild = w;
73          }
74      }
75  
76      public void removeChild(Widget w) {
77          removeChildNoTransition(w);
78      }
79  
80      /**
81       * Default non-transitioning behavior, accessible to transition delegates as a fall back.
82       */
83      public void showChildNoTransition(Widget w) {
84          if (visibleChild != null) {
85              visibleChild.setVisible(false);
86          }
87          w.setVisible(true);
88      }
89  
90      public void removeChildNoTransition(Widget w) {
91          super.remove(w);
92      }
93  
94  
95  }