Class sap.suite.ui.commons.LaunchTileModule: sap/suite/ui/commons/LaunchTile

extends Control

This control launches a URL.

Deprecated API:Since version 1.25. Deprecated.

Constructor Summary
new sap.suite.ui.commons.LaunchTile(sId?, mSettings?)Constructor for a new LaunchTile.
Event Summary
press(oControlEvent)The event fired when the user clicks on the control.
Events borrowed from class sap.ui.core.Control
Method Summary
sap.suite.ui.commons.LaunchTile.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.suite.ui.commons.LaunchTile with name sClassName and enriches it with the information contained in oClassInfo.
sap.suite.ui.commons.LaunchTile.getMetadata()Returns a metadata object for class sap.suite.ui.commons.LaunchTile.
attachPress(oData?, fnFunction, oListener?)Attach event handler fnFunction to the 'press' event of this sap.suite.ui.commons.LaunchTile.
detachPress(fnFunction, oListener)Detach event handler fnFunction from the 'press' event of this sap.suite.ui.commons.LaunchTile.
firePress(mArguments?)Fire event press to attached listeners.
getIcon()Getter for property icon.
getLink()Getter for property link.
getTitle()Getter for property title.
setLink(sLink)Setter for property link.
setTitle(sTitle)Setter for property title.
Constructor Detail
new sap.suite.ui.commons.LaunchTile(sId?, mSettings?)
Constructor for a new LaunchTile.

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
  • 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. Deprecated.
      Event Detail
      press(oControlEvent)
      The event fired when the user clicks on the control.
      Parameters:
      {sap.ui.base.Event}oControlEvent
      {sap.ui.base.EventProvider}oControlEvent.getSource
      {object}oControlEvent.getParameters
      Method Detail
      sap.suite.ui.commons.LaunchTile.extend(sClassName, oClassInfo?, FNMetaImpl?): function
      Creates a new subclass of class sap.suite.ui.commons.LaunchTile 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.LaunchTile.getMetadata(): sap.ui.base.Metadata
      Returns a metadata object for class sap.suite.ui.commons.LaunchTile.
      Returns:
      {sap.ui.base.Metadata} Metadata object describing this class
      attachPress(oData?, fnFunction, oListener?): sap.suite.ui.commons.LaunchTile
      Attach event handler fnFunction to the 'press' event of this sap.suite.ui.commons.LaunchTile.
      . When called, the context of the event handler (its this) will be bound to oListener if specified otherwise to this sap.suite.ui.commons.LaunchTile.
      itself.

      The event fired when the user clicks on the control.

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

      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.LaunchTile}this to allow method chaining
      firePress(mArguments?): sap.suite.ui.commons.LaunchTile
      Fire event press to attached listeners.
      Parameters:
      {Map}mArguments? the arguments to pass along with the event.
      Returns:
      {sap.suite.ui.commons.LaunchTile}this to allow method chaining
      getIcon(): sap.ui.core.URI
      Getter for property icon. Icon associated with the launch destination.

      Default value is empty/undefined

      Returns:
      {sap.ui.core.URI} the value of property icon
      getLink(): sap.ui.core.URI
      Getter for property link. The launch destination.

      Default value is empty/undefined

      Returns:
      {sap.ui.core.URI} the value of property link
      getTitle(): string
      Getter for property title. Descriptive title of the launch destination.

      Default value is empty/undefined

      Returns:
      {string} the value of property title
      Setter for property link.

      Default value is empty/undefined

      Parameters:
      {sap.ui.core.URI}sLink new value for property link
      Returns:
      {sap.suite.ui.commons.LaunchTile}this to allow method chaining
      Setter for property title.

      Default value is empty/undefined

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