class sap.f.dnd.GridDropInfo

Control sample: sap.f.dnd.GridDropInfo
Visiblity: public
UX Guidelines:
Implements: sap.ui.core.dnd.IDropInfo
Available since: N/A
Module: sap/f/dnd/GridDropInfo
Application Component: CA-UI5-CTR

Provides enhanced configuration for drop operations inside grid-based controls.

If drop position is Between and drop layout is Horizontal, this drop configuration will provide enhanced visualization and interaction, better suited for grid items. It will show a drop indicator which mimics the size of the dragged item and shows the potential drop position inside the grid. The indicator will push away other grid items, showing the correct arrangement calculated by the grid’s auto-placement algorithm.

When position is different than Between or layout is not Horizontal, the drag and drop will look and behave like the general sap.ui.core.dnd.DropInfo.

Note: This configuration might be ignored due to control metadata restrictions.


Constructor

Constructor for a new GridDropInfo.

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject#constructor for a general description of the syntax of the settings object.

new sap.f.dnd.GridDropInfo(sId?, mSettings?)
Param Type Default Value Description
sId? string

ID for the new DropInfo, generated automatically if no ID is given

mSettings? object

Initial settings for the GridDropInfo


Properties

Name Type Default Value Description
dropIndicatorSize function

A function which will define the desired drop indicator size. The drop indicator shows the user how the grid will rearrange after drop.

Use when custom size needs to be defined. For example when an item is dragged from outside a grid and is dropped over the grid.

If not specified or if the function returns null, the indicator size will be calculated automatically.

This callback will be called when the indicator is displayed, that happens during the drag over movement.

The callback receives draggedControl as parameter and must return an object of type {rows: , columns: } or null.

Visibility: public

Methods Overview

Method Description
sap.f.dnd.GridDropInfo.extend

Creates a new subclass of class sap.f.dnd.GridDropInfo with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.core.dnd.DropInfo.extend.

getDropIndicatorSize

Gets current value of property dropIndicatorSize.

A function which will define the desired drop indicator size. The drop indicator shows the user how the grid will rearrange after drop.

Use when custom size needs to be defined. For example when an item is dragged from outside a grid and is dropped over the grid.

If not specified or if the function returns null, the indicator size will be calculated automatically.

This callback will be called when the indicator is displayed, that happens during the drag over movement.

The callback receives draggedControl as parameter and must return an object of type {rows: , columns: } or null.

sap.f.dnd.GridDropInfo.getMetadata

Returns a metadata object for class sap.f.dnd.GridDropInfo.

setDropIndicatorSize

Sets a new value for property dropIndicatorSize.

A function which will define the desired drop indicator size. The drop indicator shows the user how the grid will rearrange after drop.

Use when custom size needs to be defined. For example when an item is dragged from outside a grid and is dropped over the grid.

If not specified or if the function returns null, the indicator size will be calculated automatically.

This callback will be called when the indicator is displayed, that happens during the drag over movement.

The callback receives draggedControl as parameter and must return an object of type {rows: , columns: } or null.

When called with a value of null or undefined, the default value of the property will be restored.

sap.f.dnd.GridDropInfo.extend

Creates a new subclass of class sap.f.dnd.GridDropInfo with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.core.dnd.DropInfo.extend.

Param Type DefaultValue Description
sClassName string

Name of the class being created

oClassInfo object

Object literal with information about the class

FNMetaImpl function

Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class

getDropIndicatorSize

Gets current value of property dropIndicatorSize.

A function which will define the desired drop indicator size. The drop indicator shows the user how the grid will rearrange after drop.

Use when custom size needs to be defined. For example when an item is dragged from outside a grid and is dropped over the grid.

If not specified or if the function returns null, the indicator size will be calculated automatically.

This callback will be called when the indicator is displayed, that happens during the drag over movement.

The callback receives draggedControl as parameter and must return an object of type {rows: , columns: } or null.

sap.f.dnd.GridDropInfo.getMetadata

Returns a metadata object for class sap.f.dnd.GridDropInfo.

setDropIndicatorSize

Sets a new value for property dropIndicatorSize.

A function which will define the desired drop indicator size. The drop indicator shows the user how the grid will rearrange after drop.

Use when custom size needs to be defined. For example when an item is dragged from outside a grid and is dropped over the grid.

If not specified or if the function returns null, the indicator size will be calculated automatically.

This callback will be called when the indicator is displayed, that happens during the drag over movement.

The callback receives draggedControl as parameter and must return an object of type {rows: , columns: } or null.

When called with a value of null or undefined, the default value of the property will be restored.

Param Type DefaultValue Description
fnDropIndicatorSize function

New value for property dropIndicatorSize