Caplin Trader 5.1.0

Interface: module:ct-grid/GridColumnModelListener

module:ct-grid/GridColumnModelListener

GridColumnModelListener defines an interface for classes that wish to listen to module:ct-grid/GridColumnModel events.

Methods

onApplyFilters()

An event method that is called when the filters have been applied on the module:ct-grid/GridColumns within the module:ct-grid/GridColumnModel.

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:ct-grid/GridColumns that were added to the model.

nStartIndex int

The start index at which the first column in the specified list was added.

See:

onColumnsRemoved(pGridColumns, nStartIndex)

An event method that is called when a column has been removed from to the module:ct-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:ct-grid/GridColumns that were removed from the model.

nStartIndex int

The start index at which the first column in the specified list was removed.

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:ct-grid/GridColumn

The grid column instance where the event occurred.

See:

onRequiredFieldsChanged(pFields)

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

All module:ct-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:ct-grid/GridColumns within the module:ct-grid/GridColumnModel.

See:

onSortColumnChanged()

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

See:

onWidthChanged(oGridColumn)

An event method that is called when a column's width has been changed.

Parameters:
Name Type Description
oGridColumn module:ct-grid/GridColumn

The grid column where the event occurred.