Class sap.suite.ui.commons.InfoTileModule: sap/suite/ui/commons/InfoTile

extends Control
known direct subclasses: ChartTile, MonitoringTile, NumericTile

The tile control that displays the title, description, footer, and customizable main area.

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

Constructor Summary
new sap.suite.ui.commons.InfoTile(sId?, mSettings?)Constructor for a new InfoTile.
Event Summary
press(oControlEvent)The event is fired when the user chooses the tile.
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.InfoTile.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.suite.ui.commons.InfoTile with name sClassName and enriches it with the information contained in oClassInfo.
sap.suite.ui.commons.InfoTile.getMetadata()Returns a metadata object for class sap.suite.ui.commons.InfoTile.
attachPress(oData?, fnFunction, oListener?)Attach event handler fnFunction to the 'press' event of this sap.suite.ui.commons.InfoTile.
destroyContent()Destroys the content in the aggregation named content.
detachPress(fnFunction, oListener)Detach event handler fnFunction from the 'press' event of this sap.suite.ui.commons.InfoTile.
firePress(mArguments?)Fire event press to attached listeners.
getContent()Getter for aggregation content.
getDescription()Getter for property description.
getFooter()Getter for property footer.
getSize()Getter for property size.
getState()Getter for property state.
getTitle()Getter for property title.
setContent(oContent)Setter for the aggregated content.
setDescription(sDescription)Setter for property description.
setFooter(sFooter)Setter for property footer.
setSize(oSize)Setter for property size.
setState(oState)Setter for property state.
setTitle(sTitle)Setter for property title.
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.InfoTile(sId?, mSettings?)
Constructor for a new InfoTile.

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
    • description : string
    • title : string
    • footer : string
    • size : sap.suite.ui.commons.InfoTileSize (default: "Auto")
    • state : sap.suite.ui.commons.LoadState (default: sap.suite.ui.commons.LoadState.Loading)
  • Aggregations
  • 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.GenericTile.
    Event Detail
    press(oControlEvent)
    The event is fired when the user chooses the tile.
    Parameters:
    {sap.ui.base.Event}oControlEvent
    {sap.ui.base.EventProvider}oControlEvent.getSource
    {object}oControlEvent.getParameters
    Method Detail
    sap.suite.ui.commons.InfoTile.extend(sClassName, oClassInfo?, FNMetaImpl?): function
    Creates a new subclass of class sap.suite.ui.commons.InfoTile 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.InfoTile.getMetadata(): sap.ui.base.Metadata
    Returns a metadata object for class sap.suite.ui.commons.InfoTile.
    Returns:
    {sap.ui.base.Metadata} Metadata object describing this class
    attachPress(oData?, fnFunction, oListener?): sap.suite.ui.commons.InfoTile
    Attach event handler fnFunction to the 'press' event of this sap.suite.ui.commons.InfoTile.
    . When called, the context of the event handler (its this) will be bound to oListener if specified otherwise to this sap.suite.ui.commons.InfoTile.
    itself.

    The event is fired when the user chooses the tile.

    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.InfoTile.
    itself.
    Returns:
    {sap.suite.ui.commons.InfoTile}this to allow method chaining
    destroyContent(): sap.suite.ui.commons.InfoTile
    Destroys the content in the aggregation named content.
    Returns:
    {sap.suite.ui.commons.InfoTile}this to allow method chaining
    detachPress(fnFunction, oListener): sap.suite.ui.commons.InfoTile
    Detach event handler fnFunction from the 'press' event of this sap.suite.ui.commons.InfoTile.

    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.InfoTile}this to allow method chaining
    firePress(mArguments?): sap.suite.ui.commons.InfoTile
    Fire event press to attached listeners.
    Parameters:
    {Map}mArguments? the arguments to pass along with the event.
    Returns:
    {sap.suite.ui.commons.InfoTile}this to allow method chaining
    getContent(): sap.ui.core.Control
    Getter for aggregation content.
    The switchable view that depends on the tile type.
    Returns:
    {sap.ui.core.Control}
    getDescription(): string
    Getter for property description. Shows the description of the selected tile.

    Default value is empty/undefined

    Returns:
    {string} the value of property description
    getFooter(): string
    Getter for property footer. The footer text of the tile.

    Default value is empty/undefined

    Returns:
    {string} the value of property footer
    getSize(): sap.suite.ui.commons.InfoTileSize
    Getter for property size. Updates the size of the tile. 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 Loading

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

    Default value is empty/undefined

    Returns:
    {string} the value of property title
    setContent(oContent): sap.suite.ui.commons.InfoTile
    Setter for the aggregated content.
    Parameters:
    {sap.ui.core.Control}oContent
    Returns:
    {sap.suite.ui.commons.InfoTile}this to allow method chaining
    setDescription(sDescription): sap.suite.ui.commons.InfoTile
    Setter for property description.

    Default value is empty/undefined

    Parameters:
    {string}sDescription new value for property description
    Returns:
    {sap.suite.ui.commons.InfoTile}this to allow method chaining
    setFooter(sFooter): sap.suite.ui.commons.InfoTile
    Setter for property footer.

    Default value is empty/undefined

    Parameters:
    {string}sFooter new value for property footer
    Returns:
    {sap.suite.ui.commons.InfoTile}this to allow method chaining
    setSize(oSize): sap.suite.ui.commons.InfoTile
    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.InfoTile}this to allow method chaining
    setState(oState): sap.suite.ui.commons.InfoTile
    Setter for property state.

    Default value is Loading

    Parameters:
    {sap.suite.ui.commons.LoadState}oState new value for property state
    Returns:
    {sap.suite.ui.commons.InfoTile}this to allow method chaining
    setTitle(sTitle): sap.suite.ui.commons.InfoTile
    Setter for property title.

    Default value is empty/undefined

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