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
validateFieldGroup
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
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.
Methods borrowed from class sap.ui.core.Control
addStyleClass, allowTextSelection, attachBrowserEvent, attachValidateFieldGroup, checkFieldGroupIds, clone, detachBrowserEvent, detachValidateFieldGroup, fireValidateFieldGroup, getAccessibilityInfo, getBusy, getBusyIndicatorDelay, getControlsByFieldGroupId, getFieldGroupIds, getIdForLabel, getRenderer, getVisible, hasStyleClass, invalidate, isBusy, onAfterRendering, onBeforeRendering, placeAt, removeStyleClass, rerender, setBusy, setBusyIndicatorDelay, setFieldGroupIds, setVisible, toggleStyleClass, triggerValidateFieldGroup
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, data, destroy, destroyCustomData, destroyDependents, destroyLayoutData, destroyTooltip, enhanceAccessibilityState, exit, findElements, fireEvent, focus, getCustomData, getDependents, getDomRef, getElementBinding, getFocusDomRef, getFocusInfo, getInterface, getLayoutData, getMetadata, getTooltip, getTooltip_AsString, getTooltip_Text, indexOfCustomData, indexOfDependent, init, insertCustomData, insertDependent, prop, removeAllCustomData, removeAllDependents, removeCustomData, removeDependent, removeEventDelegate, setLayoutData, setTooltip, toString, unbindElement
Methods borrowed from class sap.ui.base.ManagedObject
addAggregation, addAssociation, applySettings, attachFormatError, attachModelContextChange, attachParseError, attachValidationError, attachValidationSuccess, bindAggregation, bindContext, bindObject, bindProperty, destroyAggregation, detachFormatError, detachModelContextChange, detachParseError, detachValidationError, detachValidationSuccess, findAggregatedObjects, fireFormatError, fireModelContextChange, fireParseError, fireValidationError, fireValidationSuccess, getAggregation, getAssociation, getBinding, getBindingContext, getBindingInfo, getBindingPath, getEventingParent, getId, getModel, getObjectBinding, getOriginInfo, getParent, getProperty, hasModel, indexOfAggregation, insertAggregation, isBound, isInvalidateSuppressed, isTreeBinding, propagateMessages, removeAggregation, removeAllAggregation, removeAllAssociation, removeAssociation, setAggregation, setAssociation, setBindingContext, setModel, setProperty, unbindAggregation, unbindContext, unbindObject, unbindProperty, validateAggregation, validateProperty
Methods borrowed from class sap.ui.base.EventProvider
attachEvent, attachEventOnce, detachEvent, hasListeners
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:
    {string}sId? 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:
    {string}sClassName Name of the class being created
    {object}oClassInfo? Object literal with information about the class
    {function}FNMetaImpl? Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
    Returns:
    {function} Created class / constructor function
    sap.m.DraftIndicator.getMetadata(): sap.ui.base.Metadata
    Returns a metadata object for class sap.m.DraftIndicator.
    Returns:
    {sap.ui.base.Metadata} Metadata 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:
    {int} Value of property minDisplayTime
    getState(): sap.m.DraftIndicatorState
    Gets current value of property state.

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

    Default value is Clear.

    Returns:
    {sap.m.DraftIndicatorState} Value 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:
    {int}iMinDisplayTime New value for property minDisplayTime
    Returns:
    {sap.m.DraftIndicator} Reference to this in order to allow method chaining
    showDraftSaved()
    Sets the indicator in "Saved" state
    showDraftSaving()
    Sets the indicator in "Saving..." state