apple.uikit.protocol

Interface UITableViewDragDelegate

public interface UITableViewDragDelegate

_______________________________________________________________________________________________________________ Drag & Drop

Method Summary

Modifier and Type	Method and Description
default UIDragPreviewParameters	tableViewDragPreviewParametersForRowAtIndexPath(UITableView tableView, NSIndexPath indexPath) Allows customization of the preview used for the row when it is lifted or if the drag cancels.
default boolean	tableViewDragSessionAllowsMoveOperation(UITableView tableView, UIDragSession session) Controls whether move operations are allowed for the drag session.
default void	tableViewDragSessionDidEnd(UITableView tableView, UIDragSession session) Called to signal the end of the drag session.
default boolean	tableViewDragSessionIsRestrictedToDraggingApplication(UITableView tableView, UIDragSession session) Controls whether the drag session is restricted to the source application.
default void	tableViewDragSessionWillBegin(UITableView tableView, UIDragSession session) Called after the lift animation has completed to signal the start of a drag session.
default NSArray<? extends UIDragItem>	tableViewItemsForAddingToDragSessionAtIndexPathPoint(UITableView tableView, UIDragSession session, NSIndexPath indexPath, CGPoint point) Called to request items to add to an existing drag session in response to the add item gesture.
NSArray<? extends UIDragItem>	tableViewItemsForBeginningDragSessionAtIndexPath(UITableView tableView, UIDragSession session, NSIndexPath indexPath) Provide items to begin a drag associated with a given index path.

Method Detail

tableViewDragPreviewParametersForRowAtIndexPath

default UIDragPreviewParameters tableViewDragPreviewParametersForRowAtIndexPath(UITableView tableView,
                                                                                NSIndexPath indexPath)

Allows customization of the preview used for the row when it is lifted or if the drag cancels. If not implemented or if nil is returned, the entire cell will be used for the preview.

tableViewDragSessionAllowsMoveOperation

default boolean tableViewDragSessionAllowsMoveOperation(UITableView tableView,
                                                        UIDragSession session)

Controls whether move operations are allowed for the drag session. If not implemented, defaults to YES.

tableViewDragSessionDidEnd

default void tableViewDragSessionDidEnd(UITableView tableView,
                                        UIDragSession session)

Called to signal the end of the drag session.

tableViewDragSessionIsRestrictedToDraggingApplication

default boolean tableViewDragSessionIsRestrictedToDraggingApplication(UITableView tableView,
                                                                      UIDragSession session)

Controls whether the drag session is restricted to the source application. If not implemented, defaults to NO.

tableViewDragSessionWillBegin

default void tableViewDragSessionWillBegin(UITableView tableView,
                                           UIDragSession session)

Called after the lift animation has completed to signal the start of a drag session. This call will always be balanced with a corresponding call to -tableView:dragSessionDidEnd:

tableViewItemsForAddingToDragSessionAtIndexPathPoint

default NSArray<? extends UIDragItem> tableViewItemsForAddingToDragSessionAtIndexPathPoint(UITableView tableView,
                                                                                           UIDragSession session,
                                                                                           NSIndexPath indexPath,
                                                                                           CGPoint point)

Called to request items to add to an existing drag session in response to the add item gesture. You can use the provided point (in the table view's coordinate space) to do additional hit testing if desired. If not implemented, or if an empty array is returned, no items will be added to the drag and the gesture will be handled normally.

tableViewItemsForBeginningDragSessionAtIndexPath

NSArray<? extends UIDragItem> tableViewItemsForBeginningDragSessionAtIndexPath(UITableView tableView,
                                                                               UIDragSession session,
                                                                               NSIndexPath indexPath)

Provide items to begin a drag associated with a given index path. You can use -[session locationInView:] to do additional hit testing if desired. If an empty array is returned a drag session will not begin.