| Package | org.openzet.controls.dataGridClasses.filter |
| Class | public class FilterHelper |
See also
| Property | Defined by | ||
|---|---|---|---|
| dataProvider : Object
A property to set dataProvider.
| FilterHelper | ||
| Method | Defined by | ||
|---|---|---|---|
|
addAllField(dataField:String):void
Method to register a certain column as one with all of its items are checked.
| FilterHelper | ||
|
addFilters(checkedItems:Array, uncheckedItems:Array, isAllChecked:Boolean):void
Method to add filtering information.
| FilterHelper | ||
|
getDataByField(dataField:String):ArrayCollection
Method to return ditinct and filtered data of a certain column.
| FilterHelper | ||
|
getFilterDataByField(dataField:String):Array
Method to return filtered data of a certain column.
| FilterHelper | ||
| dataProvider | property |
dataProvider:Object [read-write]A property to set dataProvider. FilterHelper instance hold this dataProvider and splits this data for each column and redistributes the data to FilterPopup instances for each column.
Implementation public function get dataProvider():Object
public function set dataProvider(value:Object):void
| addAllField | () | method |
public function addAllField(dataField:String):voidMethod to register a certain column as one with all of its items are checked. IF a certain column's all items are checked, then the column is excluded from the fields to be checked when performing data filtering since the field's all data should match data filtering criteria in this case.
ParametersdataField:String — A column's dataField where all items are checked.
|
| addFilters | () | method |
public function addFilters(checkedItems:Array, uncheckedItems:Array, isAllChecked:Boolean):voidMethod to add filtering information. This method is called by FilterPopUp instance when user clicks Confirm button.
ParameterscheckedItems:Array — An array of items that are checked.
|
|
uncheckedItems:Array — An array of items that are unchecked.
|
|
isAllChecked:Boolean — A flag indicating whether all items of a certain column are checked or not.
|
| getDataByField | () | method |
public function getDataByField(dataField:String):ArrayCollectionMethod to return ditinct and filtered data of a certain column.
ParametersdataField:String — A column's datafield from where to extract data
|
ArrayCollection — An ArrayCollection instance with distinct data values of each column
|
| getFilterDataByField | () | method |
public function getFilterDataByField(dataField:String):ArrayMethod to return filtered data of a certain column.
ParametersdataField:String — A column's datafield from where to extract data
|
Array — An Array instance with filter information of a certain column
|