Home | Class Index

SDK Version: 3.2.2-258182

Documentation generated on 25 April 2013

    • /
        • /libs/javascript/caplin/src\caplin\element\styler\StaleStyler
          • js
        • /libs/javascript/caplin/src\caplin\grid\decorator\GroupHeaderDecorator
          • js
        • /libs/javascript/caplin/src\caplin\grid\decorator\RowLoadingDecorator
          • js
Class
caplin.grid

RttpContainerGridDataProvider

Implements caplin.grid.GridDataProvider.

The RttpContainerGridDataProvider class allows grids to be populated using an RTTP container available on some Liberator. It is a concrete example of a caplin.grid.GridDataProvider class — what is typically used to allow data to be made available within a grid.

Constructor Summary

Attributes Name and Description
caplin.grid.RttpContainerGridDataProvider()

Constructs an RttpContainerGridDataProvider 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.GridGenerator class.

Method Summary

Attributes Name and Description
void fetchSnapshot(GridDataProviderSnapshotListener oGridDataProviderSnapshotListener)

Fetch all records from the RTTP container from the server, including off-screen records.
void injectData( sSubject, mData)

void setEditable(boolean bEditable)

Sets editable feature to true - i.e.
void setRowData(String sSubject, Map mRowData)

Sets the row with the specified row data.
void updateContainerName(String sContainerName)

Discards the current SL4B subscription and creates a new subscription to the specified container.
Methods implemented from class caplin.grid.GridDataProvider:
addDataProviderListener, clearFilterExpression, clearGroupByField, clearSortRule, configureDataProvider, getAllFilterExpressions, getFilterExpression, getGroupByField, getPermissionKey, getSerializedState, getSortRule, getStartIndex, getSubjectIdentifiers, getTransformMode, pauseUpdates, removeDataProviderListener, requestAllData, resumeUpdates, setFilterExpression, setFilters, setGridView, setGroupByField, setRequiredFields, setRowRange, setSortRule, setTransformMode, supportsFeature, terminateUpdates

Constructor Detail

► caplin.grid.RttpContainerGridDataProvider()

Constructs an RttpContainerGridDataProvider 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.GridGenerator class.

Method Detail

► void fetchSnapshot(GridDataProviderSnapshotListener oGridDataProviderSnapshotListener)

Fetch all records from the RTTP container from the server, including off-screen records. Once all records have been received, the GridDataListener

Parameters
GridDataProviderSnapshotListener oGridDataProviderSnapshotListener The listener to call with the snapshot.

► void injectData( sSubject, mData)

Parameters
sSubject
mData
See
caplin.grid.GridDataProvider#injectData

► void setEditable(boolean bEditable)

Sets editable feature to true - i.e. enables provider to edit data.

Parameters
boolean bEditable True to allow editing, false otherwise.

► void setRowData(String sSubject, Map mRowData)

Sets the row with the specified row data.

Parameters
String sSubject The subject (objectName) of the row to be updated
Map mRowData Map with field name and values to be updated for the subject specified

► void updateContainerName(String sContainerName)

Discards the current SL4B subscription and creates a new subscription to the specified container.

Parameters
String sContainerName The old subscription will be discarded, and a new one created for this container.