abstract class sap.ui.core.dnd.DragDropBase

Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/core/dnd/DragDropBase
Application Component: CA-UI5-TBL

Provides the base class for all drag-and-drop configurations. This feature enables a native HTML5 drag-and-drop API for the controls, therefore it is limited to browser support.

Restrictions


Constructor

Constructor for a new DragDropBase.

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.ui.core.dnd.DragDropBase(sId?, mSettings?)
Param Type Default Value Description
sId? string

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

mSettings? object

Initial settings for the new control


Properties

Name Type Default Value Description
enabled boolean true

Indicates whether this configuration is active or not.

Since: 1.56.

Visibility: public
groupName string

Defines the name of the group to which this object belongs. If groupName is specified, then this object will only interacts with other drag-and-drop objects within the same group.

Visibility: public

Borrowed Aggregations

Name Cardinality Type Description
customData 0..n sap.ui.core.CustomData

Custom Data, a data structure like a map containing arbitrary key value pairs.

dependents 0..n sap.ui.core.Element

Dependents are not rendered, but their databinding context and lifecycle are bound to the aggregating Element.

Since: 1.19.

dragDropConfig 0..n sap.ui.core.dnd.DragDropBase

Defines the drag-and-drop configuration. Note: This configuration might be ignored due to control metadata restrictions.

Since: 1.56.

layoutData 0..1 sap.ui.core.LayoutData

Defines the layout constraints for this control when it is used inside a Layout. LayoutData classes are typed classes and must match the embedding Layout. See VariantLayoutData for aggregating multiple alternative LayoutData instances to a single Element.

tooltip 0..1 sap.ui.core.TooltipBase

The tooltip that should be shown for this Element.

In the most simple case, a tooltip is a string that will be rendered by the control and displayed by the browser when the mouse pointer hovers over the control's DOM. In this variant, tooltip behaves like a simple control property.

Controls need to explicitly support this kind of tooltip as they have to render it, but most controls do. Exceptions will be documented for the corresponding controls (e.g. sap.ui.core.HTML does not support tooltips).

Alternatively, tooltip can act like a 0..1 aggregation and can be set to a tooltip control (an instance of a subclass of sap.ui.core.TooltipBase). In that case, the framework will take care of rendering the tooltip control in a popup-like manner. Such a tooltip control can display arbitrary content, not only a string.

UI5 currently does not provide a recommended implementation of TooltipBase as the use of content-rich tooltips is discouraged by the Fiori Design Guidelines. Existing subclasses of TooltipBase therefore have been deprecated. However, apps can still subclass from TooltipBase and create their own implementation when needed (potentially taking the deprecated implementations as a starting point).

See the section Using Tooltips in the Fiori Design Guideline.


Methods Overview

Method Description
sap.ui.core.dnd.DragDropBase.extend

Creates a new subclass of class sap.ui.core.dnd.DragDropBase 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.Element.extend.

getEnabled

Gets current value of property enabled.

Indicates whether this configuration is active or not.

Default value is true.

getGroupName

Gets current value of property groupName.

Defines the name of the group to which this object belongs. If groupName is specified, then this object will only interacts with other drag-and-drop objects within the same group.

sap.ui.core.dnd.DragDropBase.getMetadata

Returns a metadata object for class sap.ui.core.dnd.DragDropBase.

setEnabled

Sets a new value for property enabled.

Indicates whether this configuration is active or not.

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

Default value is true.

setGroupName

Sets a new value for property groupName.

Defines the name of the group to which this object belongs. If groupName is specified, then this object will only interacts with other drag-and-drop objects within the same group.

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

sap.ui.core.dnd.DragDropBase.extend

Creates a new subclass of class sap.ui.core.dnd.DragDropBase 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.Element.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

getEnabled

Gets current value of property enabled.

Indicates whether this configuration is active or not.

Default value is true.

getGroupName

Gets current value of property groupName.

Defines the name of the group to which this object belongs. If groupName is specified, then this object will only interacts with other drag-and-drop objects within the same group.

sap.ui.core.dnd.DragDropBase.getMetadata

Returns a metadata object for class sap.ui.core.dnd.DragDropBase.

setEnabled

Sets a new value for property enabled.

Indicates whether this configuration is active or not.

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

Default value is true.

Param Type DefaultValue Description
bEnabled boolean true

New value for property enabled

setGroupName

Sets a new value for property groupName.

Defines the name of the group to which this object belongs. If groupName is specified, then this object will only interacts with other drag-and-drop objects within the same group.

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

Param Type DefaultValue Description
sGroupName string

New value for property groupName