| Package | com.iwobanas.controls.dataGridClasses.filters |
| Class | public class ColumnFilterBase |
| Inheritance | ColumnFilterBase  flash.events.EventDispatcher |
| Subclasses | DateRangeFilter, MultipleChoiceFilter, NumberRangeFilter, WildcardFilter |
filterFunction function and isActive
variable used by MDataGrid to filter data| Property | Defined by | ||
|---|---|---|---|
| column : MDataGridColumn
MDataGrid column related to this filter.
| ColumnFilterBase | ||
| isActive : Boolean [read-only]
Flag indicating wether this filter is active
i.e may eliminate some items from MDataGrid data provider.
| ColumnFilterBase | ||
| Property | Defined by | ||
|---|---|---|---|
| dataGrid : MDataGrid
[read-only]
MDataGrid related to this filter.
| ColumnFilterBase | ||
| Method | Defined by | ||
|---|---|---|---|
|
ColumnFilterBase(column:MDataGridColumn)
Constructor.
| ColumnFilterBase | ||
|
filterFunction(obj:Object):Boolean
Test if given MDataGrid item should remain in MDataGrid data provider.
| ColumnFilterBase | ||
| Method | Defined by | ||
|---|---|---|---|
|
commitFilterChange():void
Inform MDataGrid about the change to this filter.
| ColumnFilterBase | ||
| Event | Summary | Defined by | ||
|---|---|---|---|---|
| Dispatched when the state of the filter changes. | ColumnFilterBase | |||
| column | property |
public var column:MDataGridColumnMDataGrid column related to this filter.
| dataGrid | property |
dataGrid:MDataGrid [read-only]MDataGrid related to this filter.
Implementation protected function get dataGrid():MDataGrid
| isActive | property |
isActive:Boolean [read-only]Flag indicating wether this filter is active i.e may eliminate some items from MDataGrid data provider. This getter should be overridden by concrete column filters.
This property can be used as the source for data binding.
Implementation public function get isActive():Boolean
| ColumnFilterBase | () | constructor |
public function ColumnFilterBase(column:MDataGridColumn)Constructor.
Parameterscolumn:MDataGridColumn |
| commitFilterChange | () | method |
protected function commitFilterChange():voidInform MDataGrid about the change to this filter.
| filterFunction | () | method |
public function filterFunction(obj:Object):BooleanTest if given MDataGrid item should remain in MDataGrid data provider. This function should be overridden by concrete column filters.
If filter is active this function is called by MDataGrid for every item
and if false is returned item is eliminated from data provider.
If true is returned item remains in data provider
unless other filter eliminate it.
This function might be called many times during one screen refresh so it should not be computationally expensive.
Parameters
obj:Object |
Boolean |
| filterValueChange | event |
com.iwobanas.controls.dataGridClasses.MDataGridEvent
Dispatched when the state of the filter changes. Such change may cause different MDataGrid items to be excluded from data provider.