► caplin.grid.GridRowModel()

► <static> caplin.grid.GridRowModel.FILTERING

A constant definition used with #supportsFeature to allow row models to declare whether they support filtering.

Row models that do support filtering will need access to the caplin.grid.GridColumnModel they are working in tandem with (e.g. by having the column model as one of their constructor parameters) so that they can listen to the column model events — in particular caplin.grid.GridColumnModelListener#onFiltersChanged and caplin.grid.GridColumnModelListener#onApplyFilters.

► <static> caplin.grid.GridRowModel.SORTING

A constant definition used with #supportsFeature to allow row models to declare whether they support sorting.

Row models that do support sorting will need access to the caplin.grid.GridColumnModel they are working in tandem with (e.g. by having the column model as one of their constructor parameters) so that they can listen to the column model events — in particular caplin.grid.GridColumnModelListener#onSortColumnChanged.

► void addRow(String sSubject)

Adds a row to the GridRowModel.

► void addRowModelListener(caplin.grid.GridRowModelListener oRowModelListener)

Adds a listener to the row model, to be communicated of all row model events.

See

#removeRowModelListener

► void clearFilterExpression(String sFilterName)

Removes the named filter expression from the row model.

The filter name parameter is optional. If no parameter is passed then the 'default' parameter expression will be removed.

► void clearGroupByField()

Removes any grouping from the grid row model.

► void clearSortRule()

Removes any sorting from the grid row model.

► Map getAllFilterExpressions()

Returns a map of all filter expressions.

The returned map should not be modified by external clients as it is may be used internally by the row model class.

► caplin.grid.filter.FilterExpression getFilterExpression(String sFilterName)

Returns the named filter expression.

The filter name parameter is optional. If no parameter is passed then the 'default' parameter expression will be returned.

Returns

the filter with the specified name.

► caplin.grid.GridDataProvider getGridDataProvider()

Returns the grid data provider which the row model listens to for data updates.

► String getGroupByField()

Get the field, if one has been set, that is used to group the rows contained within row model.

Returns

a String, if one exists, or null otherwise.

► int getIndexBySubject(String sSubject)

Return the index of a subject.

► caplin.services.security.PermissionKey getPermissionKey()

Returns a tuple containing the permissioning search query parameters that can be used to determine whether the user has the available permissions to view the data contained within this row model.

Row models whose data is not permissioned do not need to return a permissioning key, and may instead return null.

Returns

the permissioning key tuple, or null

See

caplin.component.Component#getPermissionKey

► Object getRowData(int nIndex)

Returns the row data record at the specified index.

Returns

the row data for the specified index.

► int getRowRangeSize()

Returns the size of the row range that is set with the setRowRange method.

► String getSerializedState()

Invoked when the grid is saved.

Returns

An XML representation of the current state of this GridRowModel. This may be an empty string if the row model was configured by a parent grid definition.

► int getSize()

Returns the number of rows available — not the number of rows that are currently visible.

Returns

The number of rows available

► caplin.grid.sort.SortRule getSortRule()

Get the rule, if one exists, that is used to sort the data within the row model.

Returns

a caplin.grid.sort.SortRule, if one exists, or null otherwise.

► int getStartIndex()

Returns the start index of the row model which can be used to see how many rows have been scrolled.

Returns

The start index

► String getSubjectId(int nIndex)

Returns the RTTP subject identifier for the row at the specified index.

Row models whose rows correspond to objects that can be requested from a Liberator should use this method to make that information available — this may be true even for row models where the data itself does not come from a Liberator (e.g. a custom web-service) provided the row data corresponds to requestable objects within the Liberator. Some decorators (such as the caplin.grid.decorator.DragDecorator require this information in order to allow dragging & dropping of row data into trade panels or custom grids. Row models whose data does not correspond to requestable objects within the Liberator can instead return null.

Returns

the RTTP subject identifier (e.g. /FX/EURUSD) for the given row, or null otherwise.

► void getSubjects()

Deprecated

Use #getVisibleSubjects instead.

► String getTransformMode()

Get the transform mode that determines how grid updates are pushed out from the data source.

Returns

The transform mode - either 'snapshot' or 'live'

► Array getVisibleSubjects()

Returns an array of subjects currently in the model (corresponding to visible rows), in order.

Returns

the visible subject

► void pauseUpdates()

Signals the GridRowModel to temporarily pause any updates to all RowModelListener instances.

See

#resumeUpdates

► void removeRow(String sSubject)

Removes a row from the GridRowModel.

► void removeRowModelListener(caplin.grid.GridRowModelListener oRowModelListener)

Removes a listener that no longer wishes to listen to row model events.

See

#addRowModelListener

► void removeRows(String pSubjects)

Removes a number of rows from the GridRowModel.

► void resumeUpdates()

Signals the GridRowModel to resume updates to any RowModelListener instances.

See

#pauseUpdates

► void setFilterExpression(caplin.grid.filter.FilterExpression oFilterExpression, String sFilterName)

Add a filter expression to this row model.

The filter name parameter is optional. If no parameter is passed then this filter expression will be assumed to be 'default'.

► void setGroupByField(String sFieldName)

Sets the field to be used for grouping the rows within the row model.

► void setRowData(String nIndex, Map mRowData)

Method added to allow editing data inside grid. Sets the field value for the row with the specific index

► void setRowRange(int nStartIndex, int nSize)

Sets the start index and total number of rows that the caplin.grid.GridView is able to display, and hence the the row model should provide.

► void setSortRule(caplin.grid.sort.SortRule oSortRule)

Set a rule that will be used to sort the data within the row model.

► void supportsFeature(int nFeature)

Determine whether this instance of GridRowModel supports a particular feature.

See

#SORTING

#FILTERING

► void terminateUpdates()

Signals the GridRowModel to terminate all updates to any RowModelListener instances.

This method is essentially the destructor for classes implementing GridRowModel, and is the opportunity to perform any clean-up that may be required.