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