class sap.ui.ux3.DataSetItem

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

DataSet Item


Constructor

Constructor for a new DataSetItem.

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.ui.ux3.DataSetItem(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
checkable boolean true

checkable

Visibility: public
iconSrc sap.ui.core.URI

image

Visibility: public
subtitle string Subtitle

subtitle

Visibility: public
title string Title

title

Visibility: public

Aggregations

Default Aggregation:

Name Cardinality Type Description
_template 0..1 sap.ui.core.Control

The template control currently aggregated by this item and managed by the DataSet


Events Overview

Event Description
selected

Event Fired when Datset item is selected.

selected

Event Fired when Datset item is selected.

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

Id of the selected Datset item


Methods Overview

Method Description
attachSelected

Attaches event handler fnFunction to the selected event of this sap.ui.ux3.DataSetItem.

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.ui.ux3.DataSetItem itself.

Event Fired when Datset item is selected.

detachSelected

Detaches event handler fnFunction from the selected event of this sap.ui.ux3.DataSetItem.

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

sap.ui.ux3.DataSetItem.extend

Creates a new subclass of class sap.ui.ux3.DataSetItem 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.

fireSelected

Fires event selected to attached listeners.

getCheckable

Gets current value of property checkable.

checkable

Default value is true.

getIconSrc

Gets current value of property iconSrc.

image

sap.ui.ux3.DataSetItem.getMetadata

Returns a metadata object for class sap.ui.ux3.DataSetItem.

getSubtitle

Gets current value of property subtitle.

subtitle

Default value is 'Subtitle'.

getTitle

Gets current value of property title.

title

Default value is 'Title'.

setCheckable

Sets a new value for property checkable.

checkable

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

Default value is true.

setIconSrc

Sets a new value for property iconSrc.

image

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

setSubtitle

Sets a new value for property subtitle.

subtitle

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

Default value is 'Subtitle'.

setTitle

Sets a new value for property title.

title

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

Default value is 'Title'.

attachSelected

Attaches event handler fnFunction to the selected event of this sap.ui.ux3.DataSetItem.

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.ui.ux3.DataSetItem itself.

Event Fired when Datset item is selected.

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.ui.ux3.DataSetItem itself

detachSelected

Detaches event handler fnFunction from the selected event of this sap.ui.ux3.DataSetItem.

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.ui.ux3.DataSetItem.extend

Creates a new subclass of class sap.ui.ux3.DataSetItem 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

fireSelected

Fires event selected to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

itemId string

Id of the selected Datset item

getCheckable

Gets current value of property checkable.

checkable

Default value is true.

getIconSrc

Gets current value of property iconSrc.

image

sap.ui.ux3.DataSetItem.getMetadata

Returns a metadata object for class sap.ui.ux3.DataSetItem.

getSubtitle

Gets current value of property subtitle.

subtitle

Default value is 'Subtitle'.

getTitle

Gets current value of property title.

title

Default value is 'Title'.

setCheckable

Sets a new value for property checkable.

checkable

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

Default value is true.

Param Type DefaultValue Description
bCheckable boolean true

New value for property checkable

setIconSrc

Sets a new value for property iconSrc.

image

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

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

New value for property iconSrc

setSubtitle

Sets a new value for property subtitle.

subtitle

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

Default value is 'Subtitle'.

Param Type DefaultValue Description
sSubtitle string 'Subtitle'

New value for property subtitle

setTitle

Sets a new value for property title.

title

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

Default value is 'Title'.

Param Type DefaultValue Description
sTitle string 'Title'

New value for property title