Home | Class Index

SDK Version: 3.11.4-302512

Documentation generated on 24 July 2015

Interface
caplin.grid

GridColumnModelListener

GridColumnModelListener defines an interface for classes that wish to listen to caplin.grid.GridColumnModel events.

Constructor Summary

Attributes Name and Description
caplin.grid.GridColumnModelListener()

Method Summary

Attributes Name and Description
void onApplyFilters()

An event method that is called when the filters have been applied on the caplin.grid.GridColumns within the caplin.grid.GridColumnModel.
void onColumnsAdded(Array pGridColumns, int nStartIndex)

An event method that is called when a column has been added to the GridColumnModel.
void onColumnsRemoved(Array pGridColumns, int nStartIndex)

An event method that is called when a column has been removed from to the caplin.grid.GridColumnModel.
void onFiltersChanged(caplin.grid.GridColumn oGridColumn)

An event method that is fired when a GridColumn has had any of its filters changed.
void onRequiredFieldsChanged(Array pFields)

An event method that is called when the fields required by all the caplin.grid.GridColumns within the caplin.grid.GridColumnModel change.
void onSortColumnChanged()

An event method that is fired when the caplin.grid.GridColumn that will be used to sort the grid has changed.
void onWidthChanged(caplin.grid.GridColumn oGridColumn)

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

Constructor Detail

► caplin.grid.GridColumnModelListener()

Method Detail

► void onApplyFilters()

An event method that is called when the filters have been applied on the caplin.grid.GridColumns within the caplin.grid.GridColumnModel.

See
caplin.grid.GridColumnModel#applyFilters

► void onColumnsAdded(Array pGridColumns, int 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
Array pGridColumns An array of caplin.grid.GridColumns that were added to the model.
int nStartIndex The start index at which the first column in the specified list was added.
See
#onColumnsRemoved

► void onColumnsRemoved(Array pGridColumns, int nStartIndex)

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

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

Parameters
Array pGridColumns An array of caplin.grid.GridColumns that were removed from the model.
int nStartIndex The start index at which the first column in the specified list was removed.
See
#onColumnsAdded

► void onFiltersChanged(caplin.grid.GridColumn oGridColumn)

An event method that is fired when a GridColumn has had any of its filters changed.

Parameters
caplin.grid.GridColumn oGridColumn The grid column instance where the event occurred.
See
caplin.grid.GridColumn#addFilter
caplin.grid.GridColumnModel#clearAllFilters

► void onRequiredFieldsChanged(Array pFields)

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

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

Parameters
Array pFields An array of field names as strings that are required by the caplin.grid.GridColumns within the caplin.grid.GridColumnModel.
See
caplin.grid.GridColumnModel#getRequiredFields

► void onSortColumnChanged()

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

See
caplin.grid.GridColumnModel#getSortColumn
caplin.grid.GridColumn#setSortOrder

► void onWidthChanged(caplin.grid.GridColumn oGridColumn)

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

Parameters
caplin.grid.GridColumn oGridColumn The grid column where the event occurred.