info.magnolia.ui.workbench.tree.drop

Interface DropConstraint

All Known Implementing Classes:

AlwaysTrueDropConstraint, BaseDropConstraint, GroupDropConstraint, NodesAndPropsDropConstraint, OnlyNodesDropConstraint, RoleDropConstraint, UserDropConstraint

public interface DropConstraint

Define methods used to configure a com.vaadin.event.dd.DropHandler.DropHandler. DropConstraint implemented class are defined in the WorkbenchDefinition,
and used in by TreeViewDropHandler,
in order to configure drag and drop ability in TreeView.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	allowedAfter(com.vaadin.data.Item sourceItem, com.vaadin.data.Item targetItem)
boolean	allowedAsChild(com.vaadin.data.Item sourceItem, com.vaadin.data.Item targetItem)
boolean	allowedBefore(com.vaadin.data.Item sourceItem, com.vaadin.data.Item targetItem)
boolean	allowedToMove(com.vaadin.data.Item sourceItem)
boolean	isAllowedAt(com.vaadin.data.Item sourceItem, com.vaadin.data.Item targetItem, MoveLocation location) Checks whether source item is allowed to be moved relative (based on the move location) to target item.

Method Detail

isAllowedAt

boolean isAllowedAt(com.vaadin.data.Item sourceItem,
                  com.vaadin.data.Item targetItem,
                  MoveLocation location)

Checks whether source item is allowed to be moved relative (based on the move location) to target item.

allowedAsChild

boolean allowedAsChild(com.vaadin.data.Item sourceItem,
                     com.vaadin.data.Item targetItem)

Parameters:

sourceItem - Moved Item.

targetItem - Target Item .

Returns:

true if the sourceItem is allowed to be set as a child of targetItem.
false otherwise.

allowedBefore

boolean allowedBefore(com.vaadin.data.Item sourceItem,
                    com.vaadin.data.Item targetItem)

Parameters:

sourceItem - Moved Item.

targetItem - Target Item .

Returns:

true if the sourceItem is allowed to be put before the targetItem.
false otherwise.

allowedAfter

boolean allowedAfter(com.vaadin.data.Item sourceItem,
                   com.vaadin.data.Item targetItem)

Parameters:

sourceItem - Moved Item.

targetItem - Target Item .

Returns:

true if the sourceItem is allowed to be put after the targetItem.
false otherwise.

allowedToMove

boolean allowedToMove(com.vaadin.data.Item sourceItem)

Returns:

true if the Item is allowed to be moved
false otherwise.