sap.ui.commons.RowRepeater.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ui.commons.RowRepeater 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:
{string} | sClassName | Name of the class being created |
{object} | oClassInfo? | Object literal with information about the class |
{function} | FNMetaImpl? | Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata |
Returns:
{function} | Created class / constructor function |
Returns a metadata object for class sap.ui.commons.RowRepeater.
Returns:
Adds some filter to the aggregation filters
.
Parameters:
Returns:
Adds some row to the aggregation rows
.
Parameters:
Returns:
Adds some sorter to the aggregation sorters
.
Parameters:
Returns:
applyFilter(sId): void
Applies a filter.
Parameters:
{string} | sId | The ID if the filter. |
Attaches event handler
fnFunction
to the
filter
event of this
sap.ui.commons.RowRepeater
.
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.commons.RowRepeater
itself.
This event is triggered when a filter is set.
Parameters:
{object} | oData? | An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
{function} | fnFunction | The function to be called when the event occurs |
{object} | oListener? | Context object to call the event handler with. Defaults to this sap.ui.commons.RowRepeater itself |
Returns:
Attaches event handler
fnFunction
to the
page
event of this
sap.ui.commons.RowRepeater
.
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.commons.RowRepeater
itself.
This event is triggered when paging was executed.
Parameters:
{object} | oData? | An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
{function} | fnFunction | The function to be called when the event occurs |
{object} | oListener? | Context object to call the event handler with. Defaults to this sap.ui.commons.RowRepeater itself |
Returns:
Attaches event handler
fnFunction
to the
resize
event of this
sap.ui.commons.RowRepeater
.
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.commons.RowRepeater
itself.
This event is triggered when the number of rows was changed.
Parameters:
{object} | oData? | An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
{function} | fnFunction | The function to be called when the event occurs |
{object} | oListener? | Context object to call the event handler with. Defaults to this sap.ui.commons.RowRepeater itself |
Returns:
Attaches event handler
fnFunction
to the
sort
event of this
sap.ui.commons.RowRepeater
.
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.commons.RowRepeater
itself.
This event is triggered when a sorting is applied.
Parameters:
{object} | oData? | An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
{function} | fnFunction | The function to be called when the event occurs |
{object} | oListener? | Context object to call the event handler with. Defaults to this sap.ui.commons.RowRepeater itself |
Returns:
Parameters:
{object} | oBindingInfo | The binding information |
Returns:
Destroys all the filters in the aggregation filters
.
Returns:
Destroys the noData in the aggregation noData
.
Returns:
Destroys all the rows in the aggregation rows
.
Returns:
Destroys all the sorters in the aggregation sorters
.
Returns:
Destroys the title in the aggregation title
.
Returns:
Detaches event handler
fnFunction
from the
filter
event of this
sap.ui.commons.RowRepeater
.
The passed function and listener object must match the ones used for event registration.
Parameters:
{function} | fnFunction | The function to be called, when the event occurs |
{object} | oListener | Context object on which the given function had to be called |
Returns:
Detaches event handler
fnFunction
from the
page
event of this
sap.ui.commons.RowRepeater
.
The passed function and listener object must match the ones used for event registration.
Parameters:
{function} | fnFunction | The function to be called, when the event occurs |
{object} | oListener | Context object on which the given function had to be called |
Returns:
Detaches event handler
fnFunction
from the
resize
event of this
sap.ui.commons.RowRepeater
.
The passed function and listener object must match the ones used for event registration.
Parameters:
{function} | fnFunction | The function to be called, when the event occurs |
{object} | oListener | Context object on which the given function had to be called |
Returns:
Detaches event handler
fnFunction
from the
sort
event of this
sap.ui.commons.RowRepeater
.
The passed function and listener object must match the ones used for event registration.
Parameters:
{function} | fnFunction | The function to be called, when the event occurs |
{object} | oListener | Context object on which the given function had to be called |
Returns:
Fires event
filter
to attached listeners.
Expects the following event parameters:
filterId
of type string
The ID of the filter that has just been applied.
Parameters:
{Map} | mArguments? | The arguments to pass along with the event |
Returns:
Fires event
page
to attached listeners.
Expects the following event parameters:
currentPage
of type int
The value of the currentPage property after the change.previousPage
of type int
The value of the currentPage property before the change.
Parameters:
{Map} | mArguments? | The arguments to pass along with the event |
Returns:
Fires event
resize
to attached listeners.
Expects the following event parameters:
numberOfRows
of type int
The value of the numberOfRows property after the change.previousNumberOfRows
of type int
The value of the numberOfRows property before the change.
Parameters:
{Map} | mArguments? | The arguments to pass along with the event |
Returns:
Fires event
sort
to attached listeners.
Expects the following event parameters:
sorterId
of type string
The ID of the sorter that has just been applied.
Parameters:
{Map} | mArguments? | The arguments to pass along with the event |
Returns:
firstPage(): void
Switch to first page.
getCurrentPage(): int
Gets current value of property
currentPage
.
The index of the page currently displayed. The index starts at 1.
Default value is 1
.
Returns:
{int} | Value of property currentPage |
Gets current value of property
design
.
The visual design of the control.
Default value is Standard
.
Returns:
Gets content of aggregation
filters
.
Filters to be provided in toolbar.
Returns:
Gets current value of property
fixedRowHeight
.
Row height adapts to rendered content. If a fixed height is specified the cells have a maximum height and the overflow will be hidden.
Default value is
.
Returns:
Gets content of aggregation
noData
.
This control is shown, in case there is no data available to be displayed in the RowRepeater.
Returns:
getNumberOfRows(): int
Gets current value of property
numberOfRows
.
Number of rows displayed.
Default value is 5
.
Returns:
{int} | Value of property numberOfRows |
Gets content of aggregation
rows
.
Rows to be repeated.
Returns:
getShowMoreSteps(): int
Gets current value of property
showMoreSteps
.
Step size used to increase the numberOfRows value. This feature is only active if value is greater than 0. This will deactivate the paging feature.
Default value is 0
.
Returns:
{int} | Value of property showMoreSteps |
Gets content of aggregation
sorters
.
Sorters to be provided in secondary toolbar.
Returns:
getThreshold(): int
Gets current value of property
threshold
.
Threshold to fetch the next chunk of data. The minimal threshold can be the numberOfRows of the RR.
Returns:
{int} | Value of property threshold |
Gets content of aggregation
title
.
Title to be displayed in top left corner. Either text or icon.
Returns:
gotoPage(iPageNumber): void
Switch to specified page.
Parameters:
{int} | iPageNumber | The index of the page to go to. |
indexOfFilter(oFilter): int
Checks for the provided sap.ui.commons.RowRepeaterFilter
in the aggregation filters
. and returns its index if found or -1 otherwise.
Parameters:
Returns:
{int} | The index of the provided control in the aggregation if found, or -1 otherwise |
indexOfRow(oRow): int
Checks for the provided sap.ui.core.Control
in the aggregation rows
. and returns its index if found or -1 otherwise.
Parameters:
Returns:
{int} | The index of the provided control in the aggregation if found, or -1 otherwise |
indexOfSorter(oSorter): int
Checks for the provided sap.ui.commons.RowRepeaterSorter
in the aggregation sorters
. and returns its index if found or -1 otherwise.
Parameters:
Returns:
{int} | The index of the provided control in the aggregation if found, or -1 otherwise |
Inserts a filter into the aggregation filters
.
Parameters:
{sap.ui.commons.RowRepeaterFilter} | oFilter | the filter to insert; if empty, nothing is inserted |
{int} | iIndex | the 0 -based index the filter should be inserted at; for a negative value of iIndex , the filter is inserted at position 0; for a value greater than the current size of the aggregation, the filter is inserted at the last position |
Returns:
Inserts a row into the aggregation rows
.
Parameters:
{sap.ui.core.Control} | oRow | the row to insert; if empty, nothing is inserted |
{int} | iIndex | the 0 -based index the row should be inserted at; for a negative value of iIndex , the row is inserted at position 0; for a value greater than the current size of the aggregation, the row is inserted at the last position |
Returns:
Inserts a sorter into the aggregation sorters
.
Parameters:
{sap.ui.commons.RowRepeaterSorter} | oSorter | the sorter to insert; if empty, nothing is inserted |
{int} | iIndex | the 0 -based index the sorter should be inserted at; for a negative value of iIndex , the sorter is inserted at position 0; for a value greater than the current size of the aggregation, the sorter is inserted at the last position |
Returns:
lastPage(): void
Switch to last page.
nextPage(): void
Switch to next page.
previousPage(): void
Switch to previous page.
Removes all the controls from the aggregation
filters
.
Additionally, it unregisters them from the hosting UIArea.
Returns:
Removes all the controls from the aggregation
rows
.
Additionally, it unregisters them from the hosting UIArea.
Returns:
Removes all the controls from the aggregation
sorters
.
Additionally, it unregisters them from the hosting UIArea.
Returns:
Removes a filter from the aggregation filters
.
Parameters:
Returns:
Removes a row from the aggregation rows
.
Parameters:
Returns:
Removes a sorter from the aggregation sorters
.
Parameters:
Returns:
resize(iNumberOfRows): void
Resizes the row repeater by changing the number of displayed rows. This method will only resize the RowRepeater if the property showMoreSteps is set.
Parameters:
{int} | iNumberOfRows | The new value of number of rows displayed. |
Setter for property currentPage
.
Parameters:
{int} | iCurrentPage | new value for property currentPage |
Returns:
Sets a new value for property
design
.
The visual design of the control.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is Standard
.
Parameters:
Returns:
Sets a new value for property
fixedRowHeight
.
Row height adapts to rendered content. If a fixed height is specified the cells have a maximum height and the overflow will be hidden.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is
.
Parameters:
Returns:
Sets the aggregated noData
.
Parameters:
Returns:
Setter for property
numberOfRows
.
Default value is 5
Parameters:
{int} | iNumberOfRows | new value for property numberOfRows |
Returns:
Override the default behavior of setShowMoreSteps
to update the paging mode flag. Any change to the paging mode flag will result in the current page being set to the first page.
Parameters:
{int} | iShowMoreSteps | new value for property showMoreSteps |
Returns:
Sets a new value for property
threshold
.
Threshold to fetch the next chunk of data. The minimal threshold can be the numberOfRows of the RR.
When called with a value of null
or undefined
, the default value of the property will be restored.
Parameters:
{int} | iThreshold | New value for property threshold |
Returns:
Sets the aggregated title
.
Parameters:
Returns:
The
triggerShowMore
function increments the number of rows by the value of
showMoreSteps
.
This method will only trigger a showMore if the property showMoreSteps is set.
Returns:
triggerSort(sId): void
Sort the data.
Parameters:
{string} | sId | The ID of the sorter. |
Unbinds aggregation rows
from model data.
Returns: