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.
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 |
Name | Type | Default Value | Description |
---|---|---|---|
enabled | boolean | true | Indicates whether this configuration is active or not. |
groupName | string | Defines the name of the group to which this object belongs. If |
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. |
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. |
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, 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. Alternatively, UI5 currently does not provide a recommended implementation of See the section Using Tooltips
|
Method | Description |
---|---|
sap.ui.core.dnd.DragDropBase.extend |
Creates a new subclass of class sap.ui.core.dnd.DragDropBase with name
|
getEnabled |
Gets current value of property enabled. Indicates whether this configuration is active or not. Default value is |
getGroupName |
Gets current value of property groupName. Defines the name of the group to which this object belongs. If |
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 Default value is |
setGroupName |
Sets a new value for property groupName. Defines the name of the group to which this object belongs. If When called with a value of |
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 |
Gets current value of property enabled.
Indicates whether this configuration is active or not.
Default value is true
.
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.
Returns a metadata object for class sap.ui.core.dnd.DragDropBase.
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 |
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 |