1 /**
2 * This file Copyright (c) 2013-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 com.google.gwt.event.shared.EventHandler;
37 import com.google.gwt.event.shared.GwtEvent;
38
39 /**
40 * Event used to notify the system, that a move has started. Not used for DnD events.
41 * Initiated by a client side move, when clicking on the move button on the {@link info.magnolia.ui.vaadin.gwt.client.widget.controlbar.ComponentBar}.
42 * The event will cause a server round trip to notify the server which will in return start the move on client side.
43 *
44 * @see info.magnolia.ui.vaadin.gwt.client.rpc.PageEditorClientRpc
45 * <pre>
46 * <ul>
47 * <li>fired by {@link info.magnolia.ui.vaadin.gwt.client.editor.dom.MgnlComponent#onMoveStart(boolean)}</li>
48 * <li>handled by {@link info.magnolia.ui.vaadin.gwt.client.connector.PageEditorConnector}</li>
49 * </ul>
50 * </pre>
51 */
52 public class ComponentStartMoveEvent extends GwtEvent<ComponentStartMoveEvent.CompnentStartMoveEventHandler> {
53
54 public static Type<CompnentStartMoveEventHandler> TYPE = new Type<CompnentStartMoveEventHandler>();
55
56 @Override
57 public Type<CompnentStartMoveEventHandler> getAssociatedType() {
58 return TYPE;
59 }
60
61 @Override
62 protected void dispatch(CompnentStartMoveEventHandler handler) {
63 handler.onStart(this);
64 }
65
66 /**
67 * Handler for {@link ComponentStartMoveEvent}.
68 */
69 public static interface CompnentStartMoveEventHandler extends EventHandler {
70 void onStart(ComponentStartMoveEvent componentStartMoveEvent);
71 }
72 }