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.workbench.event;
35
36 import info.magnolia.event.Event;
37 import info.magnolia.event.EventHandler;
38
39 import java.io.Serializable;
40 import java.util.HashSet;
41 import java.util.Set;
42
43 /**
44 * Event fired when the inplace editing field value was edited.
45 */
46 public class ActionEvent implements Event<ActionEvent.Handler> {
47
48 private final String actionName;
49 private final Set<Object> itemIds = new HashSet<Object>();
50 private final Object[] parameters;
51
52 /**
53 * Instantiates a new item edited event.
54 *
55 * @param actionName the action name
56 * @param itemId the item id
57 * @param parameters the parameters
58 */
59 public ActionEvent(String actionName, Object itemId, Object... parameters) {
60 this.actionName = actionName;
61 this.itemIds.add(itemId);
62 this.parameters = parameters;
63 }
64
65 /**
66 * Instantiates a new item edited event.
67 *
68 * @param actionName the action name
69 * @param itemIds the item ids
70 * @param parameters the parameters
71 */
72 public ActionEvent(String actionName, Set<Object> itemIds, Object... parameters) {
73 this.actionName = actionName;
74 this.itemIds.addAll(itemIds);
75 this.parameters = parameters;
76 }
77
78 /**
79 * @return the actionName
80 */
81 public String getActionName() {
82 return actionName;
83 }
84
85 /**
86 * @return the itemId
87 */
88 public Set<Object> getItemIds() {
89 return itemIds;
90 }
91
92 /**
93 * @return the parameters
94 */
95 public Object[] getParameters() {
96 return parameters;
97 }
98
99 /**
100 * Event listener that should react to item edited events.
101 */
102 public interface Handler extends EventHandler {
103
104 void onAction(ActionEvent event);
105 }
106
107 /**
108 * Event notifier that should register item edited events.
109 */
110 public interface Notifier extends Serializable {
111
112 void addActionListener(Handler listener);
113
114 void removeActionListener(Handler listener);
115 }
116
117 @Override
118 public void dispatch(Handler handler) {
119 handler.onAction(this);
120 }
121 }