Class sap.suite.ui.commons.TileContentModule: sap/suite/ui/commons/TileContent

extends Control

This control serves a universal container for different types of content and footer.

Deprecated API:Since version 1.34. Deprecated. Moved to openui5.

Constructor Summary
new sap.suite.ui.commons.TileContent(sId?, mSettings?)Constructor for a new TileContent.
Events borrowed from class sap.ui.core.Control
Method Summary
sap.suite.ui.commons.TileContent.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.suite.ui.commons.TileContent with name sClassName and enriches it with the information contained in oClassInfo.
sap.suite.ui.commons.TileContent.getMetadata()Returns a metadata object for class sap.suite.ui.commons.TileContent.
destroyContent()Destroys the content in the aggregation named content.
getContent()Getter for aggregation content.
getDisabled()Getter for property disabled.
getFooter()Getter for property footer.
getFrameType()Getter for property frameType.
getSize()Getter for property size.
getUnit()Getter for property unit.
setContent(oContent)Setter for the aggregated content.
setDisabled(bDisabled)Setter for property disabled.
setFooter(sFooter)Setter for property footer.
setFrameType(oFrameType)Setter for property frameType.
setSize(oSize)Setter for property size.
setUnit(sUnit)Setter for property unit.
Constructor Detail
new sap.suite.ui.commons.TileContent(sId?, mSettings?)
Constructor for a new TileContent.

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
    • footer : string
    • size : sap.suite.ui.commons.InfoTileSize (default: "Auto")
    • unit : string
    • disabled : boolean (default: false)
    • frameType : sap.suite.ui.commons.FrameType (default: sap.suite.ui.commons.FrameType.Auto)
  • Aggregations
  • Associations
    • Events
      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.34. Deprecated. Moved to openui5.
      Method Detail
      sap.suite.ui.commons.TileContent.extend(sClassName, oClassInfo?, FNMetaImpl?): function
      Creates a new subclass of class sap.suite.ui.commons.TileContent 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.TileContent.getMetadata(): sap.ui.base.Metadata
      Returns a metadata object for class sap.suite.ui.commons.TileContent.
      Returns:
      {sap.ui.base.Metadata} Metadata object describing this class
      Destroys the content in the aggregation named content.
      Returns:
      {sap.suite.ui.commons.TileContent}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}
      getDisabled(): boolean
      Getter for property disabled. Disables control if true.

      Default value is false

      Since:
      1.23
      Returns:
      {boolean} the value of property disabled
      getFooter(): string
      Getter for property footer. The footer text of the tile.

      Default value is empty/undefined

      Returns:
      {string} the value of property footer
      Getter for property frameType. The frame type: 1x1 or 2x1.

      Default value is Auto

      Since:
      1.25
      Returns:
      {sap.suite.ui.commons.FrameType} the value of property frameType
      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
      getUnit(): string
      Getter for property unit. The percent sign, the currency symbol, or the unit of measure.

      Default value is empty/undefined

      Returns:
      {string} the value of property unit
      setContent(oContent): sap.suite.ui.commons.TileContent
      Setter for the aggregated content.
      Parameters:
      {sap.ui.core.Control}oContent
      Returns:
      {sap.suite.ui.commons.TileContent}this to allow method chaining
      setDisabled(bDisabled): sap.suite.ui.commons.TileContent
      Setter for property disabled.

      Default value is false

      Parameters:
      {boolean}bDisabled new value for property disabled
      Since:
      1.23
      Returns:
      {sap.suite.ui.commons.TileContent}this to allow method chaining
      Setter for property footer.

      Default value is empty/undefined

      Parameters:
      {string}sFooter new value for property footer
      Returns:
      {sap.suite.ui.commons.TileContent}this to allow method chaining
      setFrameType(oFrameType): sap.suite.ui.commons.TileContent
      Setter for property frameType.

      Default value is Auto

      Parameters:
      {sap.suite.ui.commons.FrameType}oFrameType new value for property frameType
      Since:
      1.25
      Returns:
      {sap.suite.ui.commons.TileContent}this to allow method chaining
      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.TileContent}this to allow method chaining
      Setter for property unit.

      Default value is empty/undefined

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