1 /**
2 * This file Copyright (c) 2011-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.event.EventBus;
37 import info.magnolia.ui.vaadin.integration.contentconnector.ContentConnector;
38 import info.magnolia.ui.workbench.definition.ContentPresenterDefinition;
39 import info.magnolia.ui.workbench.definition.WorkbenchDefinition;
40
41 import java.util.List;
42
43 /**
44 * The ContentPresenter is the presenter class for a {@link ContentView}, it represents a view type in the workbench.
45 * Magnolia provides default implementations of this interface for displaying data as a tree, list or thumbnails.<br>
46 * <br>
47 * Implementations of this interface are responsible for configuring and populating content views according to a workbench definition (defines e.g. workspace, node-types).<br>
48 * <br>
49 * Content presenters are configured using the <code>implentationClass</code> property of a {@link ContentPresenterDefinition},
50 * and by registering such definition in the workbench's contentViews node in configuration.
51 */
52 public interface ContentPresenter {
53
54 /**
55 * Initializes the presenter with the workbench definition, eventBus and viewType name.
56 *
57 * @param workbenchDefinition the workbench definition that defines which data to present
58 * @param eventBus the event bus to fire e.g. selection events on
59 * @param viewTypeName the view type as defined in the presenter definition
60 * @param contentConnector
61 * @return the content view
62 */
63 ContentView start(WorkbenchDefinition workbenchDefinition, EventBus eventBus, String viewTypeName, ContentConnector contentConnector);
64
65 /**
66 * Refreshes the data container and view.
67 */
68 void refresh();
69
70 /**
71 * @return the selected item ids in the content view.
72 */
73 List<Object> getSelectedItemIds();
74
75 /**
76 * Sets the selected item ids for this presenter to react on, e.g. with keyboard shortcuts.
77 */
78 void setSelectedItemIds(List<Object> itemId);
79
80 /**
81 * Selects the given items in the content view.
82 */
83 void select(List<Object> itemIds);
84
85 /**
86 * Make sure the given items are visible in the content view.
87 *
88 * @param itemId
89 */
90 void expand(Object itemId);
91 }