class sap.ui.model.CompositeDataState

Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/model/CompositeDataState
Application Component: CA-UI5-COR

Holds the status data of a composite binding.


Constructor

new sap.ui.model.CompositeDataState()

Methods Overview

Method Description
changed

Returns or sets whether the data state is changed. As long as changed was not set to false the data state is dirty and the corresponding binding will fire data state change events.

sap.ui.model.CompositeDataState.extend

Creates a new subclass of class sap.ui.model.CompositeDataState 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.model.DataState.extend.

getChanges

Returns the changes of the data state in a map that the control can use in the refreshDataState method. The changed property's name is the key in the map. Each element in the map contains an object of below structure.

   {
       oldValue : The old value of the property,
       value    : The new value of the property
   }
The map only contains the changed properties.

getControlMessages

Returns the array of state messages of the control.

getInternalProperty

Returns an array of values for the given property in the inner datastates.

getInvalidValue

Returns the dirty value of a binding that was rejected by a type validation. This value was of an incorrect type and could not be applied to the model. If the value was not rejected it will return null. In this case the current model value can be accessed using the getValue method.

getMessages

Returns the array of all state messages combining the model and control messages.

sap.ui.model.CompositeDataState.getMetadata

Returns a metadata object for class sap.ui.model.CompositeDataState.

getModelMessages

Returns the array of state messages of the model or undefined.

isControlDirty

Returns whether the data state is dirty in the UI control. A data state is dirty in the UI control if the entered value did not yet pass the type validation.

isDirty

Returns whether the data state is dirty. A data state is dirty if the value was changed but is not yet confirmed by a server or the entered value did not yet pass the type validation.

isLaundering

Returns whether the data state is in laundering. If data is send to the server the data state becomes laundering until the data was accepted or rejected.

changed

Returns or sets whether the data state is changed. As long as changed was not set to false the data state is dirty and the corresponding binding will fire data state change events.

Param Type DefaultValue Description
bNewState boolean

the optional new state

sap.ui.model.CompositeDataState.extend

Creates a new subclass of class sap.ui.model.CompositeDataState 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.model.DataState.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

getChanges

Returns the changes of the data state in a map that the control can use in the refreshDataState method. The changed property's name is the key in the map. Each element in the map contains an object of below structure.

   {
       oldValue : The old value of the property,
       value    : The new value of the property
   }
The map only contains the changed properties.

getControlMessages

Returns the array of state messages of the control.

getInternalProperty

Returns an array of values for the given property in the inner datastates.

Param Type DefaultValue Description
sProperty string

The property name

getInvalidValue

Returns the dirty value of a binding that was rejected by a type validation. This value was of an incorrect type and could not be applied to the model. If the value was not rejected it will return null. In this case the current model value can be accessed using the getValue method.

getMessages

Returns the array of all state messages combining the model and control messages.

sap.ui.model.CompositeDataState.getMetadata

Returns a metadata object for class sap.ui.model.CompositeDataState.

getModelMessages

Returns the array of state messages of the model or undefined.

isControlDirty

Returns whether the data state is dirty in the UI control. A data state is dirty in the UI control if the entered value did not yet pass the type validation.

isDirty

Returns whether the data state is dirty. A data state is dirty if the value was changed but is not yet confirmed by a server or the entered value did not yet pass the type validation.

isLaundering

Returns whether the data state is in laundering. If data is send to the server the data state becomes laundering until the data was accepted or rejected.