Home | Class Index

SDK Version: 3.11.4-302512

Documentation generated on 24 July 2015

Class
caplin.grid

SyntheticGridDataProvider

Implements caplin.grid.GridDataProvider.
A SyntheticGridDataProvider defines a provider for grids that generates a simple increments each cells content every second.

Constructor Summary

Attributes Name and Description
caplin.grid.SyntheticGridDataProvider()

Constructs a caplin.grid.SyntheticGridDataProvider.

Method Summary

Attributes Name and Description
void addDataProviderListener(caplin.grid.GridDataProviderListener oDataProviderListener)

Adds a GridDataProviderListener to wishes to listen to data updates.
void configureDataProvider(Element eXmlConfigurationNode)

Allow the data provider to configure itself based on the XML attributes from the node used to configure the data provider.
void getSortRule()

Get the rule, if one exists, that is used to sort the data within the row model, since we do not use sorting this will always return null
void removeDataProviderListener()

Removes a GridDataProviderListener that no longer wishes to listen to data updates.
void setRequiredFields(Array pFieldNames)

Sets the required fields that this data provider should provide within each record.
void setRowRange(int nStartIndex, int nSize)

Sets the start index and total number of rows that this SyntheticGridDataProvider should use when notifying listeners of row updates.
Methods implemented from class caplin.grid.GridDataProvider:
clearFilterExpression, clearGroupByField, clearSortRule, getAllFilterExpressions, getFilterExpression, getGroupByField, getPermissionKey, getSerializedState, getStartIndex, getSubjectIdentifiers, getTransformMode, injectData, pauseUpdates, requestAllData, resumeUpdates, setFilterExpression, setFilters, setGridView, setGroupByField, setRowData, setSortRule, setTransformMode, supportsFeature, terminateUpdates
Methods from caplin.component.InstrumentReceiver:
canReceive, canReceiveMultipleObjects, canReceiveObjects, getLastReceiveFailureMessage, getSuccessMessage, receiveObjects

Constructor Detail

► caplin.grid.SyntheticGridDataProvider()

Constructs a caplin.grid.SyntheticGridDataProvider.

Method Detail

► void addDataProviderListener(caplin.grid.GridDataProviderListener oDataProviderListener)

Adds a GridDataProviderListener to wishes to listen to data updates.

Parameters
caplin.grid.GridDataProviderListener oDataProviderListener The listener to add.
See
#removeDataProviderListener

► void configureDataProvider(Element eXmlConfigurationNode)

Allow the data provider to configure itself based on the XML attributes from the node used to configure the data provider.

Parameters
Element eXmlConfigurationNode Access to the XML node that contains the row names that will be displayed within the first column of the grid.

► void getSortRule()

Get the rule, if one exists, that is used to sort the data within the row model, since we do not use sorting this will always return null

► void removeDataProviderListener()

Removes a GridDataProviderListener that no longer wishes to listen to data updates.

Parameters
caplin.grid.GridDataProviderListener oDataProviderListener The listener to remove.
See
#addDataProviderListener

► void setRequiredFields(Array pFieldNames)

Sets the required fields that this data provider should provide within each record.

Parameters
Array pFieldNames A list of field names as strings, these are the column names provided within the gridDefinition

► void setRowRange(int nStartIndex, int nSize)

Sets the start index and total number of rows that this SyntheticGridDataProvider should use when notifying listeners of row updates.

Parameters
int nStartIndex The start index of the first row within the range.
int nSize The number of rows within the range, which isn't used in this example