Interface
caplin.grid.dataprovider.expandable

ChildContainerConfiguration

Constructor Summary

Attributes Name and Description
caplin.grid.dataprovider.expandable.ChildContainerConfiguration()

Method Summary

Attributes Name and Description
String getChildContainerName(Object mParentRowData, String sParentSubject)

Used to specify the name of the container to request to place in the child container .

void getContainerToExpanded( mParentRowData, sParentSubject)

Array getFieldsToRequest(caplin.grid.GridColumnModel oGridColumnModel)

This is the way to specify which fields to request for the child container.

Object mapUpdateFieldsToCurrentGridFields(Object mRecordUpdates)

When an update comes in for a child record it may need to be mapped.

Constructor Detail

caplin.grid.dataprovider.expandable.ChildContainerConfiguration()

Method Detail

String getChildContainerName(Object mParentRowData, String sParentSubject)

Used to specify the name of the container to request to place in the child container .

Parameters
Object mParentRowData the row data from the parent, all fields and their corresponding values.
String sParentSubject name of the parent subject.
Returns
{String} the child container name to request.

void getContainerToExpanded( mParentRowData, sParentSubject)

Parameters
mParentRowData
sParentSubject
See
caplin.grid.dataprovider.expandable.ChildContainerConfiguration#getChildContainerName

Array getFieldsToRequest(caplin.grid.GridColumnModel oGridColumnModel)

This is the way to specify which fields to request for the child container. The child container may have different field names then the parent one and this method permits requesting different field names. It will be called after a parent row has been clicked to trigger an expansion.

Parameters
caplin.grid.GridColumnModel oGridColumnModel the GridColumnModel for the grid.
Returns
{Array} an array with the fields to request for the child container.

Object mapUpdateFieldsToCurrentGridFields(Object mRecordUpdates)

When an update comes in for a child record it may need to be mapped. The fields of the update are the child container fields and those fields may not be present in the parent container/grid definition. This method allows mapping between the two different field sets.

Parameters
Object mRecordUpdates the row data for child row update.
Returns
{Object} a map of fields which are present in the parent grid to values.