1 /**
2 * This file Copyright (c) 2012-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.app;
35
36 import info.magnolia.ui.api.context.UiContext;
37 import info.magnolia.ui.api.location.Location;
38 import info.magnolia.ui.api.view.Viewport;
39
40 import java.util.Map;
41 import java.util.Optional;
42
43 /**
44 * Controls all {@link App}s running for a single user. It takes care of starting, stopping and switching to already running apps.
45 */
46 public interface AppController {
47
48 boolean isAppStarted(String name);
49
50 void stopApp(String name);
51
52 void stopCurrentApp();
53
54 void focusCurrentApp();
55
56 /**
57 * Return instance controller of the app currently visible to the user.
58 */
59 Optional<AppContext> getCurrentAppContext();
60
61 /**
62 * Return the list of all running apps.
63 */
64 Map<String, AppContext> getRunningApps();
65
66 void setViewport(Viewport viewport);
67
68 /**
69 * @deprecated since 6.2.2 - use {@link #getCurrentAppContext} in conjunction with {@link AppContext#getApp()} instead.
70 */
71 @Deprecated
72 App getCurrentApp();
73
74 /**
75 * @deprecated since 6.2.2 - use {@link #getCurrentAppContext} in conjunction with {@link AppContext#getCurrentLocation()} instead.
76 */
77 @Deprecated
78 Location getCurrentAppLocation();
79
80 /**
81 * @deprecated since 6.2.2 - use {@link #getRunningApps()} in conjunction with {@link AppContext#getCurrentLocation()} ()} instead.
82 */
83 @Deprecated
84 Location getAppLocation(String name);
85
86 /**
87 * @deprecated since 6.2.2 - use {@link info.magnolia.ui.framework.overlay.ChooserController} instead.
88 *
89 * @see <a href="https://documentation.magnolia-cms.com/display/DOCS62/Upgrading+to+Magnolia+6.2.x">Upgrading to Magnolia 6.2.x</a>
90 */
91 @Deprecated
92 void openChooseDialog(String appName, UiContext uiContext, String selectedId, ChooseDialogCallback callback);
93
94 /**
95 * @deprecated since 6.2.2 - use {@link info.magnolia.ui.framework.overlay.ChooserController} instead.
96 *
97 * @see <a href="https://documentation.magnolia-cms.com/display/DOCS62/Upgrading+to+Magnolia+6.2.x">Upgrading to Magnolia 6.2.x</a>
98 */
99 @Deprecated
100 void openChooseDialog(String appName, UiContext uiContext, String targetTreeRootPath, String selectedId, ChooseDialogCallback callback);
101 }