DataSetSimpleView provides a simple view example for DataSet usage.
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 |
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. |
|
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" |
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. |
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. |
responsive | boolean | false | When true and the property floating is true the DatSet items are floating containers filling the whole space of a row. |
scrollArea | any | ID of the DOM Element or jQuery reference to the dom which holds the scrollbar for the dataset |
Default Aggregation:
Name | Cardinality | Type | Description |
---|---|---|---|
template | 0..1 | sap.ui.core.Control |
template |
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
|
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 Default value is |
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 |
setIcon |
Sets a new value for property icon. Icon source for this view When called with a value of |
setIconHovered |
Sets a new value for property iconHovered. icon: hovered state When called with a value of |
setIconSelected |
Sets a new value for property iconSelected. icon: selected state When called with a value of |
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 Default value is |
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 Default value is |
setName |
Sets a new value for property name. Name of the View When called with a value of Default value is |
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 Default value is |
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 Default value is |
setScrollArea | |
setTemplate |
Sets the aggregated template. |
updateView |
View update: Called when pagination adds items |
View finalization: Called when leaving the view
Param | Type | DefaultValue | Description |
---|---|---|---|
aItems | sap.ui.ux3.DataSetItem[] |
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 |
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
.
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.
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
.
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 a metadata object for class sap.ui.ux3.DataSetSimpleView.
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
.
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
.
Gets current value of property scrollArea.
ID of the DOM Element or jQuery reference to the dom which holds the scrollbar for the dataset
Eventhandler for the selection of an Item
Param | Type | DefaultValue | Description |
---|---|---|---|
oEvent | sap.ui.base.Event |
SelectionChanged event |
View Initialization: Called when selecting the view
Param | Type | DefaultValue | Description |
---|---|---|---|
aItems | array |
Array of DataSetItems added to the parent DataSet |
Check if Item oItem
is selected
Param | Type | DefaultValue | Description |
---|---|---|---|
oItem | sap.ui.ux3.DataSetItem |
DataSetItem instance |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
Sets the aggregated template.
Param | Type | DefaultValue | Description |
---|---|---|---|
oTemplate | sap.ui.core.Control |
The template to set |