Class sap.suite.ui.commons.MonitoringContentModule: sap/suite/ui/commons/MonitoringContent

extends Control

This control is used in a tile or any other place to display numeric values and an icon.

Deprecated API:Since version 1.25. This control has been deprecated in favor of new sap.suite.ui.commons.NumericContent.

Constructor Summary
new sap.suite.ui.commons.MonitoringContent(sId?, mSettings?)Constructor for a new MonitoringContent.
Event Summary
press(oControlEvent)The event is fired when the user chooses the monitoring content.
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.suite.ui.commons.MonitoringContent.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.suite.ui.commons.MonitoringContent with name sClassName and enriches it with the information contained in oClassInfo.
sap.suite.ui.commons.MonitoringContent.getMetadata()Returns a metadata object for class sap.suite.ui.commons.MonitoringContent.
attachPress(oData?, fnFunction, oListener?)Attach event handler fnFunction to the 'press' event of this sap.suite.ui.commons.MonitoringContent.
destroyIcon()Destroys the icon in the aggregation named icon.
detachPress(fnFunction, oListener)Detach event handler fnFunction from the 'press' event of this sap.suite.ui.commons.MonitoringContent.
firePress(mArguments?)Fire event press to attached listeners.
getAnimateTextChange()Getter for property animateTextChange.
getIcon()Getter for aggregation icon.
getIconSrc()Getter for property iconSrc.
getSize()Getter for property size.
getState()Getter for property state.
getValue()Getter for property value.
setAnimateTextChange(bAnimateTextChange)Setter for property animateTextChange.
setIcon(oIcon)Setter for the aggregated icon.
setIconSrc(sIconSrc)Setter for property iconSrc.
setSize(oSize)Setter for property size.
setState(oState)Setter for property state.
setValue(sValue)Setter for property value.
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.suite.ui.commons.MonitoringContent(sId?, mSettings?)
Constructor for a new MonitoringContent.

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers.

If the name of a setting is ambiguous (e.g. a property has the same name as an event), then the framework assumes property, aggregation, association, event in that order. To override this automatic resolution, one of the prefixes "aggregation:", "association:" or "event:" can be added to the name of the setting (such a prefixed name must be enclosed in single or double quotes).

The supported settings are:

  • Properties
    • value : string
    • iconSrc : string
    • size : sap.suite.ui.commons.InfoTileSize (default: sap.suite.ui.commons.InfoTileSize.Auto)
    • state : sap.suite.ui.commons.LoadState (default: sap.suite.ui.commons.LoadState.Loaded)
    • animateTextChange : boolean (default: true)
  • Aggregations
    • icon : sap.ui.core.Icon
  • Associations
    • Events
      • press : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    Parameters:
    {string}sId? id for the new control, generated automatically if no id is given
    {object}mSettings? initial settings for the new control
    Deprecated:
    Since version 1.25. This control has been deprecated in favor of new sap.suite.ui.commons.NumericContent.
    Event Detail
    press(oControlEvent)
    The event is fired when the user chooses the monitoring content.
    Parameters:
    {sap.ui.base.Event}oControlEvent
    {sap.ui.base.EventProvider}oControlEvent.getSource
    {object}oControlEvent.getParameters
    Method Detail
    sap.suite.ui.commons.MonitoringContent.extend(sClassName, oClassInfo?, FNMetaImpl?): function
    Creates a new subclass of class sap.suite.ui.commons.MonitoringContent with name sClassName and enriches it with the information contained in oClassInfo.

    oClassInfo might contain the same kind of informations as described in Element.extend.

    Parameters:
    {string}sClassName name of the class to be created
    {object}oClassInfo? object literal with informations about the class
    {function}FNMetaImpl? constructor function for the metadata object. If not given, it defaults to sap.ui.core.ElementMetadata.
    Returns:
    {function} the created class / constructor function
    sap.suite.ui.commons.MonitoringContent.getMetadata(): sap.ui.base.Metadata
    Returns a metadata object for class sap.suite.ui.commons.MonitoringContent.
    Returns:
    {sap.ui.base.Metadata} Metadata object describing this class
    attachPress(oData?, fnFunction, oListener?): sap.suite.ui.commons.MonitoringContent
    Attach event handler fnFunction to the 'press' event of this sap.suite.ui.commons.MonitoringContent.
    . When called, the context of the event handler (its this) will be bound to oListener if specified otherwise to this sap.suite.ui.commons.MonitoringContent.
    itself.

    The event is fired when the user chooses the monitoring content.

    Parameters:
    {object}oData? An application specific payload object, that will be passed to the event handler along with the event object when firing the event.
    {function}fnFunction The function to call, when the event occurs.
    {object}oListener? Context object to call the event handler with. Defaults to this sap.suite.ui.commons.MonitoringContent.
    itself.
    Returns:
    {sap.suite.ui.commons.MonitoringContent}this to allow method chaining
    destroyIcon(): sap.suite.ui.commons.MonitoringContent
    Destroys the icon in the aggregation named icon.
    Returns:
    {sap.suite.ui.commons.MonitoringContent}this to allow method chaining
    detachPress(fnFunction, oListener): sap.suite.ui.commons.MonitoringContent
    Detach event handler fnFunction from the 'press' event of this sap.suite.ui.commons.MonitoringContent.

    The passed function and listener object must match the ones used for event registration.

    Parameters:
    {function}fnFunction The function to call, when the event occurs.
    {object}oListener Context object on which the given function had to be called.
    Returns:
    {sap.suite.ui.commons.MonitoringContent}this to allow method chaining
    firePress(mArguments?): sap.suite.ui.commons.MonitoringContent
    Fire event press to attached listeners.
    Parameters:
    {Map}mArguments? the arguments to pass along with the event.
    Returns:
    {sap.suite.ui.commons.MonitoringContent}this to allow method chaining
    getAnimateTextChange(): boolean
    Getter for property animateTextChange. If set to true, changing of the value is animated.

    Default value is true

    Returns:
    {boolean} the value of property animateTextChange
    getIcon(): sap.ui.core.Icon
    Getter for aggregation icon.
    The icon that is displayed in the content.
    Returns:
    {sap.ui.core.Icon}
    getIconSrc(): string
    Getter for property iconSrc. This property is set by the return value of sap.ui.core.IconPool.getIconURI that is called with an icon name parameter and optional collection parameter. The collection parameter is required when the application extended icons are used.

    Default value is empty/undefined

    Returns:
    {string} the value of property iconSrc
    getSize(): sap.suite.ui.commons.InfoTileSize
    Getter for property size. Updates the size of the chart. If not set then the default size is applied based on the device tile.

    Default value is Auto

    Returns:
    {sap.suite.ui.commons.InfoTileSize} the value of property size
    getState(): sap.suite.ui.commons.LoadState
    Getter for property state. Indicates the load status.

    Default value is Loaded

    Returns:
    {sap.suite.ui.commons.LoadState} the value of property state
    getValue(): string
    Getter for property value. The actual value.

    Default value is empty/undefined

    Returns:
    {string} the value of property value
    setAnimateTextChange(bAnimateTextChange): sap.suite.ui.commons.MonitoringContent
    Setter for property animateTextChange.

    Default value is true

    Parameters:
    {boolean}bAnimateTextChange new value for property animateTextChange
    Returns:
    {sap.suite.ui.commons.MonitoringContent}this to allow method chaining
    setIcon(oIcon): sap.suite.ui.commons.MonitoringContent
    Setter for the aggregated icon.
    Parameters:
    {sap.ui.core.Icon}oIcon
    Returns:
    {sap.suite.ui.commons.MonitoringContent}this to allow method chaining
    setIconSrc(sIconSrc): sap.suite.ui.commons.MonitoringContent
    Setter for property iconSrc.

    Default value is empty/undefined

    Parameters:
    {string}sIconSrc new value for property iconSrc
    Returns:
    {sap.suite.ui.commons.MonitoringContent}this to allow method chaining
    setSize(oSize): sap.suite.ui.commons.MonitoringContent
    Setter for property size.

    Default value is Auto

    Parameters:
    {sap.suite.ui.commons.InfoTileSize}oSize new value for property size
    Returns:
    {sap.suite.ui.commons.MonitoringContent}this to allow method chaining
    setState(oState): sap.suite.ui.commons.MonitoringContent
    Setter for property state.

    Default value is Loaded

    Parameters:
    {sap.suite.ui.commons.LoadState}oState new value for property state
    Returns:
    {sap.suite.ui.commons.MonitoringContent}this to allow method chaining
    setValue(sValue): sap.suite.ui.commons.MonitoringContent
    Setter for property value.

    Default value is empty/undefined

    Parameters:
    {string}sValue new value for property value
    Returns:
    {sap.suite.ui.commons.MonitoringContent}this to allow method chaining