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.pages.app.editor.event; 35 36 import info.magnolia.event.Event; 37 import info.magnolia.event.EventHandler; 38 39 /** 40 * Event to notify the system that the move has been started or stopped. 41 * Event holds contextual information about the events cause: 42 * <pre> 43 * <ul> 44 * <li>Whether it was a server or client side action causing it.</li> 45 * <li>Whether the move was stopped or started.</li> 46 * </ul> 47 * 48 * fired by: {@link info.magnolia.pages.app.action.MoveComponentAction} 49 * handler registered in: 50 * <ul> 51 * <li>{@link info.magnolia.pages.app.editor.PagesEditorSubApp#bindHandlers}</li> 52 * <li>{@link info.magnolia.pages.app.editor.PageEditorPresenter#registerHandlers}</li> 53 * </ul> 54 * </pre> 55 */ 56 public class ComponentMoveEvent implements Event<ComponentMoveEvent.Handler> { 57 58 private boolean start; 59 60 private boolean serverSide; 61 62 public ComponentMoveEvent(boolean start, boolean serverSide) { 63 this.start = start; 64 this.serverSide = serverSide; 65 } 66 67 public boolean isStart() { 68 return start; 69 } 70 71 public boolean isServerSide() { 72 return serverSide; 73 } 74 75 @Override 76 public void dispatch(Handler handler) { 77 handler.onMove(this); 78 } 79 80 /** 81 * Handler. 82 */ 83 public static interface Handler extends EventHandler { 84 void onMove(ComponentMoveEvent event); 85 } 86 87 }