A draft indicator is sap.m.Label.
Constructor for a new DraftIndicator.
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.m.DraftIndicator(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 |
---|---|---|---|
minDisplayTime | int | 1500 | Minimum time in milliseconds for showing the draft indicator Visibility: public |
state | sap.m.DraftIndicatorState | Clear | State of the indicator. Could be "Saving", "Saved" and "Clear". Visibility: public |
Default Aggregation:
Name | Cardinality | Type | Description |
---|---|---|---|
_label | 0..1 | sap.m.Label |
The State is managed in this aggregation |
Method | Description |
---|---|
clearDraftState |
Clears the indicator state |
sap.m.DraftIndicator.extend |
Creates a new subclass of class sap.m.DraftIndicator with name
|
sap.m.DraftIndicator.getMetadata |
Returns a metadata object for class sap.m.DraftIndicator. |
getMinDisplayTime |
Gets current value of property minDisplayTime. Minimum time in milliseconds for showing the draft indicator Default value is |
getState |
Gets current value of property state. State of the indicator. Could be "Saving", "Saved" and "Clear". Default value is |
setMinDisplayTime |
Sets a new value for property minDisplayTime. Minimum time in milliseconds for showing the draft indicator When called with a value of Default value is |
setState |
Sets a new value for property state. State of the indicator. Could be "Saving", "Saved" and "Clear". When called with a value of Default value is |
showDraftSaved |
Sets the indicator in "Saved" state |
showDraftSaving |
Sets the indicator in "Saving..." state |
Creates a new subclass of class sap.m.DraftIndicator 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 |
Gets current value of property minDisplayTime.
Minimum time in milliseconds for showing the draft indicator
Default value is 1500
.
Gets current value of property state.
State of the indicator. Could be "Saving", "Saved" and "Clear".
Default value is Clear
.
Sets a new value for property minDisplayTime.
Minimum time in milliseconds for showing the draft indicator
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is 1500
.
Param | Type | DefaultValue | Description |
---|---|---|---|
iMinDisplayTime | int | 1500 |
New value for property |
Sets a new value for property state.
State of the indicator. Could be "Saving", "Saved" and "Clear".
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is Clear
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sState | sap.m.DraftIndicatorState | Clear |
New value for property |