Caplin Trader 4.8.0

Interface: module:caplin/grid/GridColumnModelListener

module:caplin/grid/GridColumnModelListener

Methods

onApplyFilters()

An event method that is called when the filters have been applied on the module:caplin/grid/GridColumns within the module:caplin/grid/GridColumnModel.
Implementations:
  • module:caplin/grid/DataProviderRowModel#onApplyFilters
See:

onColumnsAdded(pGridColumns, nStartIndex)

An event method that is called when a column has been added to the GridColumnModel.

All GridColumn elements in the specified array are added in sequential order starting at the specified index.

Parameters:
Name Type Description
pGridColumns Array An array of module:caplin/grid/GridColumns that were added to the model.
nStartIndex int The start index at which the first column in the specified list was added.
Implementations:
See:

onColumnsRemoved(pGridColumns, nStartIndex)

An event method that is called when a column has been removed from to the module:caplin/grid/GridColumnModel.

All GridColumn elements in the specified array are removed in sequential order starting at the specified index.

Parameters:
Name Type Description
pGridColumns Array An array of module:caplin/grid/GridColumns that were removed from the model.
nStartIndex int The start index at which the first column in the specified list was removed.
Implementations:
See:

onFiltersChanged(oGridColumn)

An event method that is fired when a GridColumn has had any of its filters changed.
Parameters:
Name Type Description
oGridColumn module:caplin/grid/GridColumn The grid column instance where the event occurred.
Implementations:
See:

onRequiredFieldsChanged(pFields)

An event method that is called when the fields required by all the module:caplin/grid/GridColumns within the module:caplin/grid/GridColumnModel change.

All module:caplin/grid/GridColumn elements in the specified array are removed in sequential order starting at the specified index.

Parameters:
Name Type Description
pFields Array An array of field names as strings that are required by the module:caplin/grid/GridColumns within the module:caplin/grid/GridColumnModel.
Implementations:
  • module:caplin/grid/DataProviderRowModel#onRequiredFieldsChanged
See:

onSortColumnChanged()

An event method that is fired when the module:caplin/grid/GridColumn that will be used to sort the grid has changed.
Implementations:
See:

onWidthChanged(oGridColumn)

An event method that is called when a column's width has been changed.
Parameters:
Name Type Description
oGridColumn module:caplin/grid/GridColumn The grid column where the event occurred.
Implementations: