View Javadoc
1   /**
2    * This file Copyright (c) 2016 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.vaadin.gwt.client.editor.event;
35  
36  import info.magnolia.ui.vaadin.gwt.client.shared.ComponentElement;
37  
38  import com.google.gwt.event.shared.GwtEvent;
39  
40  /**
41   * Event used for triggering an action.
42   */
43  public class ComponentActionEvent extends GwtEvent<ComponentActionEventHandler> {
44  
45      public static Type<ComponentActionEventHandler> TYPE = new Type<>();
46  
47      private final ComponentElement element;
48      private final String actionName;
49      private final String[] args;
50  
51      public ComponentActionEvent(String actionName, ComponentElement element, String... args) {
52          this.element = element;
53          this.actionName = actionName;
54          this.args = args;
55      }
56  
57      @Override
58      public Type<ComponentActionEventHandler> getAssociatedType() {
59          return TYPE;
60      }
61  
62      @Override
63      protected void dispatch(ComponentActionEventHandler handler) {
64          handler.onAction(this);
65      }
66  
67      public String getActionName() {
68          return actionName;
69      }
70  
71      public String[] getArgs() {
72          return args;
73      }
74  
75      public ComponentElement getElement() {
76          return element;
77      }
78  }