Packagecom.iwobanas.controls.dataGridClasses.filters
Classpublic class MultipleChoiceFilter
InheritanceMultipleChoiceFilter Inheritance ColumnFilterBase Inheritance flash.events.EventDispatcher

The MultipleChoiceFilter class defines MDataGrid column filter exposing the list of different values appearing in MDataGrid column and allowing user to select which values should be displayed. This filter should be applied to columns containing repeating values.



Public Properties
 PropertyDefined by
 Inheritedcolumn : 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.
MultipleChoiceFilter
  labels : ArrayCollection
List of all different labels appearing in column related to this filter.
MultipleChoiceFilter
  selectedLabels : ArrayCollection
List of selected labels.
MultipleChoiceFilter
Protected Properties
 PropertyDefined by
 InheriteddataGrid : MDataGrid
MDataGrid related to this filter.
ColumnFilterBase
Public Methods
 MethodDefined by
  
Constructor.
MultipleChoiceFilter
  
deselectAll():void
Deselect all labels.
MultipleChoiceFilter
  
deselectLabel(label:String):void
Deselect given label by adding it to selectedLabels list.
MultipleChoiceFilter
  
filterFunction(obj:Object):Boolean
Test if given MDataGrid item should remain in MDataGrid data provider.
MultipleChoiceFilter
  
selectAll():void
Select all labels.
MultipleChoiceFilter
  
selectLabel(label:String):void
Select given label by adding it to selectedLabels list.
MultipleChoiceFilter
Protected Methods
 MethodDefined by
  
Update isActive and then inform MDataGrid about the change to this filter.
MultipleChoiceFilter
  
MDataGrid original collection change event handler.
MultipleChoiceFilter
  
updateLabels():void
Update labels list by iterating through MDataGrid original collection.
MultipleChoiceFilter
Events
 EventSummaryDefined by
 Inherited Dispatched when the state of the filter changes.ColumnFilterBase
Property detail
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
labelsproperty 
public var labels:ArrayCollection

List of all different labels appearing in column related to this filter.

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

selectedLabelsproperty 
public var selectedLabels:ArrayCollection

List of selected labels. Only items with labels from this list will be included in MDataGrid data provider.

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

Constructor detail
MultipleChoiceFilter()constructor
public function MultipleChoiceFilter(column:MDataGridColumn)

Constructor.

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

Update isActive and then inform MDataGrid about the change to this filter.

deselectAll()method 
public function deselectAll():void

Deselect all labels.

deselectLabel()method 
public function deselectLabel(label:String):void

Deselect given label by adding it to selectedLabels list.

Parameters
label:String
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
originalCollectionChandeHandler()method 
protected function originalCollectionChandeHandler(event:Event):void

MDataGrid original collection change event handler.

Parameters
event:Event
selectAll()method 
public function selectAll():void

Select all labels.

selectLabel()method 
public function selectLabel(label:String):void

Select given label by adding it to selectedLabels list.

Parameters
label:String
updateLabels()method 
protected function updateLabels():void

Update labels list by iterating through MDataGrid original collection.