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
39 /**
40 * Main interface for apps. Apps are started and managed by the {@link AppController}.
41 *
42 * @see AppDescriptor
43 * @see AppController
44 */
45 public interface App {
46
47 /**
48 * Called when the app is started. The location passed in is the location that triggered the app to be started.
49 *
50 * @param location the location that triggered the app to be started
51 */
52 void start(Location location);
53
54 /**
55 * Called when the location changes and the app is already running.
56 *
57 * @param location the new location
58 */
59 void locationChanged(Location location);
60
61 /**
62 * Called when the user stops the app.
63 */
64 void stop();
65
66 AppView getView();
67
68 /**
69 * Open a dialog which enables a user to choose an item from the app.
70 *
71 * @param overlayLayer The layer over which the opened dialog should be presented and be modal. See Shell, {@link SubAppContext}, {@link AppContext}.
72 * @param callback
73 */
74 void openChooseDialog(UiContext overlayLayer, String selectedId, ChooseDialogCallback callback);
75
76 void openChooseDialog(UiContext uiContext, String targetTreeRootPath, String selectedId, ChooseDialogCallback callback);
77 }