Home | Class Index

SDK Version: 3.11.4-302512

Documentation generated on 24 July 2015

Class
caplin.grid

GridColumnFilter

The GridColumnFilter is a used to restrict the rows present within a grid by omitting all records that do not match some given filter(s). Filters are applied to columns using the caplin.grid.GridColumn#addFilter method, but this class itself is merely a simple data tuple; it is the responsibility of the caplin.grid.GridRowModel or caplin.grid.GridDataProvider to perform the actual filtering itself.

Constructor Summary

Attributes Name and Description
caplin.grid.GridColumnFilter(String filterField, int filterType, String filterValue)

Constructs a caplin.grid.GridColumnFilter tuple.

Field Summary

Attributes Name and Description
<static> caplin.grid.GridColumnFilter.EXACT_MATCH

Constant corresponding to the exact match filter type.
filterField

The field to perform the filter on.
filterType

The type of filter to be applied — one of #LESS_THAN, #GREATER_THAN, #EXACT_MATCH, #NOT_EQUAL, #NUMERIC_MATCH, #NUMERIC_NOT_MATCH, #PARTIAL_MATCH, #WILDCARD, #WILDCARD_CASE_SENSITIVE, #REGULAR_EXPRESSION or #REGULAR_EXPRESSION_CASE_INSENSITIVE.
filterValue

The value to actually filter on.
<static> caplin.grid.GridColumnFilter.GREATER_THAN

Constant corresponding to the greater than filter type.
<static> caplin.grid.GridColumnFilter.GREATER_THAN_OR_EQUAL

Constant corresponding to the greater than or equal filter type.
<static> caplin.grid.GridColumnFilter.LESS_THAN

Constant corresponding to the less than filter type.
<static> caplin.grid.GridColumnFilter.LESS_THAN_OR_EQUAL

Constant corresponding to the less than or equal filter type.
<static> caplin.grid.GridColumnFilter.NOT_EQUAL

Constant corresponding to the not equal filter type.
<static> caplin.grid.GridColumnFilter.NUMERIC_MATCH

Constant corresponding to the numeric match filter type.
<static> caplin.grid.GridColumnFilter.NUMERIC_NOT_MATCH

Constant corresponding to the numeric not match filter type.
<static> caplin.grid.GridColumnFilter.PARTIAL_MATCH

Constant corresponding to the partial match filter type.
<static> caplin.grid.GridColumnFilter.REGULAR_EXPRESSION

Constant corresponding to the regular expression filter type.
<static> caplin.grid.GridColumnFilter.REGULAR_EXPRESSION_CASE_INSENSITIVE

Constant corresponding to the regular expression filter type.
<static> caplin.grid.GridColumnFilter.WILDCARD

Constant corresponding to the wild card filter type.
<static> caplin.grid.GridColumnFilter.WILDCARD_CASE_SENSITIVE

Constant corresponding to the wild card filter type.

Constructor Detail

► caplin.grid.GridColumnFilter(String filterField, int filterType, String filterValue)

Constructs a caplin.grid.GridColumnFilter tuple.

Parameters
String filterField The field to perform the filter on.
int filterType The type of filter to be applied.
String filterValue The value to actually filter on.

Field Detail

► <static> int caplin.grid.GridColumnFilter.EXACT_MATCH

Constant corresponding to the exact match filter type.

► String filterField

The field to perform the filter on.

► int filterType

The type of filter to be applied — one of #LESS_THAN, #GREATER_THAN, #EXACT_MATCH, #NOT_EQUAL, #NUMERIC_MATCH, #NUMERIC_NOT_MATCH, #PARTIAL_MATCH, #WILDCARD, #WILDCARD_CASE_SENSITIVE, #REGULAR_EXPRESSION or #REGULAR_EXPRESSION_CASE_INSENSITIVE.

► String filterValue

The value to actually filter on.

► <static> int caplin.grid.GridColumnFilter.GREATER_THAN

Constant corresponding to the greater than filter type.

► <static> int caplin.grid.GridColumnFilter.GREATER_THAN_OR_EQUAL

Constant corresponding to the greater than or equal filter type.

► <static> int caplin.grid.GridColumnFilter.LESS_THAN

Constant corresponding to the less than filter type.

► <static> int caplin.grid.GridColumnFilter.LESS_THAN_OR_EQUAL

Constant corresponding to the less than or equal filter type.

► <static> int caplin.grid.GridColumnFilter.NOT_EQUAL

Constant corresponding to the not equal filter type.

► <static> int caplin.grid.GridColumnFilter.NUMERIC_MATCH

Constant corresponding to the numeric match filter type.

► <static> int caplin.grid.GridColumnFilter.NUMERIC_NOT_MATCH

Constant corresponding to the numeric not match filter type.

► <static> int caplin.grid.GridColumnFilter.PARTIAL_MATCH

Constant corresponding to the partial match filter type.

► <static> int caplin.grid.GridColumnFilter.REGULAR_EXPRESSION

Constant corresponding to the regular expression filter type.

► <static> int caplin.grid.GridColumnFilter.REGULAR_EXPRESSION_CASE_INSENSITIVE

Constant corresponding to the regular expression filter type.

► <static> int caplin.grid.GridColumnFilter.WILDCARD

Constant corresponding to the wild card filter type.

► <static> int caplin.grid.GridColumnFilter.WILDCARD_CASE_SENSITIVE

Constant corresponding to the wild card filter type.