class sap.ui.ux3.DataSetSimpleView

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

DataSetSimpleView provides a simple view example for DataSet usage.


Constructor

Constructor for a new DataSetSimpleView.

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.DataSetSimpleView(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
floating boolean true

When true the DatSet items are floating containers. When set to false The Items are rendered in a 1 column Layout.

Visibility: public
height sap.ui.core.CSSSize

If the pagination feature is used without specifying a scroll area, a height for the dataset must be defined.

Since: 1.13.0.

Visibility: public
icon sap.ui.core.URI

Icon source for this view

Visibility: public
iconHovered sap.ui.core.URI

icon: hovered state

Visibility: public
iconSelected sap.ui.core.URI

icon: selected state

Visibility: public
initialItemCount int 0

If this value is greater zero only this amount of items is loaded in the first place. New items are loaded automatically when the user scrolls down. The number of items which are reloaded can be defined with the property "reloadItemCount"

Since: 1.13.0.

Visibility: public
itemMinWidth int 0

When itemMinWidth>0 and the property floating is true the given minimum width in pixels is set to DatSet items. A minimum width must be given when the property responsive is set.

Since: 1.9.2.

Visibility: public
name string Name of this View

Name of the View

Visibility: public
reloadItemCount int 0

This number defines the item count which is reloaded on scroll if initialItemCount is enabled.

Since: 1.13.0.

Visibility: public
responsive boolean false

When true and the property floating is true the DatSet items are floating containers filling the whole space of a row.

Since: 1.9.2.

Visibility: public
scrollArea any

ID of the DOM Element or jQuery reference to the dom which holds the scrollbar for the dataset

Since: 1.13.0.

Visibility: public

Aggregations

Default Aggregation:

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

template


Methods Overview

Method Description
destroyTemplate

Destroys the template in the aggregation template.

exitView

View finalization: Called when leaving the view

sap.ui.ux3.DataSetSimpleView.extend

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

getFloating

Gets current value of property floating.

When true the DatSet items are floating containers. When set to false The Items are rendered in a 1 column Layout.

Default value is true.

getHeight

Gets current value of property height.

If the pagination feature is used without specifying a scroll area, a height for the dataset must be defined.

getIcon

Gets current value of property icon.

Icon source for this view

getIconHovered

Gets current value of property iconHovered.

icon: hovered state

getIconSelected

Gets current value of property iconSelected.

icon: selected state

getInitialItemCount

Gets current value of property initialItemCount.

If this value is greater zero only this amount of items is loaded in the first place. New items are loaded automatically when the user scrolls down. The number of items which are reloaded can be defined with the property "reloadItemCount"

Default value is 0.

getItemMinWidth

Gets current value of property itemMinWidth.

When itemMinWidth>0 and the property floating is true the given minimum width in pixels is set to DatSet items. A minimum width must be given when the property responsive is set.

Default value is 0.

sap.ui.ux3.DataSetSimpleView.getMetadata

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

getName

Gets current value of property name.

Name of the View

Default value is "Name of this View".

getReloadItemCount

Gets current value of property reloadItemCount.

This number defines the item count which is reloaded on scroll if initialItemCount is enabled.

Default value is 0.

getResponsive

Gets current value of property responsive.

When true and the property floating is true the DatSet items are floating containers filling the whole space of a row.

Default value is false.

getScrollArea

Gets current value of property scrollArea.

ID of the DOM Element or jQuery reference to the dom which holds the scrollbar for the dataset

getTemplate

Gets content of aggregation template.

template

handleSelection

Eventhandler for the selection of an Item

initView

View Initialization: Called when selecting the view

isItemSelected

Check if Item oItem is selected

setFloating

Sets a new value for property floating.

When true the DatSet items are floating containers. When set to false The Items are rendered in a 1 column Layout.

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

Default value is true.

setHeight

Sets a new value for property height.

If the pagination feature is used without specifying a scroll area, a height for the dataset must be defined.

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

setIcon

Sets a new value for property icon.

Icon source for this view

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

setIconHovered

Sets a new value for property iconHovered.

icon: hovered state

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

setIconSelected

Sets a new value for property iconSelected.

icon: selected state

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

setInitialItemCount

Sets a new value for property initialItemCount.

If this value is greater zero only this amount of items is loaded in the first place. New items are loaded automatically when the user scrolls down. The number of items which are reloaded can be defined with the property "reloadItemCount"

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

Default value is 0.

setItemMinWidth

Sets a new value for property itemMinWidth.

When itemMinWidth>0 and the property floating is true the given minimum width in pixels is set to DatSet items. A minimum width must be given when the property responsive is set.

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

Default value is 0.

setName

Sets a new value for property name.

Name of the View

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

Default value is "Name of this View".

setReloadItemCount

Sets a new value for property reloadItemCount.

This number defines the item count which is reloaded on scroll if initialItemCount is enabled.

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

Default value is 0.

setResponsive

Sets a new value for property responsive.

When true and the property floating is true the DatSet items are floating containers filling the whole space of a row.

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

Default value is false.

setScrollArea
setTemplate

Sets the aggregated template.

updateView

View update: Called when pagination adds items

destroyTemplate

Destroys the template in the aggregation template.

exitView

View finalization: Called when leaving the view

Param Type DefaultValue Description
aItems sap.ui.ux3.DataSetItem[]

sap.ui.ux3.DataSetSimpleView.extend

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

getFloating

Gets current value of property floating.

When true the DatSet items are floating containers. When set to false The Items are rendered in a 1 column Layout.

Default value is true.

getHeight

Gets current value of property height.

If the pagination feature is used without specifying a scroll area, a height for the dataset must be defined.

getIcon

Gets current value of property icon.

Icon source for this view

getIconHovered

Gets current value of property iconHovered.

icon: hovered state

getIconSelected

Gets current value of property iconSelected.

icon: selected state

getInitialItemCount

Gets current value of property initialItemCount.

If this value is greater zero only this amount of items is loaded in the first place. New items are loaded automatically when the user scrolls down. The number of items which are reloaded can be defined with the property "reloadItemCount"

Default value is 0.

getItemMinWidth

Gets current value of property itemMinWidth.

When itemMinWidth>0 and the property floating is true the given minimum width in pixels is set to DatSet items. A minimum width must be given when the property responsive is set.

Default value is 0.

sap.ui.ux3.DataSetSimpleView.getMetadata

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

getName

Gets current value of property name.

Name of the View

Default value is "Name of this View".

getReloadItemCount

Gets current value of property reloadItemCount.

This number defines the item count which is reloaded on scroll if initialItemCount is enabled.

Default value is 0.

getResponsive

Gets current value of property responsive.

When true and the property floating is true the DatSet items are floating containers filling the whole space of a row.

Default value is false.

getScrollArea

Gets current value of property scrollArea.

ID of the DOM Element or jQuery reference to the dom which holds the scrollbar for the dataset

getTemplate

Gets content of aggregation template.

template

handleSelection

Eventhandler for the selection of an Item

Param Type DefaultValue Description
oEvent sap.ui.base.Event

SelectionChanged event

initView

View Initialization: Called when selecting the view

Param Type DefaultValue Description
aItems array

Array of DataSetItems added to the parent DataSet

isItemSelected

Check if Item oItem is selected

Param Type DefaultValue Description
oItem sap.ui.ux3.DataSetItem

DataSetItem instance

setFloating

Sets a new value for property floating.

When true the DatSet items are floating containers. When set to false The Items are rendered in a 1 column Layout.

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
bFloating boolean true

New value for property floating

setHeight

Sets a new value for property height.

If the pagination feature is used without specifying a scroll area, a height for the dataset must be defined.

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

Param Type DefaultValue Description
sHeight sap.ui.core.CSSSize

New value for property height

setIcon

Sets a new value for property icon.

Icon source for this view

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

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

New value for property icon

setIconHovered

Sets a new value for property iconHovered.

icon: hovered state

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

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

New value for property iconHovered

setIconSelected

Sets a new value for property iconSelected.

icon: selected state

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

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

New value for property iconSelected

setInitialItemCount

Sets a new value for property initialItemCount.

If this value is greater zero only this amount of items is loaded in the first place. New items are loaded automatically when the user scrolls down. The number of items which are reloaded can be defined with the property "reloadItemCount"

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

Default value is 0.

Param Type DefaultValue Description
iInitialItemCount int 0

New value for property initialItemCount

setItemMinWidth

Sets a new value for property itemMinWidth.

When itemMinWidth>0 and the property floating is true the given minimum width in pixels is set to DatSet items. A minimum width must be given when the property responsive is set.

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

Default value is 0.

Param Type DefaultValue Description
iItemMinWidth int 0

New value for property itemMinWidth

setName

Sets a new value for property name.

Name of the View

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

Default value is "Name of this View".

Param Type DefaultValue Description
sName string "Name of this View"

New value for property name

setReloadItemCount

Sets a new value for property reloadItemCount.

This number defines the item count which is reloaded on scroll if initialItemCount is enabled.

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

Default value is 0.

Param Type DefaultValue Description
iReloadItemCount int 0

New value for property reloadItemCount

setResponsive

Sets a new value for property responsive.

When true and the property floating is true the DatSet items are floating containers filling the whole space of a row.

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

Default value is false.

Param Type DefaultValue Description
bResponsive boolean false

New value for property responsive

setScrollArea

Param Type DefaultValue Description
aScrollArea any[]
bSupress boolean

setTemplate

Sets the aggregated template.

Param Type DefaultValue Description
oTemplate sap.ui.core.Control

The template to set

updateView

View update: Called when pagination adds items

Param Type DefaultValue Description
aDiff sap.ui.ux3.DataSetItem[]

Array of DataSetItems added to the parent DataSet