abstract class sap.m.DraftIndicator

Control sample: sap.m.DraftIndicator
Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/m/DraftIndicator
Application Component: CA-UI5-CTR

A draft indicator is sap.m.Label.


Constructor

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


Properties

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

Aggregations

Default Aggregation:

Name Cardinality Type Description
_label 0..1 sap.m.Label

The State is managed in this aggregation


Methods Overview

Method Description
clearDraftState

Clears the indicator state

sap.m.DraftIndicator.extend

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.

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 1500.

getState

Gets current value of property state.

State of the indicator. Could be "Saving", "Saved" and "Clear".

Default value is Clear.

setMinDisplayTime

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.

setState

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.

showDraftSaved

Sets the indicator in "Saved" state

showDraftSaving

Sets the indicator in "Saving..." state

clearDraftState

Clears the indicator state

sap.m.DraftIndicator.extend

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

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 1500.

getState

Gets current value of property state.

State of the indicator. Could be "Saving", "Saved" and "Clear".

Default value is Clear.

setMinDisplayTime

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 minDisplayTime

setState

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 state

showDraftSaved

Sets the indicator in "Saved" state

showDraftSaving

Sets the indicator in "Saving..." state