Caplin Trader 5.1.0

Class: module:ct-grid/decorator/RowLoadingDecorator

module:ct-grid/decorator/RowLoadingDecorator()

new module:ct-grid/decorator/RowLoadingDecorator()

Constructs a RowLoadingDecorator instance — end-users will never need to do this as grids are constructed based on their configurations in XML definition files by the module:ct-grid/GridComponentFactory class.

The RowLoadingDecorator provides a loading image (e.g. a spinner) in rows that do not yet have data. The image that will be used is configured by defining the background image for the loadingRow class. When the row has received its data, the loading image is removed.

Implements:
Deprecated:
  • The use of imagePath as defined in gridDefinitions.xml is deprecated. The decorator now references a themed css class instead (.loadingRow)

Methods

onAllDataReceived()

This callback is invoked when data has been received for all requested rows

Implements:

onClose()

Implements:
See:

onOpen()

Implements:
See:

onScroll(nScrollAmount, nPreviousStartIndex)

Optional. Called when the view is scrolled.

Parameters:
Name Type Description
nScrollAmount int

the total height in pixels from the start index.

nPreviousStartIndex int

the index of the first visible row from the last load.

Implements:

setGridView()

Implements:
See: