Home | Class Index

SDK Version: 3.11.4-302512

Documentation generated on 24 July 2015

Class
caplin.grid.decorator

LoadingDataDecorator

Implements caplin.grid.GridRowModelListener, caplin.grid.GridViewListener, caplin.grid.decorator.GridDecorator.
The LoadingDataDecorator renders a spinning wait icon whenever the grid is waiting for data to arrive, so that users can see what is happening. The showInitialLoad attribute within the <loadingDataDecorator/> tag, can be used to control whether a spinning icon will be displayed the first time the grid is loaded — this will cause pages that contain grids to load more slowly than they otherwise would.

This class displays the image source/images/grid/loadingIcon.gif to show that loading is in progress. It also uses the following CSS classes to position the image and provide futher look and feel enhancements:

  • loadingIconContainer dataLoading - CSS class assigned to the HTML element that contains the loading icon whilst the grid is awaiting the initial response to the request for row data.
  • loadingIconContainer dataLoaded - CSS class assigned to the HTML element that contains the loading icon after the initial response to the request for row data has been received.
  • loadingIcon - CSS class assigned to the loading icon's HTML image element.

Constructor Summary

Attributes Name and Description
caplin.grid.decorator.LoadingDataDecorator(Object mDecoratorConfig)

Constructs a caplin.grid.decorator.LoadingDataDecorator instance — end-users will never need to do this themselves since grids are fully constructed based on their XML definition files by the caplin.grid.GridComponentFactory class.
Methods implemented from class caplin.grid.decorator.GridDecorator:
setGridView
Methods implemented from class caplin.grid.GridViewListener:
onActivate, onAllRowsReceived, onClose, onContainerHtmlRendered, onDeactivate, onHide, onMaximize, onMinimize, onOpen, onResize, onRestore, onRowStructureChanged, onScroll, onScrollComplete, onScrollHorizontal, onScrollVertical, onShow, onViewRedrawn, onVisibleRowCountChanged
Methods implemented from class caplin.grid.GridRowModelListener:
onAllDataReceived, onRowContentsChanged, onRowDataReceived, onRowDataRequested, onRowDataUnavailable, onRowModelStateChanged, onSizeChanged, onStartIndexChanged

Constructor Detail

► caplin.grid.decorator.LoadingDataDecorator(Object mDecoratorConfig)

Constructs a caplin.grid.decorator.LoadingDataDecorator instance — end-users will never need to do this themselves since grids are fully constructed based on their XML definition files by the caplin.grid.GridComponentFactory class.

Parameters
Object mDecoratorConfig config object