Interface: 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:

• module:caplin/grid/GridColumnModel#applyFilters

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:

• module:caplin/grid/decorator/ColumnResizingDecorator#onColumnsAdded
• module:caplin/grid/decorator/ColumnSortDecorator#onColumnsAdded
• module:caplin/grid/GridView#onColumnsAdded

See:

• module:caplin/grid/GridColumnModelListener#onColumnsRemoved

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:

• module:caplin/grid/decorator/ColumnResizingDecorator#onColumnsRemoved
• module:caplin/grid/GridView#onColumnsRemoved

See:

• module:caplin/grid/GridColumnModelListener#onColumnsAdded

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:

• module:caplin/grid/GridView#onFiltersChanged

See:

• module:caplin/grid/GridColumn#addFilter
• module:caplin/grid/GridColumnModel#clearAllFilters

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:

• module:caplin/grid/GridColumnModel#getRequiredFields

onSortColumnChanged()

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

Implementations:

• module:caplin/grid/DataProviderRowModel#onSortColumnChanged
• module:caplin/grid/decorator/ColumnSortDecorator#onSortColumnChanged
• module:caplin/grid/GridView#onSortColumnChanged

See:

• module:caplin/grid/GridColumnModel#getSortColumn
• module:caplin/grid/GridColumn#setSortOrder

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:

• module:caplin/grid/GridView#onWidthChanged