class sap.m.ImageContent

Control sample: sap.m.ImageContent
Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/m/ImageContent
Application Component: CA-UI5-SC

This control can be used to display image content in a GenericTile.


Constructor

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#constructor for a general description of the syntax of the settings object.

new sap.m.ImageContent(sId?, mSettings?)
Param Type Default Value Description
sId? string

ID for the new control, generated automatically if no ID is given

mSettings? object

Initial settings for the new control


Properties

Name Type Default Value Description
description string

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

Visibility: public
src sap.ui.core.URI

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

Visibility: public

Aggregations

Default Aggregation: _content

Name Cardinality Type Description
_content (default) 0..1 sap.ui.core.Control

The hidden aggregation for the image content.


Events Overview

Event Description
press

The event is triggered when the image content is pressed.

press

The event is triggered when the image content is pressed.

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object

Methods Overview

Method Description
attachPress

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.

detachPress

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.

sap.m.ImageContent.extend

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.

firePress

Fires event press to attached listeners.

getDescription

Gets current value of property description.

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

sap.m.ImageContent.getMetadata

Returns a metadata object for class sap.m.ImageContent.

getSrc

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.

setDescription

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.

setSrc

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.

attachPress

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.

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.m.ImageContent itself

detachPress

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.

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

sap.m.ImageContent.extend

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.

Param Type DefaultValue Description
sClassName string

Name of the class being created

oClassInfo object

Object literal with information about the class

FNMetaImpl function

Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class

firePress

Fires event press to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

getDescription

Gets current value of property description.

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

sap.m.ImageContent.getMetadata

Returns a metadata object for class sap.m.ImageContent.

getSrc

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.

setDescription

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.

Param Type DefaultValue Description
sDescription string

New value for property description

setSrc

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.

Param Type DefaultValue Description
sSrc sap.ui.core.URI

New value for property src