Contains information about the result of an attempt to download/load a viewable.
The sap.ui.vtm.Scene.downloadCompleted and sap.ui.vtm.Scene.loadCompleted events have a results
parameter that is passed an array of sap.ui.vtm.ViewableLoadInfo objects. sap.ui.vtm.Scene#getViewableLoadInfos also returns a array of sap.ui.vtm.ViewableLoadInfo objects for all viewables that have been passed into calls to sap.ui.vtm.Scene#loadViewablesAsync.
This class is not intended to be instantiated directly by application code.
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.vtm.ViewableLoadInfo()
Name | Type | Default Value | Description |
---|---|---|---|
errorCode | string | The error code describing why the Viewable failed to load. Use when #getSucceeded returns false. Visibility: public |
|
errorText | string | The error text describing why the Viewable failed to load. This is an untranslated technical message. Use when #getSucceeded returns false. Visibility: public |
|
status | sap.ui.vtm.ViewableLoadStatus | The download/load status of the sap.ui.vtm.Viewable this sap.ui.vtm.ViewableLoadInfo relates to. Visibility: public |
|
viewable | object | The sap.ui.vtm.Viewable this sap.ui.vtm.ViewableLoadInfo relates to. Visibility: public |
Method | Description |
---|---|
sap.ui.vtm.ViewableLoadInfo.extend |
Creates a new subclass of class sap.ui.vtm.ViewableLoadInfo with name
|
getErrorCode |
Gets current value of property errorCode. The error code describing why the Viewable failed to load. Use when #getSucceeded returns false. |
getErrorText |
Gets current value of property errorText. The error text describing why the Viewable failed to load. This is an untranslated technical message. Use when #getSucceeded returns false. |
sap.ui.vtm.ViewableLoadInfo.getMetadata |
Returns a metadata object for class sap.ui.vtm.ViewableLoadInfo. |
getStatus |
Gets current value of property status. The download/load status of the sap.ui.vtm.Viewable this sap.ui.vtm.ViewableLoadInfo relates to. |
getViewable |
Gets current value of property viewable. The sap.ui.vtm.Viewable this sap.ui.vtm.ViewableLoadInfo relates to. |
setErrorCode |
Sets a new value for property errorCode. The error code describing why the Viewable failed to load. Use when #getSucceeded returns false. When called with a value of |
setErrorText |
Sets a new value for property errorText. The error text describing why the Viewable failed to load. This is an untranslated technical message. Use when #getSucceeded returns false. When called with a value of |
setStatus |
Sets a new value for property status. The download/load status of the sap.ui.vtm.Viewable this sap.ui.vtm.ViewableLoadInfo relates to. When called with a value of |
setViewable |
Sets a new value for property viewable. The sap.ui.vtm.Viewable this sap.ui.vtm.ViewableLoadInfo relates to. When called with a value of |
Creates a new subclass of class sap.ui.vtm.ViewableLoadInfo 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 errorCode.
The error code describing why the Viewable failed to load.
Use when #getSucceeded returns false.
Gets current value of property errorText.
The error text describing why the Viewable failed to load. This is an untranslated technical message. Use when #getSucceeded returns false.
Returns a metadata object for class sap.ui.vtm.ViewableLoadInfo.
Gets current value of property status.
The download/load status of the sap.ui.vtm.Viewable this sap.ui.vtm.ViewableLoadInfo relates to.
Gets current value of property viewable.
The sap.ui.vtm.Viewable this sap.ui.vtm.ViewableLoadInfo relates to.
Sets a new value for property errorCode.
The error code describing why the Viewable failed to load.
Use when #getSucceeded returns false.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sErrorCode | string |
New value for property |
Sets a new value for property errorText.
The error text describing why the Viewable failed to load. This is an untranslated technical message. Use when #getSucceeded returns false.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sErrorText | string |
New value for property |
Sets a new value for property status.
The download/load status of the sap.ui.vtm.Viewable this sap.ui.vtm.ViewableLoadInfo relates to.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sStatus | sap.ui.vtm.ViewableLoadStatus |
New value for property |
Sets a new value for property viewable.
The sap.ui.vtm.Viewable this sap.ui.vtm.ViewableLoadInfo relates to.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
oViewable | object |
New value for property |