Packagecom.iwobanas.controls.dataGridClasses.filters
Classpublic class ColumnFilterBase
InheritanceColumnFilterBase Inheritance flash.events.EventDispatcher
SubclassesDateRangeFilter, MultipleChoiceFilter, NumberRangeFilter, WildcardFilter

The ColumnFilterBase class defines base class for MDataGrid column filters. Column filters serves as model and controller in the MDataGrid filtering mechanism while filter editors represents view. Column filters are responsible for:



Public Properties
 PropertyDefined 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
Protected Properties
 PropertyDefined by
  dataGrid : MDataGrid
[read-only] MDataGrid related to this filter.
ColumnFilterBase
Public Methods
 MethodDefined by
  
Constructor.
ColumnFilterBase
  
filterFunction(obj:Object):Boolean
Test if given MDataGrid item should remain in MDataGrid data provider.
ColumnFilterBase
Protected Methods
 MethodDefined by
  
Inform MDataGrid about the change to this filter.
ColumnFilterBase
Events
 EventSummaryDefined by
   Dispatched when the state of the filter changes.ColumnFilterBase
Property detail
columnproperty
public var column:MDataGridColumn

MDataGrid column related to this filter.

dataGridproperty 
dataGrid:MDataGrid  [read-only]

MDataGrid related to this filter.

Implementation
    protected function get dataGrid():MDataGrid
isActiveproperty 
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
Constructor detail
ColumnFilterBase()constructor
public function ColumnFilterBase(column:MDataGridColumn)

Constructor.

Parameters
column:MDataGridColumn
Method detail
commitFilterChange()method
protected function commitFilterChange():void

Inform MDataGrid about the change to this filter.

filterFunction()method 
public function filterFunction(obj:Object):Boolean

Test 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

Returns
Boolean
Event detail
filterValueChangeevent 
Event object type: 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.