1 /**
2 * This file Copyright (c) 2013-2014 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
37 import info.magnolia.ui.workbench.tree.MoveLocation;
38
39 import com.vaadin.data.Item;
40
41 /**
42 * Define methods used to configure a
43 * {@link com.vaadin.event.dd.DropHandler.DropHandler}. DropConstraint
44 * implemented class are defined in the
45 * {@link info.magnolia.ui.workbench.definition.WorkbenchDefinition}, <br>
46 * and used in by {@link TreeViewDropHandler},<br>
47 * in order to configure drag and drop ability in
48 * {@link info.magnolia.ui.workbench.tree.TreeView}.
49 */
50 public interface DropConstraint {
51
52 /**
53 * Checks whether source item is allowed to be moved relative (based on the move location) to target item.
54 */
55 public boolean isAllowedAt(Item sourceItem, Item targetItem, MoveLocation location);
56
57 /**
58 * @param sourceItem
59 * Moved Item.
60 * @param targetItem
61 * Target Item .
62 * @return true if the sourceItem is allowed to be set as a child of
63 * targetItem.<br>
64 * false otherwise.
65 */
66 public boolean allowedAsChild(Item sourceItem, Item targetItem);
67
68 /**
69 * @param sourceItem
70 * Moved Item.
71 * @param targetItem
72 * Target Item .
73 * @return true if the sourceItem is allowed to be put before the
74 * targetItem.<br>
75 * false otherwise.
76 */
77 public boolean allowedBefore(Item sourceItem, Item targetItem);
78
79 /**
80 * @param sourceItem
81 * Moved Item.
82 * @param targetItem
83 * Target Item .
84 * @return true if the sourceItem is allowed to be put after the targetItem.<br>
85 * false otherwise.
86 */
87 public boolean allowedAfter(Item sourceItem, Item targetItem);
88
89 /**
90 * @return true if the Item is allowed to be moved <br>
91 * false otherwise.
92 */
93 public boolean allowedToMove(Item sourceItem);
94 }