1 /**
2 * This file Copyright (c) 2011-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.shell;
35
36 import info.magnolia.ui.vaadin.gwt.client.magnoliashell.shellmessage.ShellMessageWidget.MessageType;
37 import info.magnolia.ui.vaadin.gwt.client.magnoliashell.viewport.widget.ViewportWidget;
38 import info.magnolia.ui.vaadin.gwt.client.shared.magnoliashell.Fragment;
39 import info.magnolia.ui.vaadin.gwt.client.shared.magnoliashell.ShellAppType;
40 import info.magnolia.ui.vaadin.gwt.client.shared.magnoliashell.ViewportType;
41
42 import com.google.gwt.user.client.ui.HasWidgets;
43 import com.google.gwt.user.client.ui.IsWidget;
44 import com.google.gwt.user.client.ui.Widget;
45
46 /**
47 * The view interface for MagnoliaShell (implemented by GWT part of MagnoliaShell).
48 */
49 public interface MagnoliaShellView extends HasWidgets, IsWidget {
50
51 void setPresenter(final Presenter presenter);
52
53 void updateViewport(ViewportWidget viewport, ViewportType type);
54
55 void shiftViewportsVertically(int shiftPx, boolean animated);
56
57 void setShellAppIndication(ShellAppType type, int indication);
58
59 void showMessage(final MessageType type, String text, String message, String id);
60
61 void hideAllMessages();
62
63 void closeMessageEager(String id);
64
65 void navigateToMessageDetails(String id);
66
67 void updateShellDivet();
68
69 boolean hasOverlay(Widget widget);
70
71 /**
72 * Add the overlayWidget to the Shell - but the DOM of the widget will be placed over
73 * the DOM of the specified overlayParent.
74 * The overlayWidget gets removed automatically -
75 * because the component is no longer returned by MagnoliaShell iterator.
76 */
77 void openOverlayOnWidget(Widget overlayWidget, Widget overlayParent);
78
79 void onShellAppStarting(ShellAppType type);
80
81 void onAppStarting();
82
83 void setUserMenu(Widget widget);
84
85 void setSticker(Widget widget);
86
87 /**
88 * Presenter for {@link MagnoliaShellView}.
89 */
90 interface Presenter extends ShellAppLauncher.Listener {
91
92 void activateShellApp(Fragment f);
93
94 void updateViewportLayout(ViewportWidget viewport);
95
96 void closeCurrentApp();
97
98 void removeMessage(String id);
99
100 void initHistory();
101
102 void loadApp(String appName);
103 }
104 }