com.sap.ui.commons.client
Class RowRepeater

java.lang.Object
  com.google.gwt.core.client.JavaScriptObject
      com.sap.ui.core.client.Element
          com.sap.ui.core.client.Control
              com.sap.ui.commons.client.RowRepeater

public class RowRepeater
extends com.sap.ui.core.client.Control

The class RowRepeater is the GWT wrapper for the Phoenix control: sap.ui.commons.RowRepeater.

This control displays items in a stacked list format, allowing the user to page in order to see more items or to use the offered filtering and sorting capabilities in order to manipulate the displayed data.

• Properties
  • visible : boolean
    Invisible row-repeaters are not rendered.
  • numberOfRows : int
    Number of rows displayed.
  • currentPage : int
    The index of the page currently displayed. The index starts at 1.
  • showMoreSteps : int
    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.
  • fixedRowHeight : String
    Row height adapts to rendered content. If a fixed height is specified the cells have a maximum height and the overflow will be hidden.
  • design : com.sap.ui.commons.client.RowRepeaterDesign
    The visual design of the control.
• Aggregations
  • rows : com.sap.ui.core.client.Control
    Rows to be repeated.
  • title : com.sap.ui.commons.client.Title
    Title to be displayed in top left corner. Either text or icon.
  • filters : com.sap.ui.commons.client.RowRepeaterFilter
    Filters to be provided in toolbar.
  • sorters : com.sap.ui.commons.client.RowRepeaterSorter
    Sorters to be provided in secondary toolbar.
• Associations
• Events
  • filter This event is triggered when a filter is set.
  • sort This event is triggered when a sorting is applied.
  • page This event is triggered when paging was executed.
  • resize This event is triggered when the number of rows was changed.

Version:

0.18.0-SNAPSHOT

Author:

GENERATOR (JavaScript control: sap.ui.commons.RowRepeater)

Constructor Summary

protected

RowRepeater() constructs the class RowRepeater hidden due to JavaScriptObject restriction

Method Summary

RowRepeater	addFilter(RowRepeaterFilter filter) Appends a filter to the aggregation filters.
RowRepeater	addRow(com.sap.ui.core.client.Control row) Appends a row to the aggregation rows.
RowRepeater	addSorter(RowRepeaterSorter sorter) Appends a sorter to the aggregation sorters.
void	applyFilter(String id) Applies a filter.
RowRepeater	attachFilterEvent(com.sap.ui.core.client.event.EventListener listener) attach an EventListener This event is triggered when a filter is set.
RowRepeater	attachPageEvent(com.sap.ui.core.client.event.EventListener listener) attach an EventListener This event is triggered when paging was executed.
RowRepeater	attachResizeEvent(com.sap.ui.core.client.event.EventListener listener) attach an EventListener This event is triggered when the number of rows was changed.
RowRepeater	attachSortEvent(com.sap.ui.core.client.event.EventListener listener) attach an EventListener This event is triggered when a sorting is applied.
RowRepeater	bindRows(String path, com.sap.ui.core.client.Element template) Binder for aggregation rows.
static RowRepeater	create() creates a new instance of the class RowRepeater
static RowRepeater	create(String idOrConfig) creates a new instance of the class RowRepeater
static RowRepeater	create(String id, String config) creates a new instance of the class RowRepeater
RowRepeater	destroyFilters() Destroys all the filters in the Filters-aggregation.
RowRepeater	destroyRows() Destroys all the rows in the Rows-aggregation.
RowRepeater	destroySorters() Destroys all the sorters in the Sorters-aggregation.
RowRepeater	destroyTitle() Destroys the title in the Title-aggregation.
RowRepeater	detachFilterEvent(com.sap.ui.core.client.event.EventListener listener) detach an EventListener This event is triggered when a filter is set.
RowRepeater	detachPageEvent(com.sap.ui.core.client.event.EventListener listener) detach an EventListener This event is triggered when paging was executed.
RowRepeater	detachResizeEvent(com.sap.ui.core.client.event.EventListener listener) detach an EventListener This event is triggered when the number of rows was changed.
RowRepeater	detachSortEvent(com.sap.ui.core.client.event.EventListener listener) detach an EventListener This event is triggered when a sorting is applied.
void	firstPage() Switch to first page.
int	getCurrentPage() Getter for property currentPage The index of the page currently displayed.
RowRepeaterDesign	getDesign() Getter for property design The visual design of the control.
com.sap.ui.core.client.js.JsArray<RowRepeaterFilter>	getFilters() Getter for aggregation filters Filters to be provided in toolbar.
String	getFixedRowHeight() Getter for property fixedRowHeight Row height adapts to rendered content.
int	getNumberOfRows() Getter for property numberOfRows Number of rows displayed.
com.sap.ui.core.client.js.JsArray<com.sap.ui.core.client.Control>	getRows() Getter for aggregation rows Rows to be repeated.
int	getShowMoreSteps() Getter for property showMoreSteps Step size used to increase the numberOfRows value.
com.sap.ui.core.client.js.JsArray<RowRepeaterSorter>	getSorters() Getter for aggregation sorters Sorters to be provided in secondary toolbar.
Title	getTitle() Getter for aggregation title Title to be displayed in top left corner.
void	gotoPage(int pageNumber) Switch to specified page.
int	indexOfFilter(RowRepeaterFilter filter) Checks for the provided com.sap.ui.commons.client.RowRepeaterFilter in the filters-aggregation and returns its index if found or -1 otherwise.
int	indexOfRow(com.sap.ui.core.client.Control row) Checks for the provided com.sap.ui.core.client.Control in the rows-aggregation and returns its index if found or -1 otherwise.
int	indexOfSorter(RowRepeaterSorter sorter) Checks for the provided com.sap.ui.commons.client.RowRepeaterSorter in the sorters-aggregation and returns its index if found or -1 otherwise.
RowRepeater	insertFilter(RowRepeaterFilter filter, int index) Inserts some filter into the aggregation named filters.
RowRepeater	insertRow(com.sap.ui.core.client.Control row, int index) Inserts some row into the aggregation named rows.
RowRepeater	insertSorter(RowRepeaterSorter sorter, int index) Inserts some sorter into the aggregation named sorters.
boolean	isVisible() Getter for property visible Invisible row-repeaters are not rendered.
void	lastPage() Switch to last page.
void	nextPage() Switch to next page.
void	previousPage() Switch to previous page.
com.sap.ui.core.client.js.JsArray<com.sap.ui.core.client.js.JsArray<RowRepeaterFilter>>	removeAllFilters() Removes all the items in the filters-aggregation.
com.sap.ui.core.client.js.JsArray<com.sap.ui.core.client.js.JsArray<com.sap.ui.core.client.Control>>	removeAllRows() Removes all the items in the rows-aggregation.
com.sap.ui.core.client.js.JsArray<com.sap.ui.core.client.js.JsArray<RowRepeaterSorter>>	removeAllSorters() Removes all the items in the sorters-aggregation.
com.sap.ui.core.client.js.JsArray<RowRepeaterFilter>	removeFilter(int index) Removes a filter from the aggregation named filters.
com.sap.ui.core.client.js.JsArray<com.sap.ui.core.client.Control>	removeRow(int index) Removes a row from the aggregation named rows.
com.sap.ui.core.client.js.JsArray<RowRepeaterSorter>	removeSorter(int index) Removes a sorter from the aggregation named sorters.
void	resize(int numberOfRows) Resizes the row repeater by changing the number of displayed rows.
RowRepeater	setCurrentPage(int value) Setter for property currentPage Default value is: 1
RowRepeater	setDesign(RowRepeaterDesign value) Setter for property design Default value is: Standard
RowRepeater	setFixedRowHeight(String value) Setter for property fixedRowHeight
RowRepeater	setNumberOfRows(int value) Setter for property numberOfRows Default value is: 5
RowRepeater	setShowMoreSteps(int value) Setter for property showMoreSteps Default value is: 0
RowRepeater	setTitle(Title title) Setter for the aggregated title.
RowRepeater	setVisible(boolean value) Setter for property visible Default value is: true
void	triggerShowMore() Increments the number of rows.
void	triggerSort(String id) Sort the data.
RowRepeater	unbindRows() Unbinder for aggregation rows.

Methods inherited from class com.sap.ui.core.client.Control

addStyleClass, hasStyleClass, invalidate, placeAt, placeAt, removeStyleClass, rerender

Methods inherited from class com.sap.ui.core.client.Element

_convertArray, _convertArray, _convertArray, _convertArray, _convertArray, attachBrowserEvent, attachEvent, bindAggregation, bindContext, bindProperty, bindProperty, destroy, detachBrowserEvent, detachEvent, getDomRef, getElementName, getId, getLibraryName, getModel, getParent, getProperty, getTooltip_AsString, getTooltip_Text, getTooltip, isActive, setModel, setProperty, setTooltip, setTooltip, unbindAggregation, unbindContext, unbindProperty

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RowRepeater

protected RowRepeater()

constructs the class RowRepeater
hidden due to JavaScriptObject restriction

Method Detail

create

public static RowRepeater create()

creates a new instance of the class RowRepeater

create

public static RowRepeater create(String idOrConfig)

creates a new instance of the class RowRepeater

Parameters:

id - id of the RowRepeater or configuration JSON string

create

public static RowRepeater create(String id,
                                 String config)

creates a new instance of the class RowRepeater

Parameters:

id - id of the RowRepeater

config - configuration JSON string

isVisible

public final boolean isVisible()

Getter for property visible Invisible row-repeaters are not rendered.

Returns:

the value of property visible

setVisible

public final RowRepeater setVisible(boolean value)

Setter for property visible
Default value is: true

Parameters:

value - boolean

Returns:

this to allow method chaining

getNumberOfRows

public final int getNumberOfRows()

Getter for property numberOfRows Number of rows displayed.

Returns:

the value of property numberOfRows

setNumberOfRows

public final RowRepeater setNumberOfRows(int value)

Setter for property numberOfRows
Default value is: 5

Parameters:

value - int

Returns:

this to allow method chaining

getCurrentPage

public final int getCurrentPage()

Getter for property currentPage The index of the page currently displayed. The index starts at 1.

Returns:

the value of property currentPage

setCurrentPage

public final RowRepeater setCurrentPage(int value)

Setter for property currentPage
Default value is: 1

Parameters:

value - int

Returns:

this to allow method chaining

getShowMoreSteps

public final int getShowMoreSteps()

Getter for 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.

Returns:

the value of property showMoreSteps

setShowMoreSteps

public final RowRepeater setShowMoreSteps(int value)

Setter for property showMoreSteps
Default value is: 0

Parameters:

value - int

Returns:

this to allow method chaining

getFixedRowHeight

public final String getFixedRowHeight()

Getter 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.

Returns:

the value of property fixedRowHeight

setFixedRowHeight

public final RowRepeater setFixedRowHeight(String value)

Setter for property fixedRowHeight

Parameters:

value - String

Returns:

this to allow method chaining

getDesign

public final RowRepeaterDesign getDesign()

Getter for property design The visual design of the control.

Returns:

the value of property design

setDesign

public final RowRepeater setDesign(RowRepeaterDesign value)

Setter for property design
Default value is: Standard

Parameters:

value - com.sap.ui.commons.client.RowRepeaterDesign

Returns:

this to allow method chaining

getRows

public final com.sap.ui.core.client.js.JsArray<com.sap.ui.core.client.Control> getRows()

Getter for aggregation rows Rows to be repeated.

Returns:

com.sap.ui.core.client.Control[]

insertRow

public final RowRepeater insertRow(com.sap.ui.core.client.Control row,
                                   int index)

Inserts some row into the aggregation named rows.

Parameters:

row - the row to insert

index - int the 0-based index the row should be inserted at.

Returns:

this to allow method chaining

addRow

public final RowRepeater addRow(com.sap.ui.core.client.Control row)

Appends a row to the aggregation rows.

Parameters:

row - com.sap.ui.core.client.Control the row to add

Returns:

this to allow method chaining

removeRow

public final com.sap.ui.core.client.js.JsArray<com.sap.ui.core.client.Control> removeRow(int index)

Removes a row from the aggregation named rows.

Parameters:

index - int the position of the row to remove.

Returns:

reference to this instance

removeAllRows

public final com.sap.ui.core.client.js.JsArray<com.sap.ui.core.client.js.JsArray<com.sap.ui.core.client.Control>> removeAllRows()

Removes all the items in the rows-aggregation.

Returns:

an array of the removed elements (might be empty)

indexOfRow

public final int indexOfRow(com.sap.ui.core.client.Control row)

Checks for the provided com.sap.ui.core.client.Control in the rows-aggregation and returns its index if found or -1 otherwise.

Parameters:

row - the row whose index is looked for.

Returns:

the index of the provided control in the aggregation.

destroyRows

public final RowRepeater destroyRows()

Destroys all the rows in the Rows-aggregation.

Returns:

this to allow method chaining

bindRows

public final RowRepeater bindRows(String path,
                                  com.sap.ui.core.client.Element template)

Binder for aggregation rows.

Parameters:

path - path to a list in the model

template - the template Element for this aggregation

Returns:

this to allow method chaining

unbindRows

public final RowRepeater unbindRows()

Unbinder for aggregation rows.

Returns:

this to allow method chaining

getTitle

public final Title getTitle()

Getter for aggregation title Title to be displayed in top left corner. Either text or icon.

Returns:

com.sap.ui.commons.client.Title

setTitle

public final RowRepeater setTitle(Title title)

Setter for the aggregated title.

Parameters:

otitle - {com.sap.ui.commons.client.Title}

Returns:

this to allow method chaining

destroyTitle

public final RowRepeater destroyTitle()

Destroys the title in the Title-aggregation.

Returns:

this to allow method chaining

getFilters

public final com.sap.ui.core.client.js.JsArray<RowRepeaterFilter> getFilters()

Getter for aggregation filters Filters to be provided in toolbar.

Returns:

com.sap.ui.commons.client.RowRepeaterFilter[]

insertFilter

public final RowRepeater insertFilter(RowRepeaterFilter filter,
                                      int index)

Inserts some filter into the aggregation named filters.

Parameters:

filter - the filter to insert

index - int the 0-based index the filter should be inserted at.

Returns:

this to allow method chaining

addFilter

public final RowRepeater addFilter(RowRepeaterFilter filter)

Appends a filter to the aggregation filters.

Parameters:

filter - com.sap.ui.commons.client.RowRepeaterFilter the filter to add

Returns:

this to allow method chaining

removeFilter

public final com.sap.ui.core.client.js.JsArray<RowRepeaterFilter> removeFilter(int index)

Removes a filter from the aggregation named filters.

Parameters:

index - int the position of the filter to remove.

Returns:

reference to this instance

removeAllFilters

public final com.sap.ui.core.client.js.JsArray<com.sap.ui.core.client.js.JsArray<RowRepeaterFilter>> removeAllFilters()

Removes all the items in the filters-aggregation.

Returns:

an array of the removed elements (might be empty)

indexOfFilter

public final int indexOfFilter(RowRepeaterFilter filter)

Checks for the provided com.sap.ui.commons.client.RowRepeaterFilter in the filters-aggregation and returns its index if found or -1 otherwise.

Parameters:

filter - the filter whose index is looked for.

Returns:

the index of the provided control in the aggregation.

destroyFilters

public final RowRepeater destroyFilters()

Destroys all the filters in the Filters-aggregation.

Returns:

this to allow method chaining

getSorters

public final com.sap.ui.core.client.js.JsArray<RowRepeaterSorter> getSorters()

Getter for aggregation sorters Sorters to be provided in secondary toolbar.

Returns:

com.sap.ui.commons.client.RowRepeaterSorter[]

insertSorter

public final RowRepeater insertSorter(RowRepeaterSorter sorter,
                                      int index)

Inserts some sorter into the aggregation named sorters.

Parameters:

sorter - the sorter to insert

index - int the 0-based index the sorter should be inserted at.

Returns:

this to allow method chaining

addSorter

public final RowRepeater addSorter(RowRepeaterSorter sorter)

Appends a sorter to the aggregation sorters.

Parameters:

sorter - com.sap.ui.commons.client.RowRepeaterSorter the sorter to add

Returns:

this to allow method chaining

removeSorter

public final com.sap.ui.core.client.js.JsArray<RowRepeaterSorter> removeSorter(int index)

Removes a sorter from the aggregation named sorters.

Parameters:

index - int the position of the sorter to remove.

Returns:

reference to this instance

removeAllSorters

public final com.sap.ui.core.client.js.JsArray<com.sap.ui.core.client.js.JsArray<RowRepeaterSorter>> removeAllSorters()

Removes all the items in the sorters-aggregation.

Returns:

an array of the removed elements (might be empty)

indexOfSorter

public final int indexOfSorter(RowRepeaterSorter sorter)

Checks for the provided com.sap.ui.commons.client.RowRepeaterSorter in the sorters-aggregation and returns its index if found or -1 otherwise.

Parameters:

sorter - the sorter whose index is looked for.

Returns:

the index of the provided control in the aggregation.

destroySorters

public final RowRepeater destroySorters()

Destroys all the sorters in the Sorters-aggregation.

Returns:

this to allow method chaining

attachFilterEvent

public final RowRepeater attachFilterEvent(com.sap.ui.core.client.event.EventListener listener)

attach an EventListener This event is triggered when a filter is set.

Event Parameters:

{sap.ui.core/string} filterId The ID of the filter that has just been applied.

Parameters:

listener - reference to the EventListener

Returns:

this to allow method chaining

detachFilterEvent

public final RowRepeater detachFilterEvent(com.sap.ui.core.client.event.EventListener listener)

detach an EventListener This event is triggered when a filter is set.

Parameters:

listener - reference to the EventListener

Returns:

this to allow method chaining

attachSortEvent

public final RowRepeater attachSortEvent(com.sap.ui.core.client.event.EventListener listener)

attach an EventListener This event is triggered when a sorting is applied.

Event Parameters:

{sap.ui.core/string} sorterId The ID of the sorter that has just been applied.

Parameters:

listener - reference to the EventListener

Returns:

this to allow method chaining

detachSortEvent

public final RowRepeater detachSortEvent(com.sap.ui.core.client.event.EventListener listener)

detach an EventListener This event is triggered when a sorting is applied.

Parameters:

listener - reference to the EventListener

Returns:

this to allow method chaining

attachPageEvent

public final RowRepeater attachPageEvent(com.sap.ui.core.client.event.EventListener listener)

attach an EventListener This event is triggered when paging was executed.

Event Parameters:

{int} currentPage The value of the currentPage property after the change.

{int} previousPage The value of the currentPage property before the change.

Parameters:

listener - reference to the EventListener

Returns:

this to allow method chaining

detachPageEvent

public final RowRepeater detachPageEvent(com.sap.ui.core.client.event.EventListener listener)

detach an EventListener This event is triggered when paging was executed.

Parameters:

listener - reference to the EventListener

Returns:

this to allow method chaining

attachResizeEvent

public final RowRepeater attachResizeEvent(com.sap.ui.core.client.event.EventListener listener)

attach an EventListener This event is triggered when the number of rows was changed.

Event Parameters:

{int} numberOfRows The value of the numberOfRows property after the change.

{int} previousNumberOfRows The value of the numberOfRows property before the change.

Parameters:

listener - reference to the EventListener

Returns:

this to allow method chaining

detachResizeEvent

public final RowRepeater detachResizeEvent(com.sap.ui.core.client.event.EventListener listener)

detach an EventListener This event is triggered when the number of rows was changed.

Parameters:

listener - reference to the EventListener

Returns:

this to allow method chaining

triggerShowMore

public final void triggerShowMore()

Increments the number of rows. This method will only trigger a showMore if the property showMoreSteps is set.

resize

public final void resize(int numberOfRows)

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:

numberOfRows - The new value of number of rows displayed.

applyFilter

public final void applyFilter(String id)

Applies a filter.

Parameters:

id - The ID if the filter.

triggerSort

public final void triggerSort(String id)

Sort the data.

Parameters:

id - The ID of the sorter.

firstPage

public final void firstPage()

Switch to first page.

lastPage

public final void lastPage()

Switch to last page.

previousPage

public final void previousPage()

Switch to previous page.

nextPage

public final void nextPage()

Switch to next page.

gotoPage

public final void gotoPage(int pageNumber)

Switch to specified page.

Parameters:

pageNumber - The index of the page to go to.