class sap.m.LightBoxItem

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

Represents an item which is displayed within an sap.m.LightBox. This item holds all properties of the image as well as the title and subtitle.


Constructor

Constructor for a new LightBoxItem.

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.LightBoxItem(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
alt string empty string

Alt value for the image.

Visibility: public
imageSrc sap.ui.core.URI empty string

Source for the image. This property is mandatory. If not set the popup will not open.

Visibility: public
subtitle string empty string

Subtitle text for the image.

Visibility: public
title string empty string

Title text for the image. This property is mandatory.

Visibility: public

Aggregations

Default Aggregation:

Name Cardinality Type Description
_image 0..1 sap.m.Image

The image aggregation inside the LightBoxItem control.

_subtitle 0..1 sap.m.Label

The subtitle aggregation inside the LightBoxItem control.

_title 0..1 sap.m.Title

The title aggregation inside the LightBoxItem control.


Methods Overview

Method Description
sap.m.LightBoxItem.extend

Creates a new subclass of class sap.m.LightBoxItem 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.Element.extend.

getAlt

Gets current value of property alt.

Alt value for the image.

Default value is empty string.

getImageSrc

Gets current value of property imageSrc.

Source for the image. This property is mandatory. If not set the popup will not open.

Default value is empty string.

sap.m.LightBoxItem.getMetadata

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

getSubtitle

Gets current value of property subtitle.

Subtitle text for the image.

Default value is empty string.

getTitle

Gets current value of property title.

Title text for the image. This property is mandatory.

Default value is empty string.

setAlt

Sets the alt text of the image.

setImageSrc

Sets the source of the image.

setSubtitle

Sets the subtitle of the image.

setTitle

Sets the title of the image.

sap.m.LightBoxItem.extend

Creates a new subclass of class sap.m.LightBoxItem 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.Element.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

getAlt

Gets current value of property alt.

Alt value for the image.

Default value is empty string.

getImageSrc

Gets current value of property imageSrc.

Source for the image. This property is mandatory. If not set the popup will not open.

Default value is empty string.

sap.m.LightBoxItem.getMetadata

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

getSubtitle

Gets current value of property subtitle.

Subtitle text for the image.

Default value is empty string.

getTitle

Gets current value of property title.

Title text for the image. This property is mandatory.

Default value is empty string.

setAlt

Sets the alt text of the image.

Param Type DefaultValue Description
alt string

The alt text

setImageSrc

Sets the source of the image.

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

The image URI

setSubtitle

Sets the subtitle of the image.

Param Type DefaultValue Description
subtitleText string

The image subtitle

setTitle

Sets the title of the image.

Param Type DefaultValue Description
title string

The image title