1 /**
2 * This file Copyright (c) 2013-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.view.View;
37
38 /**
39 * AppView interface used for displaying apps and adding and removing the subApp views.
40 * Creates an instance id when adding a new subApp view. This is used to identify the view associated with a {@link SubAppContext}.
41 */
42 public interface AppView extends View {
43
44 void updateCaption(String instanceId, String caption);
45
46 /**
47 * Listens to events coming from the TabSheet.
48 */
49 interface Listener {
50
51 void onFocus(String instanceId);
52
53 void onClose(String instanceId);
54
55 }
56
57 void setTheme(String value);
58
59 void setAppLogo(String logo);
60
61 /**
62 * @deprecated since 6.0, use {@link #setAppLogo(String)} instead.
63 */
64 @Deprecated
65 void setAppLogo(String logo, String bgcolor);
66
67 void setAppName(String name);
68
69 void setListener(Listener listener);
70
71 String addSubAppView(View view, String caption, boolean closable);
72
73 default String addSubAppView(View view, String caption, String icon, boolean closable) {
74 return addSubAppView(view, caption, closable);
75 }
76
77 void closeSubAppView(String instanceId);
78
79 void setActiveSubAppView(String instanceId);
80
81 String getActiveSubAppView();
82
83 /**
84 * Get the view of the container of a SubApp.
85 * Enables working with the Tab component for example, which is necessary for attaching dialogs.
86 */
87 View getSubAppViewContainer(String instanceId);
88
89 default void setTabCaptionsAsHtml() {}
90 }