Abstract Class sap.m.DraftIndicatorModule: sap/m/DraftIndicator

extends Control

A draft indicator is sap.m.Label.
Since: 1.32.0.
Constructor Summary
new sap.m.DraftIndicator(sId?)Constructor for a new DraftIndicator.
Events borrowed from class sap.ui.core.Control
Method Summary
sap.m.DraftIndicator.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.m.DraftIndicator with name sClassName and enriches it with the information contained in oClassInfo.
sap.m.DraftIndicator.getMetadata()Returns a metadata object for class sap.m.DraftIndicator.
clearDraftState()Clears the indicator state
getMinDisplayTime()Gets current value of property minDisplayTime.
getState()Gets current value of property state.
setMinDisplayTime(iMinDisplayTime)Sets a new value for property minDisplayTime.
showDraftSaved()Sets the indicator in "Saved" state
showDraftSaving()Sets the indicator in "Saving.
Constructor Detail
new sap.m.DraftIndicator(sId?)

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 for a general description of the syntax of the settings object.

The supported settings are:

  • Properties

  • Aggregations

    In addition, all settings applicable to the base type sap.ui.core.Control can be used as well.

    Parameters:
    stringsId?ID for the new control, generated automatically if no ID is given
    Method Detail
    sap.m.DraftIndicator.extend(sClassName, oClassInfo?, FNMetaImpl?): function

    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.

    Parameters:
    stringsClassNameName of the class being created
    objectoClassInfo?Object literal with information about the class
    functionFNMetaImpl?Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
    Returns:
    functionCreated class / constructor function
    sap.m.DraftIndicator.getMetadata(): sap.ui.base.Metadata
    Returns a metadata object for class sap.m.DraftIndicator.
    Returns:
    sap.ui.base.MetadataMetadata object describing this class
    clearDraftState()
    Clears the indicator state
    getMinDisplayTime(): int

    Gets current value of property minDisplayTime.

    Minimum time in milliseconds for showing the draft indicator

    Default value is 1500.

    Returns:
    intValue of property minDisplayTime

    Gets current value of property state.

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

    Default value is Clear.

    Returns:
    sap.m.DraftIndicatorStateValue of property state
    setMinDisplayTime(iMinDisplayTime): sap.m.DraftIndicator

    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.

    Parameters:
    intiMinDisplayTimeNew value for property minDisplayTime
    Returns:
    sap.m.DraftIndicatorReference to this in order to allow method chaining
    showDraftSaved()
    Sets the indicator in "Saved" state
    showDraftSaving()
    Sets the indicator in "Saving..." state