1 /**
2 * This file Copyright (c) 2013-2017 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.admincentral.usermenu;
35
36 import info.magnolia.ui.api.view.View;
37
38 /**
39 * View displaying the current logged in user and providing user related actions.
40 * Allows registering actions.
41 */
42 public interface UserMenuView extends View {
43
44 void setListener(Listener listener);
45
46 /**
47 * Adds an action to the user menu with given action name as configured and label.
48 *
49 * @deprecated since 5.2.4 icons are supported in user menu so one should use {@link #addAction(String, String, String)}.
50 */
51 @Deprecated
52 void addAction(String name, String label);
53
54 /**
55 * Adds an action to the user menu with given action name as configured, label and icon.
56 */
57 void addAction(String name, String label, String icon);
58
59 void setCaption(String caption);
60
61 /**
62 * Listener callback interface for presenter.
63 */
64 interface Listener {
65 void onAction(String actionName);
66 }
67 }