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.api.shell;
35
36 import info.magnolia.event.HandlerRegistration;
37 import info.magnolia.ui.api.context.UiContext;
38 import info.magnolia.ui.api.overlay.OverlayCloser;
39 import info.magnolia.ui.api.view.View;
40
41 import java.util.List;
42
43 /**
44 * Decouples the presenters and the Vaadin application. Provides methods to show messages and configuration dialogs.
45 */
46 public interface Shell extends UiContext {
47
48 void askForConfirmation(String message, ConfirmationHandler listener);
49
50 void showNotification(String message);
51
52 void showError(String message, Exception e);
53
54 String getFragment();
55
56 void setFragment(String fragment);
57
58 /**
59 * @deprecated since 6.0, no need to register fragment handling through the Shell anymore; use Vaadin's Page#addPopStateListener instead.
60 */
61 @Deprecated
62 default HandlerRegistration addFragmentChangedHandler(FragmentChangedHandler handler) {
63 throw new UnsupportedOperationException("No need to register fragment handling through the Shell anymore; use Vaadin's Page#addPopStateListener instead.");
64 }
65
66 /**
67 * @deprecated since 6.0 app registration is no longer performed through the {@link Shell} interface.
68 */
69 @Deprecated
70 default void registerApps(List<String> appNames) {
71 throw new UnsupportedOperationException("App registration is no longer performed through the Shell interface");
72 }
73
74 /**
75 * @deprecated since 6.0; was never used.
76 */
77 @Deprecated
78 default void pushToClient() {
79 throw new UnsupportedOperationException("was never implemented");
80 }
81
82 /**
83 * @deprecated since 6.0 legacy full-screen mode is no longer supported.
84 */
85 @Deprecated
86 default void enterFullScreenMode() {
87 throw new UnsupportedOperationException("legacy full-screen mode is no longer supported.");
88 }
89
90 /**
91 * @deprecated since 6.0 legacy full-screen mode is no longer supported.
92 */
93 @Deprecated
94 default void exitFullScreenMode() {
95 throw new UnsupportedOperationException("legacy full-screen mode is no longer supported.");
96 }
97
98 /**
99 * Open an Overlay on top of a specific View.
100 *
101 * @param view
102 * View to be displayed over the view.
103 * @param parent
104 * The View to open the Overlay on top of.
105 *
106 * @deprecated since 6.1, overlays are no longer bound to specific views.
107 */
108 @Deprecated
109 default OverlayCloser openOverlayOnView(Viewhref="../../../../../info/magnolia/ui/api/view/View.html#View">View view, View parent, ModalityDomain modalityLocation, ModalityLevel modalityLevel) {
110 throw new UnsupportedOperationException("overlays are no longer bound to specific views.");
111 }
112
113 /**
114 * @deprecated since 6.0 user menu is no longer provided through the {@link Shell} interface.
115 */
116 @Deprecated
117 default void setUserMenu(View view) {
118 throw new UnsupportedOperationException("user menu is no longer provided through the Shell interface.");
119 }
120
121 /**
122 * @deprecated since 6.0 environment info sticker is no longer provided through the {@link Shell} interface.
123 */
124 @Deprecated
125 default void setStickerView(View view) {
126 throw new UnsupportedOperationException("environment info sticker is no longer provided through the Shell interface.");
127 }
128 }