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.workbench;
35
36 import info.magnolia.ui.api.view.View;
37 import info.magnolia.ui.workbench.contenttool.search.SearchContentToolPresenter;
38 import info.magnolia.ui.workbench.definition.ContentPresenterDefinition;
39
40 /**
41 * WorkbenchView.
42 */
43 public interface WorkbenchView extends View {
44 /**
45 * Listener interface for events concerning the workbench.
46 */
47 interface Listener {
48
49 void onSearchQueryChange(String searchExpression);
50
51 /**
52 * @deprecated since 5.4 - the functionality provided by this method is now a responsibility of {@link SearchContentToolPresenter}.
53 */
54 @Deprecated
55 void onSearch(String searchExpression);
56
57 void onViewTypeChanged(String viewType);
58 }
59
60 void setListener(Listener listener);
61
62 default void setTitle(String title) {
63
64 }
65
66 /**
67 * Updates the search box with given search query.
68 */
69 void setSearchQuery(String query);
70
71 /**
72 * Use this method to add sub views hosted by this view.
73 */
74 void addContentView(String type, ContentView view, ContentPresenterDefinition contentViewDefintion);
75
76 /**
77 * Use this method to add content tools.
78 */
79 void addContentTool(View view);
80
81 void setViewType(String type);
82
83 /**
84 * Use this method to add a status bar to this sub app view.
85 */
86 void setStatusBarView(StatusBarView statusBar);
87
88 default View getStatusBarView() {
89 return null;
90 }
91
92 ContentView getSelectedView();
93
94 /**
95 * Whether the user can select more items.
96 */
97 void setMultiselect(boolean multiselect);
98
99 }