Class sap.ui.ux3.DataSetSimpleViewModule: sap/ui/ux3/DataSetSimpleView

extends Control
implements DataSetView

DataSetSimpleView provides a simple view example for DataSet usage.
Deprecated API:
Since version 1.38.
Constructor Summary
new sap.ui.ux3.DataSetSimpleView(sId?, mSettings?)Constructor for a new DataSetSimpleView.
Events borrowed from class sap.ui.core.Control
Method Summary
sap.ui.ux3.DataSetSimpleView.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.ux3.DataSetSimpleView with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.ux3.DataSetSimpleView.getMetadata()Returns a metadata object for class sap.ui.ux3.DataSetSimpleView.
destroyTemplate()Destroys the template in the aggregation template.
exitView(aItems)View finalization: Called when leaving the view
getFloating()Gets current value of property floating.
getHeight()Gets current value of property height.
getIcon()Gets current value of property icon.
getIconHovered()Gets current value of property iconHovered.
getIconSelected()Gets current value of property iconSelected.
getInitialItemCount()Gets current value of property initialItemCount.
getItemMinWidth()Gets current value of property itemMinWidth.
getName()Gets current value of property name.
getReloadItemCount()Gets current value of property reloadItemCount.
getResponsive()Gets current value of property responsive.
getScrollArea()Gets current value of property scrollArea.
getTemplate()Gets content of aggregation template.
handleSelection(oEvent)Eventhandler for the selection of an Item
initView(aItems)View Initialization: Called when selecting the view
isItemSelected(oItem)Check if Item oItem is selected
setFloating(bFloating)Sets a new value for property floating.
setHeight(sHeight)Sets a new value for property height.
setIcon(sIcon)Sets a new value for property icon.
setIconHovered(sIconHovered)Sets a new value for property iconHovered.
setIconSelected(sIconSelected)Sets a new value for property iconSelected.
setInitialItemCount(iInitialItemCount)Sets a new value for property initialItemCount.
setItemMinWidth(iItemMinWidth)Sets a new value for property itemMinWidth.
setName(sName)Sets a new value for property name.
setReloadItemCount(iReloadItemCount)Sets a new value for property reloadItemCount.
setResponsive(bResponsive)Sets a new value for property responsive.
setScrollArea(aScrollArea, bSupress)
setTemplate(oTemplate)Sets the aggregated template.
updateView(aDiff)View update: Called when pagination adds items
Constructor Detail
new sap.ui.ux3.DataSetSimpleView(sId?, mSettings?)

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

The supported settings are:

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
Method Detail
sap.ui.ux3.DataSetSimpleView.extend(sClassName, oClassInfo?, FNMetaImpl?): function

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.

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.ui.ux3.DataSetSimpleView.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.ux3.DataSetSimpleView.
Returns:
sap.ui.base.MetadataMetadata object describing this class
destroyTemplate(): sap.ui.ux3.DataSetSimpleView
Destroys the template in the aggregation template.
Returns:
sap.ui.ux3.DataSetSimpleViewReference to this in order to allow method chaining
exitView(aItems)
View finalization: Called when leaving the view
Parameters:
sap.ui.ux3.DataSetItem[]aItems
getFloating(): boolean

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.

Returns:
booleanValue of property floating
getHeight(): sap.ui.core.CSSSize

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.

Returns:
sap.ui.core.CSSSizeValue of property height
Since:
1.13.0
getIcon(): sap.ui.core.URI

Gets current value of property icon.

Icon source for this view

Returns:
sap.ui.core.URIValue of property icon
getIconHovered(): sap.ui.core.URI

Gets current value of property iconHovered.

icon: hovered state

Returns:
sap.ui.core.URIValue of property iconHovered
getIconSelected(): sap.ui.core.URI

Gets current value of property iconSelected.

icon: selected state

Returns:
sap.ui.core.URIValue of property iconSelected
getInitialItemCount(): int

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.

Returns:
intValue of property initialItemCount
Since:
1.13.0
getItemMinWidth(): int

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.

Returns:
intValue of property itemMinWidth
Since:
1.9.2
getName(): string

Gets current value of property name.

Name of the View

Default value is Name of this View.

Returns:
stringValue of property name
getReloadItemCount(): int

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.

Returns:
intValue of property reloadItemCount
Since:
1.13.0
getResponsive(): boolean

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.

Returns:
booleanValue of property responsive
Since:
1.9.2
getScrollArea(): any

Gets current value of property scrollArea.

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

Returns:
anyValue of property scrollArea
Since:
1.13.0
getTemplate(): sap.ui.core.Control

Gets content of aggregation template.

template

Returns:
sap.ui.core.Control
handleSelection(oEvent)
Eventhandler for the selection of an Item
Parameters:
sap.ui.base.EventoEventSelectionChanged event
initView(aItems)
View Initialization: Called when selecting the view
Parameters:
arrayaItemsArray of DataSetItems added to the parent DataSet
isItemSelected(oItem)
Check if Item oItem is selected
Parameters:
sap.ui.ux3.DataSetItemoItemDataSetItem instance
setFloating(bFloating): sap.ui.ux3.DataSetSimpleView

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.

Parameters:
booleanbFloatingNew value for property floating
Returns:
sap.ui.ux3.DataSetSimpleViewReference to this in order to allow method chaining
setHeight(sHeight): sap.ui.ux3.DataSetSimpleView

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.

Parameters:
sap.ui.core.CSSSizesHeightNew value for property height
Returns:
sap.ui.ux3.DataSetSimpleViewReference to this in order to allow method chaining
Since:
1.13.0

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.

Parameters:
sap.ui.core.URIsIconNew value for property icon
Returns:
sap.ui.ux3.DataSetSimpleViewReference to this in order to allow method chaining
setIconHovered(sIconHovered): sap.ui.ux3.DataSetSimpleView

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.

Parameters:
sap.ui.core.URIsIconHoveredNew value for property iconHovered
Returns:
sap.ui.ux3.DataSetSimpleViewReference to this in order to allow method chaining
setIconSelected(sIconSelected): sap.ui.ux3.DataSetSimpleView

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.

Parameters:
sap.ui.core.URIsIconSelectedNew value for property iconSelected
Returns:
sap.ui.ux3.DataSetSimpleViewReference to this in order to allow method chaining
setInitialItemCount(iInitialItemCount): sap.ui.ux3.DataSetSimpleView

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.

Parameters:
intiInitialItemCountNew value for property initialItemCount
Returns:
sap.ui.ux3.DataSetSimpleViewReference to this in order to allow method chaining
Since:
1.13.0
setItemMinWidth(iItemMinWidth): sap.ui.ux3.DataSetSimpleView

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.

Parameters:
intiItemMinWidthNew value for property itemMinWidth
Returns:
sap.ui.ux3.DataSetSimpleViewReference to this in order to allow method chaining
Since:
1.9.2

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.

Parameters:
stringsNameNew value for property name
Returns:
sap.ui.ux3.DataSetSimpleViewReference to this in order to allow method chaining
setReloadItemCount(iReloadItemCount): sap.ui.ux3.DataSetSimpleView

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.

Parameters:
intiReloadItemCountNew value for property reloadItemCount
Returns:
sap.ui.ux3.DataSetSimpleViewReference to this in order to allow method chaining
Since:
1.13.0
setResponsive(bResponsive): sap.ui.ux3.DataSetSimpleView

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.

Parameters:
booleanbResponsiveNew value for property responsive
Returns:
sap.ui.ux3.DataSetSimpleViewReference to this in order to allow method chaining
Since:
1.9.2
setScrollArea(aScrollArea, bSupress)
Parameters:
any[]aScrollArea
booleanbSupress
setTemplate(oTemplate): sap.ui.ux3.DataSetSimpleView
Sets the aggregated template.
Parameters:
sap.ui.core.ControloTemplateThe template to set
Returns:
sap.ui.ux3.DataSetSimpleViewReference to this in order to allow method chaining
updateView(aDiff)
View update: Called when pagination adds items
Parameters:
sap.ui.ux3.DataSetItem[]aDiffArray of DataSetItems added to the parent DataSet