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.vaadin.gwt.client.editor.event;
35
36 import info.magnolia.ui.vaadin.gwt.client.shared.AreaElement;
37
38 import com.google.gwt.event.shared.GwtEvent;
39
40 /**
41 * Event fired when the {@link info.magnolia.ui.vaadin.gwt.client.editor.dom.MgnlComponent} of an
42 * {@link info.magnolia.ui.vaadin.gwt.client.editor.dom.MgnlArea} should be sorted.
43 * The event will be sent to server side.
44 *
45 * fired by: {@link info.magnolia.ui.vaadin.gwt.client.editor.dom.MgnlComponent#sortComponent(info.magnolia.ui.vaadin.gwt.client.editor.dom.MgnlComponent)}
46 * handler registered in: {@link info.magnolia.ui.vaadin.gwt.client.connector.PageEditorConnector}.
47 */
48 public class SortComponentEvent extends GwtEvent<SortComponentEventHandler> {
49
50 public static Type<SortComponentEventHandler> TYPE = new Type<SortComponentEventHandler>();
51
52 private AreaElement areaElement;
53
54
55 public SortComponentEvent(AreaElement areaElement) {
56 this.areaElement = areaElement;
57 }
58
59 @Override
60 public Type<SortComponentEventHandler> getAssociatedType() {
61 return TYPE;
62 }
63
64 @Override
65 protected void dispatch(SortComponentEventHandler handler) {
66 handler.onSortComponent(this);
67 }
68
69 public AreaElement getAreaElement() {
70 return areaElement;
71 }
72
73 }