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.ui.workbench.tree.drop;
35
36 import info.magnolia.ui.workbench.tree.MoveLocation;
37
38 import com.vaadin.v7.data.Item;
39
40 /**
41 * Defines acceptance criteria for move operations.
42 *
43 * <p>A move operation may originate from drag-and-drop (see Vaadin's {@link com.vaadin.event.dd.DropHandler DropHandler})
44 * or from a move dialog (via Magnolia's {@link info.magnolia.ui.workbench.tree.MoveHandler MoveHandler}).
45 *
46 * <p>DropConstraint class is configured in the {@link info.magnolia.ui.workbench.definition.WorkbenchDefinition}.
47 */
48 public interface DropConstraint {
49
50 /**
51 * Checks whether source item is allowed to be moved relative (based on the move location) to target item.
52 */
53 public boolean isAllowedAt(Item sourceItem, Item targetItem, MoveLocation location);
54
55 /**
56 * @param sourceItem
57 * Moved Item.
58 * @param targetItem
59 * Target Item .
60 * @return true if the sourceItem is allowed to be set as a child of
61 * targetItem.<br>
62 * false otherwise.
63 */
64 public boolean allowedAsChild(Item sourceItem, Item targetItem);
65
66 /**
67 * @param sourceItem
68 * Moved Item.
69 * @param targetItem
70 * Target Item .
71 * @return true if the sourceItem is allowed to be put before the
72 * targetItem.<br>
73 * false otherwise.
74 */
75 public boolean allowedBefore(Item sourceItem, Item targetItem);
76
77 /**
78 * @param sourceItem
79 * Moved Item.
80 * @param targetItem
81 * Target Item .
82 * @return true if the sourceItem is allowed to be put after the targetItem.<br>
83 * false otherwise.
84 */
85 public boolean allowedAfter(Item sourceItem, Item targetItem);
86
87 /**
88 * @return true if the Item is allowed to be moved <br>
89 * false otherwise.
90 */
91 public boolean allowedToMove(Item sourceItem);
92 }