1 /**
2 * This file Copyright (c) 2012-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.actionbar;
35
36 import info.magnolia.ui.api.view.View;
37 import info.magnolia.ui.vaadin.gwt.client.actionbar.shared.ActionbarItem;
38
39 import com.vaadin.server.Resource;
40
41 /**
42 * Base interface for an action bar view.
43 */
44 public interface ActionbarView extends View {
45
46 void setListener(Listener listener);
47
48 void addSection(String sectionName, String label);
49
50 void removeSection(String sectionName);
51
52 void setPreview(final Resource previewResource);
53
54 void addAction(ActionbarItem action, String sectionName);
55
56 void removeAction(String actionName);
57
58
59 // ENABLE / DISABLE
60 void setActionEnabled(String actionName, boolean isEnabled);
61
62 void setActionEnabled(String actionName, String sectionName, boolean isEnabled);
63
64 void setGroupEnabled(String groupName, boolean isEnabled);
65
66 void setGroupEnabled(String groupName, String sectionName, boolean isEnabled);
67
68 // SHOW / HIDE SECTIONS
69 void setSectionVisible(String sectionName, boolean isVisible);
70
71 boolean isSectionVisible(String sectionName);
72
73 void setOpen(boolean isOpen);
74
75 /**
76 * Base interface for an action bar listener.
77 */
78 interface Listener {
79
80 /**
81 * Event handler invoked on clicking an item in the action bar.
82 *
83 * @param actionToken the action token
84 */
85 void onActionbarItemClicked(String actionToken);
86 }
87 }