Packagecom.iwobanas.controls.dataGridClasses.filters
Classpublic class DateRangeFilter
InheritanceDateRangeFilter Inheritance ColumnFilterBase Inheritance flash.events.EventDispatcher

The DateRangeFilter class defines MDataGrid column filter which filters rows containing dates based on specified minimum and maximum values.

This filter also provides information about range of dates found in MDataGrid data provider.



Public Properties
 PropertyDefined by
 Inheritedcolumn : MDataGridColumn
MDataGrid column related to this filter.
ColumnFilterBase
  dataMaximum : Date
Maximum date found in MDataGrid column related to this filter
DateRangeFilter
  dataMinimum : Date
Minimum date found in MDataGrid column related to this filter.
DateRangeFilter
  isActive : Boolean
[read-only] Flag indicating wether this filter is active i.e may eliminate some items from MDataGrid data provider.
DateRangeFilter
  maximum : Date
Maximum date allowed in MDataGrid column related to this filter.
DateRangeFilter
  minimum : Date
Minimum date allowed in MDataGrid column related to this filter.
DateRangeFilter
Protected Properties
 PropertyDefined by
 InheriteddataGrid : MDataGrid
MDataGrid related to this filter.
ColumnFilterBase
Public Methods
 MethodDefined by
  
Constructor.
DateRangeFilter
  
filterFunction(obj:Object):Boolean
Test if given MDataGrid item should remain in MDataGrid data provider.
DateRangeFilter
Protected Methods
 MethodDefined by
 Inherited
Inform MDataGrid about the change to this filter.
ColumnFilterBase
  
itemToDate(item:Object):Date
Return date for the given item.
DateRangeFilter
  
Update dataMinimum and dataMaximum values.
DateRangeFilter
Events
 EventSummaryDefined by
 Inherited Dispatched when the state of the filter changes.ColumnFilterBase
Property detail
dataMaximumproperty
public var dataMaximum:Date

Maximum date found in MDataGrid column related to this filter

This property can be used as the source for data binding.

dataMinimumproperty 
public var dataMinimum:Date

Minimum date found in MDataGrid column related to this filter.

This property can be used as the source for data binding.

isActiveproperty 
isActive:Boolean  [read-only]

Flag indicating wether this filter is active i.e may eliminate some items from MDataGrid data provider.

Implementation
    public function get isActive():Boolean
maximumproperty 
maximum:Date  [read-write]

Maximum date allowed in MDataGrid column related to this filter. Items with date greater than minimum will be eliminated.

This property can be used as the source for data binding.

Implementation
    public function get maximum():Date
    public function set maximum(value:Date):void
minimumproperty 
minimum:Date  [read-write]

Minimum date allowed in MDataGrid column related to this filter. Items with date less than minimum will be eliminated.

This property can be used as the source for data binding.

Implementation
    public function get minimum():Date
    public function set minimum(value:Date):void
Constructor detail
DateRangeFilter()constructor
public function DateRangeFilter(column:MDataGridColumn)

Constructor.

Parameters
column:MDataGridColumn
Method detail
filterFunction()method
public override function filterFunction(obj:Object):Boolean

Test if given MDataGrid item should remain in MDataGrid data provider.

Parameters
obj:Object

Returns
Boolean
itemToDate()method 
protected function itemToDate(item:Object):Date

Return date for the given item.

Parameters
item:Object — MDataGrid item.

Returns
Date — numeric value for the given item.
updateOriginalDateRange()method 
protected function updateOriginalDateRange():void

Update dataMinimum and dataMaximum values.