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