Class sap.m.ImageContentModule: sap/m/ImageContent

extends Control

This control can be displayed as image content in a tile.
Since: 1.38.
Constructor Summary
new sap.m.ImageContent(sId?, mSettings?)Constructor for a new sap.m.ImageContent control.
Event Summary
press(oControlEvent)The event is triggered when the image content is pressed.
Events borrowed from class sap.ui.core.Control
Method Summary
sap.m.ImageContent.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.m.ImageContent with name sClassName and enriches it with the information contained in oClassInfo.
sap.m.ImageContent.getMetadata()Returns a metadata object for class sap.m.ImageContent.
attachPress(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the press event of this sap.m.ImageContent.
detachPress(fnFunction, oListener)Detaches event handler fnFunction from the press event of this sap.m.ImageContent.
firePress(mParameters?)Fires event press to attached listeners.
getDescription()Gets current value of property description.
getSrc()Gets current value of property src.
setDescription(sDescription)Sets a new value for property description.
setSrc(sSrc)Sets a new value for property src.
Constructor Detail
new sap.m.ImageContent(sId?, mSettings?)

Constructor for a new sap.m.ImageContent control.

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

    • Events

      • press : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]

    In addition, all settings applicable to the base type sap.ui.core.Control can be used as well.

    Parameters:
    stringsId?ID for the new control, generated automatically if no ID is given
    objectmSettings?Initial settings for the new control
    Event Detail
    press(oControlEvent)
    The event is triggered when the image content is pressed.
    Parameters:
    sap.ui.base.EventoControlEvent
    sap.ui.base.EventProvideroControlEvent.getSource
    objectoControlEvent.getParameters
    Method Detail
    sap.m.ImageContent.extend(sClassName, oClassInfo?, FNMetaImpl?): function

    Creates a new subclass of class sap.m.ImageContent 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:
    stringsClassNameName of the class being created
    objectoClassInfo?Object literal with information about the class
    functionFNMetaImpl?Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
    Returns:
    functionCreated class / constructor function
    sap.m.ImageContent.getMetadata(): sap.ui.base.Metadata
    Returns a metadata object for class sap.m.ImageContent.
    Returns:
    sap.ui.base.MetadataMetadata object describing this class
    attachPress(oData?, fnFunction, oListener?): sap.m.ImageContent

    Attaches event handler fnFunction to the press event of this sap.m.ImageContent.

    When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.m.ImageContent itself.

    The event is triggered when the image content is pressed.

    Parameters:
    objectoData?An application-specific payload object that will be passed to the event handler along with the event object when firing the event
    functionfnFunctionThe function to be called when the event occurs
    objectoListener?Context object to call the event handler with. Defaults to this sap.m.ImageContent itself
    Returns:
    sap.m.ImageContentReference to this in order to allow method chaining
    detachPress(fnFunction, oListener): sap.m.ImageContent

    Detaches event handler fnFunction from the press event of this sap.m.ImageContent.

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

    Parameters:
    functionfnFunctionThe function to be called, when the event occurs
    objectoListenerContext object on which the given function had to be called
    Returns:
    sap.m.ImageContentReference to this in order to allow method chaining
    firePress(mParameters?): sap.m.ImageContent
    Fires event press to attached listeners.
    Parameters:
    objectmParameters?Parameters to pass along with the event
    Returns:
    sap.m.ImageContentReference to this in order to allow method chaining
    getDescription(): string

    Gets current value of property description.

    Description of image. This text is used to provide ScreenReader information.

    Returns:
    stringValue of property description
    getSrc(): sap.ui.core.URI

    Gets current value of property src.

    The image to be displayed as a graphical element within the imageContent. This can be an image or an icon from the icon font.

    Returns:
    sap.ui.core.URIValue of property src
    setDescription(sDescription): sap.m.ImageContent

    Sets a new value for property description.

    Description of image. This text is used to provide ScreenReader information.

    When called with a value of null or undefined, the default value of the property will be restored.

    Parameters:
    stringsDescriptionNew value for property description
    Returns:
    sap.m.ImageContentReference to this in order to allow method chaining
    setSrc(sSrc): sap.m.ImageContent

    Sets a new value for property src.

    The image to be displayed as a graphical element within the imageContent. This can be an image or an icon from the icon font.

    When called with a value of null or undefined, the default value of the property will be restored.

    Parameters:
    sap.ui.core.URIsSrcNew value for property src
    Returns:
    sap.m.ImageContentReference to this in order to allow method chaining