The SmartMultiEdit.Container control provides a layout for the smart multi edit fields (sap.ui.comp.smartmultiedit.Field) it includes and enables them to access the updated binding contexts.
Constructor for a new sap.ui.comp.smartmultiedit.Container
.
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.comp.smartmultiedit.Container(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 |
---|---|---|---|
contexts | sap.ui.model.Context[] | The binding contexts relevant to this mass editing operation. Visibility: public |
|
entitySet | string | The entity set name to fetch metadata for. This entity set should have |
Default Aggregation: layout
Name | Cardinality | Type | Description |
---|---|---|---|
layout (default) | 0..1 | sap.ui.comp.smartform.SmartForm |
The form that contains smart multi edit fields (sap.ui.comp.smartmultiedit.Field controls). |
Method | Description |
---|---|
destroyLayout |
Destroys the layout in the aggregation layout. |
sap.ui.comp.smartmultiedit.Container.extend |
Creates a new subclass of class sap.ui.comp.smartmultiedit.Container with name
|
getAllUpdatedContexts |
Provides updated objects, including the values of all sap.ui.comp.smartmultiedit.Field instances in the
|
getContexts |
Gets current value of property contexts. The binding contexts relevant to this mass editing operation. Default value is |
getEntitySet |
Gets current value of property entitySet. The entity set name to fetch metadata for. This entity set should have |
getErroneousFields |
Collects all fields that have currently client errors.
Since 1.61.0 replaced by <code>getErroneousFieldsAndTokens</code>
|
getErroneousFieldsAndTokens |
Collects all fields that currently have client errors. |
getFields |
Collects all instances of sap.ui.comp.smartmultiedit.Field scattered across the smart form (sap.ui.comp.smartform.SmartForm) layout. |
getLayout |
Gets content of aggregation layout. The form that contains smart multi edit fields (sap.ui.comp.smartmultiedit.Field controls). |
sap.ui.comp.smartmultiedit.Container.getMetadata |
Returns a metadata object for class sap.ui.comp.smartmultiedit.Container. |
indexField |
Explicitly pushes the smart multi edit container's (sap.ui.comp.smartmultiedit.Container) custom data to the specified field (sap.ui.comp.smartmultiedit.Field). Can be useful when adding fields to a container after it has already been rendered. |
setContexts |
Sets the contexts to be updated. These contexts are required for offering possible values and are also used by the sap.ui.comp.smartmultiedit.Container#getAllUpdatedContexts method. |
setEntitySet |
Sets the entity set to read the properties from. Setting this value twice will not result in an update of the underlining components. |
setLayout |
Sets the layout to use. |
Creates a new subclass of class sap.ui.comp.smartmultiedit.Container 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.Control.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 |
Provides updated objects, including the values of all sap.ui.comp.smartmultiedit.Field instances in the layout
aggregation.
The function returns a Promise that is resolved when each sap.ui.model.Context in the contexts
property is copied and updated. The fulfilled function is called with an array that contains an object for each context in the contexts
property.
Each object in this array contains:
context
property that corresponds to the respective context.data
property that contains the updated data object.Param | Type | DefaultValue | Description |
---|---|---|---|
merge | boolean |
If true, the returned data structure includes all entity set properties per context. |
Gets current value of property contexts.
The binding contexts relevant to this mass editing operation.
Default value is []
.
Gets current value of property entitySet.
The entity set name to fetch metadata for. This entity set should have sap:creatable
annotation set to true
as this control needs to create an entry internally for a short period of time.
Please note that this is not a dynamic SAP UI5 property: setting it twice will not result in an update of the property.
Collects all fields that have currently client errors.
Collects all instances of sap.ui.comp.smartmultiedit.Field scattered across the smart form (sap.ui.comp.smartform.SmartForm) layout.
Gets content of aggregation layout.
The form that contains smart multi edit fields (sap.ui.comp.smartmultiedit.Field controls).
Returns a metadata object for class sap.ui.comp.smartmultiedit.Container.
Explicitly pushes the smart multi edit container's (sap.ui.comp.smartmultiedit.Container) custom data to the specified field (sap.ui.comp.smartmultiedit.Field). Can be useful when adding fields to a container after it has already been rendered.
Param | Type | DefaultValue | Description |
---|---|---|---|
oField | sap.ui.comp.smartmultiedit.Field |
sap.ui.comp.smartmultiedit.Field to push the custom data to. |
Sets the contexts to be updated. These contexts are required for offering possible values and are also used by the sap.ui.comp.smartmultiedit.Container#getAllUpdatedContexts method.
Param | Type | DefaultValue | Description |
---|---|---|---|
contexts | sap.ui.model.Context[] |
Contexts to be used. This property must be an array. |
Sets the entity set to read the properties from. Setting this value twice will not result in an update of the underlining components.
Param | Type | DefaultValue | Description |
---|---|---|---|
entitySet | string |
Entity set to use. |
Sets the layout to use.
Param | Type | DefaultValue | Description |
---|---|---|---|
oSmartForm | sap.ui.comp.smartmultiedit.Field |
Smart form with the layout. |