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.event;
35
36 import info.magnolia.event.Event;
37 import info.magnolia.event.EventHandler;
38
39 /**
40 * This event is fired when a registered key shortcut is pressed while an item is selected (i.e. a row in the data grid within the workbench representing
41 * either a {@link javax.jcr.Node} or a {@link javax.jcr.Property}).
42 */
43 public class ItemShortcutKeyEvent implements Event<ItemShortcutKeyEvent.Handler> {
44
45 /**
46 * Handles {@link ItemShortcutKeyEvent} events.
47 */
48 public interface Handler extends EventHandler {
49
50 void onItemShortcutKeyEvent(ItemShortcutKeyEvent event);
51 }
52
53 private final Object itemIds;
54
55 private final int keyCode;
56
57 private final int[] modifierKeys;
58
59 public ItemShortcutKeyEvent(Object itemIds, int keyCode, int... modifierKeys) {
60 this.itemIds = itemIds;
61 this.keyCode = keyCode;
62 this.modifierKeys = modifierKeys;
63 }
64
65 /**
66 * @deprecated since 5.6. Use e.g. {@link info.magnolia.ui.contentapp.browser.BrowserPresenter#getSelectedItemIds()} instead.
67 */
68 @Deprecated
69 public Object getItemId() {
70 return itemIds instanceof Iterable ? ((Iterable) itemIds).iterator().next() : itemIds;
71 }
72
73 public int getKeyCode() {
74 return keyCode;
75 }
76
77 public int[] getModifierKeys() {
78 return modifierKeys;
79 }
80
81 @Override
82 public void dispatch(Handler handler) {
83 handler.onItemShortcutKeyEvent(this);
84 }
85
86 }