sap.apb.SuperList class

SuperList control

Version: 1.0

Syntax

new SuperList( [sId], [mSettings] )

Constructor for a new SuperList. Accepts an object literal <code>mSettings</code> that defines initial property values, aggregated and associated objects as well as event handlers. If the name of a setting is ambiguous (e.g. a property has the same name as an event), then the framework assumes property, aggregation, association, event in that order. To override this automatic resolution, one of the prefixes "aggregation:", "association:" or "event:" can be added to the name of the setting (such a prefixed name must be enclosed in single or double quotes). The supported settings are:
  • Properties
    • #getDataSource dataSource : string
    • height : sap.ui.core.CSSSize (default: '100%')
    • #getMetadataFile metadataFile : sap.ui.core.URI
    • #getWidth width : sap.ui.core.CSSSize (default: '100%')
    • #getReadRows readRows : string (default: '200')
  • Aggregations
  • Associations
  • Events
    • sap.apb.SuperList#event:dataTableQuery dataTableQuery : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • sap.apb.SuperList#event:rowFocusChanged rowFocusChanged : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • sap.apb.SuperList#event:itemChanged itemChanged : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • sap.apb.SuperList#event:buttonClicked buttonClicked : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • sap.apb.SuperList#event:updateEnd updateEnd : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • sap.apb.SuperList#event:error error : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]

Extends

Parameters

Name Type Argument Description
sId string (optional) id for the new control, generated automatically if no id is given
mSettings object (optional) initial settings for the new control

Methods

Name Description
attachButtonClicked( [oData], fnFunction, [oListener] ) Attach event handler <code>fnFunction</code> to the 'buttonClicked' event of this <code>sap.apb.SuperList</code>.
attachDataTableQuery( [oData], fnFunction, [oListener] ) Attach event handler <code>fnFunction</code> to the 'dataTableQuery' event of this <code>sap.apb.SuperList</code>.
attachError( [oData], fnFunction, [oListener] ) Attach event handler <code>fnFunction</code> to the 'error' event of this <code>sap.apb.SuperList</code>.
attachItemChanged( [oData], fnFunction, [oListener] ) Attach event handler <code>fnFunction</code> to the 'itemChanged' event of this <code>sap.apb.SuperList</code>.
attachRowFocusChanged( [oData], fnFunction, [oListener] ) Attach event handler <code>fnFunction</code> to the 'rowFocusChanged' event of this <code>sap.apb.SuperList</code>.
attachUpdateEnd( [oData], fnFunction, [oListener] ) Attach event handler <code>fnFunction</code> to the 'updateEnd' event of this <code>sap.apb.SuperList</code>.
deleteRow( iRow ) Deletes a row.
detachButtonClicked( fnFunction, oListener ) Detach event handler <code>fnFunction</code> from the 'buttonClicked' event of this <code>sap.apb.SuperList</code>.
detachDataTableQuery( fnFunction, oListener ) Detach event handler <code>fnFunction</code> from the 'dataTableQuery' event of this <code>sap.apb.SuperList</code>.
detachError( fnFunction, oListener ) Detach event handler <code>fnFunction</code> from the 'error' event of this <code>sap.apb.SuperList</code>.
detachItemChanged( fnFunction, oListener ) Detach event handler <code>fnFunction</code> from the 'itemChanged' event of this <code>sap.apb.SuperList</code>.
detachRowFocusChanged( fnFunction, oListener ) Detach event handler <code>fnFunction</code> from the 'rowFocusChanged' event of this <code>sap.apb.SuperList</code>.
detachUpdateEnd( fnFunction, oListener ) Detach event handler <code>fnFunction</code> from the 'updateEnd' event of this <code>sap.apb.SuperList</code>.
drillBack() Drills back to prior level
drillDown( iRow ) Drills down to next level.
extend( sClassName, [oClassInfo], [FNMetaImpl] )  
filter( sExpr ) Filters the rows.
fireButtonClicked( [mArguments] ) Fire event buttonClicked to attached listeners.
fireDataTableQuery( [mArguments] ) Fire event dataTableQuery to attached listeners.
fireError( [mArguments] ) Fire event error to attached listeners.
fireItemChanged( [mArguments] ) Fire event itemChanged to attached listeners.
fireRowFocusChanged( [mArguments] ) Fire event rowFocusChanged to attached listeners.
fireUpdateEnd( [mArguments] ) Fire event updateEnd to attached listeners.
getCurrentLevel() Gets current level.
getDataSource() Getter for property <code>dataSource</code>. DataSource name of the SuperList Default value is empty/<code>undefined</code>
getHeight() Getter for property <code>height</code>. The height of the SuperList Default value is <code>100%</code>
getItem( iRow, iCol ) Gets the value of item.
getMetadataFile() Getter for property <code>metadataFile</code>. Metadata file name of the SuperList Default value is empty/<code>undefined</code>
getNumberOfRows() Gets number of rows.
getObjectProperty( sName ) Gets the value of property
getReadRows() Getter for property <code>readRows</code>. The default number of rows of dara is retrieved for the SuperList Default value is <code>200</code>
getRow( iRow ) Gets the values of row
getWidth() Getter for property <code>width</code>. The width of the SuperList Default value is <code>100%</code>
insertRow( oRow ) Inserts a row or appends a row if the input value is -1.
load( sUrl ) Loads a metafile and creates a superlist object.
refreshData() Retrieve data for the SuperList.
reset() Resets the data in datatable.
retrieve( oArgs ) Retrieves data.
setData( sValue, sId ) Sets data to data table
setDataSource( sDataSource ) Setter for property <code>dataSource</code>. Default value is empty/<code>undefined</code>
setHeight( sHeight ) Setter for property <code>height</code>. Default value is <code>100%</code>
setItem( iRow, iCol, oValue ) Sets the value of a row and column.
setMetadataFile( sMetadataFile ) Setter for property <code>metadataFile</code>. Default value is empty/<code>undefined</code>
setObjectProperty( sName, sValue ) Sets value to property.
setReadRows( sReadRows ) Setter for property <code>readRows</code>. Default value is <code>200</code>
setWidth( sWidth ) Setter for property <code>width</code>. Default value is <code>100%</code>
sort( sValue ) Sorts the row.
update() Updates changes to data source.

Events

Name Description
buttonClicked( oControlEvent, oControlEvent.getSource, oControlEvent.getParameters ) This event is triggered when the button is clicked.
dataTableQuery( oControlEvent, oControlEvent.getSource, oControlEvent.getParameters ) This event is triggered when the memory data is required.
error( oControlEvent, oControlEvent.getSource, oControlEvent.getParameters ) This event is triggered when the row focus is changed.
itemChanged( oControlEvent, oControlEvent.getSource, oControlEvent.getParameters ) This event is triggered when the value of (input, select, checkbox) contol is changed.
rowFocusChanged( oControlEvent, oControlEvent.getSource, oControlEvent.getParameters ) This event is triggered when the row focus is changed.
updateEnd( oControlEvent, oControlEvent.getSource, oControlEvent.getParameters ) This event is triggered when the data source update is completed.

Source

SuperList.API.js, line 11.

Parent topic: AppBuilder API Reference