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.ui.api.view.View;
37
38 import java.util.List;
39 import java.util.Set;
40
41 import com.vaadin.v7.data.Item;
42
43 /**
44 * UI component that displays content in one of the supported view types (list, tree etc).
45 */
46 public interface ContentView extends View {
47
48 void setListener(Listener listener);
49
50 /**
51 * Selects the items with given IDs in the content view.
52 *
53 * @param itemIds IDs
54 */
55 void select(List<Object> itemIds);
56
57 /**
58 * Expands an item if the view supports it.
59 *
60 * @param itemId ID
61 */
62 void expand(Object itemId);
63
64 void onShortcutKey(int keyCode, int[] modifierKeys);
65
66 /**
67 * Decides whether the user can select multiple items.
68 */
69 void setMultiselect(boolean multiselect);
70
71 /**
72 * Listener for the ContentView.
73 */
74 public interface Listener {
75
76 void onItemSelection(Set<Object> items);
77
78 void onDoubleClick(Object itemId);
79
80 void onRightClick(Object itemId, int clickX, int clickY);
81
82 void onShortcutKey(int keyCode, int... modifierKeys);
83
84 String getIcon(Item item);
85 }
86 }