com.flexicious.grids.filters.FilterExpression

	Property	Defined By
		columnName : String The property of the object to search on	FilterExpression
		expression : Object he expression to compare against	FilterExpression
		filterComparisionType : String This is ususally automatically set, you dont have to manually set it, unless you're sending strings as Date objects.	FilterExpression
		FILTER_COMPARISION_TYPE_AUTO : String [static]	FilterExpression
		FILTER_COMPARISION_TYPE_BOOLEAN : String [static]	FilterExpression
		FILTER_COMPARISION_TYPE_DATE : String [static]	FilterExpression
		FILTER_COMPARISION_TYPE_NUMBER : String [static]	FilterExpression
		FILTER_COMPARISION_TYPE_STRING : String [static]	FilterExpression
		filterControl : IFilterControl An IFilterControl that was responsible for the creation of this argument.	FilterExpression
		filterControlValue : Object For some filter controls, the expression is different than the selected value.	FilterExpression
		filterOperation : String The filter operation to apply - one of the FILTER_OPERATION_TYPE constant values	FilterExpression
		FILTER_OPERATION_TYPE_BEGINS_WITH : String [static]	FilterExpression
		FILTER_OPERATION_TYPE_BETWEEN : String [static]	FilterExpression
		FILTER_OPERATION_TYPE_CONTAINS : String [static]	FilterExpression
		FILTER_OPERATION_TYPE_DOES_NOT_CONTAIN : String [static]	FilterExpression
		FILTER_OPERATION_TYPE_ENDS_WITH : String [static]	FilterExpression
		FILTER_OPERATION_TYPE_EQUALS : String [static]	FilterExpression
		FILTER_OPERATION_TYPE_GREATER_THAN : String [static]	FilterExpression
		FILTER_OPERATION_TYPE_GREATERTHANEQUALS : String [static]	FilterExpression
		FILTER_OPERATION_TYPE_IN_LIST : String [static]	FilterExpression
		FILTER_OPERATION_TYPE_IS_NOT_NULL : String [static]	FilterExpression
		FILTER_OPERATION_TYPE_IS_NULL : String [static]	FilterExpression
		FILTER_OPERATION_TYPE_LESS_THAN : String [static]	FilterExpression
		FILTER_OPERATION_TYPE_LESS_THAN_EQUALS : String [static]	FilterExpression
		FILTER_OPERATION_TYPE_NONE : String [static]	FilterExpression
		FILTER_OPERATION_TYPE_NOT_EQUALS : String [static]	FilterExpression
		FILTER_OPERATION_TYPE_NOT_IN_LIST : String [static]	FilterExpression
		recurse : Boolean Applies to Ultimate only.	FilterExpression
		staticEventDispatcher : IEventDispatcher [static] [read-only]	FilterExpression
		wasContains : Boolean = false	FilterExpression

	Method	Defined By
		FilterExpression(columnName:String, filterOperation:String = Equals, expression:Object = null) Creates a filter expression	FilterExpression
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, weakRef:Boolean = false):void	FilterExpression
		clone():FilterExpression	FilterExpression
		convert(filterComparisionType:String, object:Object):Object [static]	FilterExpression
		copyFrom(filterExpression:Object):FilterExpression	FilterExpression
		createFilterExpression(filter:Filter, columnName:String, filterOperation:String, expression:Object, wasContains:Boolean = false):FilterExpression [static] Creates a filter expression	FilterExpression
		dispatchEvent(event:Event):Boolean	FilterExpression
		hasEventListener(type:String):Boolean	FilterExpression
		parseBoolean(str:String):Boolean [static]	FilterExpression
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void	FilterExpression
		willTrigger(type:String):Boolean	FilterExpression

Property Detail

columnName

property

columnName:String

The property of the object to search on

Implementation
public function get columnName():String
public function set columnName(value:String):void

expression

property

expression:Object

he expression to compare against

Implementation
public function get expression():Object
public function set expression(value:Object):void

FILTER_COMPARISION_TYPE_AUTO

property

FILTER_COMPARISION_TYPE_AUTO:String

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

Implementation
public static function get FILTER_COMPARISION_TYPE_AUTO():String
public static function set FILTER_COMPARISION_TYPE_AUTO(value:String):void

FILTER_COMPARISION_TYPE_BOOLEAN

property

FILTER_COMPARISION_TYPE_BOOLEAN:String

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

Implementation
public static function get FILTER_COMPARISION_TYPE_BOOLEAN():String
public static function set FILTER_COMPARISION_TYPE_BOOLEAN(value:String):void

FILTER_COMPARISION_TYPE_DATE

property

FILTER_COMPARISION_TYPE_DATE:String

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

Implementation
public static function get FILTER_COMPARISION_TYPE_DATE():String
public static function set FILTER_COMPARISION_TYPE_DATE(value:String):void

FILTER_COMPARISION_TYPE_NUMBER

property

FILTER_COMPARISION_TYPE_NUMBER:String

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

Implementation
public static function get FILTER_COMPARISION_TYPE_NUMBER():String
public static function set FILTER_COMPARISION_TYPE_NUMBER(value:String):void

FILTER_COMPARISION_TYPE_STRING

property

FILTER_COMPARISION_TYPE_STRING:String

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

Implementation
public static function get FILTER_COMPARISION_TYPE_STRING():String
public static function set FILTER_COMPARISION_TYPE_STRING(value:String):void

FILTER_OPERATION_TYPE_BEGINS_WITH

property

FILTER_OPERATION_TYPE_BEGINS_WITH:String

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

Implementation
public static function get FILTER_OPERATION_TYPE_BEGINS_WITH():String
public static function set FILTER_OPERATION_TYPE_BEGINS_WITH(value:String):void

FILTER_OPERATION_TYPE_BETWEEN

property

FILTER_OPERATION_TYPE_BETWEEN:String

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

Implementation
public static function get FILTER_OPERATION_TYPE_BETWEEN():String
public static function set FILTER_OPERATION_TYPE_BETWEEN(value:String):void

FILTER_OPERATION_TYPE_CONTAINS

property

FILTER_OPERATION_TYPE_CONTAINS:String

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

Implementation
public static function get FILTER_OPERATION_TYPE_CONTAINS():String
public static function set FILTER_OPERATION_TYPE_CONTAINS(value:String):void

FILTER_OPERATION_TYPE_DOES_NOT_CONTAIN

property

FILTER_OPERATION_TYPE_DOES_NOT_CONTAIN:String

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

Implementation
public static function get FILTER_OPERATION_TYPE_DOES_NOT_CONTAIN():String
public static function set FILTER_OPERATION_TYPE_DOES_NOT_CONTAIN(value:String):void

FILTER_OPERATION_TYPE_ENDS_WITH

property

FILTER_OPERATION_TYPE_ENDS_WITH:String

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

Implementation
public static function get FILTER_OPERATION_TYPE_ENDS_WITH():String
public static function set FILTER_OPERATION_TYPE_ENDS_WITH(value:String):void

FILTER_OPERATION_TYPE_EQUALS

property

FILTER_OPERATION_TYPE_EQUALS:String

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

Implementation
public static function get FILTER_OPERATION_TYPE_EQUALS():String
public static function set FILTER_OPERATION_TYPE_EQUALS(value:String):void

FILTER_OPERATION_TYPE_GREATER_THAN

property

FILTER_OPERATION_TYPE_GREATER_THAN:String

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

Implementation
public static function get FILTER_OPERATION_TYPE_GREATER_THAN():String
public static function set FILTER_OPERATION_TYPE_GREATER_THAN(value:String):void

FILTER_OPERATION_TYPE_GREATERTHANEQUALS

property

FILTER_OPERATION_TYPE_GREATERTHANEQUALS:String

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

Implementation
public static function get FILTER_OPERATION_TYPE_GREATERTHANEQUALS():String
public static function set FILTER_OPERATION_TYPE_GREATERTHANEQUALS(value:String):void

FILTER_OPERATION_TYPE_IN_LIST

property

FILTER_OPERATION_TYPE_IN_LIST:String

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

Implementation
public static function get FILTER_OPERATION_TYPE_IN_LIST():String
public static function set FILTER_OPERATION_TYPE_IN_LIST(value:String):void

FILTER_OPERATION_TYPE_IS_NOT_NULL

property

FILTER_OPERATION_TYPE_IS_NOT_NULL:String

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

Implementation
public static function get FILTER_OPERATION_TYPE_IS_NOT_NULL():String
public static function set FILTER_OPERATION_TYPE_IS_NOT_NULL(value:String):void

FILTER_OPERATION_TYPE_IS_NULL

property

FILTER_OPERATION_TYPE_IS_NULL:String

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

Implementation
public static function get FILTER_OPERATION_TYPE_IS_NULL():String
public static function set FILTER_OPERATION_TYPE_IS_NULL(value:String):void

FILTER_OPERATION_TYPE_LESS_THAN

property

FILTER_OPERATION_TYPE_LESS_THAN:String

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

Implementation
public static function get FILTER_OPERATION_TYPE_LESS_THAN():String
public static function set FILTER_OPERATION_TYPE_LESS_THAN(value:String):void

FILTER_OPERATION_TYPE_LESS_THAN_EQUALS

property

FILTER_OPERATION_TYPE_LESS_THAN_EQUALS:String

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

Implementation
public static function get FILTER_OPERATION_TYPE_LESS_THAN_EQUALS():String
public static function set FILTER_OPERATION_TYPE_LESS_THAN_EQUALS(value:String):void

FILTER_OPERATION_TYPE_NONE

property

FILTER_OPERATION_TYPE_NONE:String

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

Implementation
public static function get FILTER_OPERATION_TYPE_NONE():String
public static function set FILTER_OPERATION_TYPE_NONE(value:String):void

FILTER_OPERATION_TYPE_NOT_EQUALS

property

FILTER_OPERATION_TYPE_NOT_EQUALS:String

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

Implementation
public static function get FILTER_OPERATION_TYPE_NOT_EQUALS():String
public static function set FILTER_OPERATION_TYPE_NOT_EQUALS(value:String):void

FILTER_OPERATION_TYPE_NOT_IN_LIST

property

FILTER_OPERATION_TYPE_NOT_IN_LIST:String

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

Implementation
public static function get FILTER_OPERATION_TYPE_NOT_IN_LIST():String
public static function set FILTER_OPERATION_TYPE_NOT_IN_LIST(value:String):void

filterComparisionType

property

filterComparisionType:String

This is ususally automatically set, you dont have to manually set it, unless you're sending strings as Date objects. When set, will attempt to first convert the current value to the type you specified and then do the conversion.

Implementation
public function get filterComparisionType():String
public function set filterComparisionType(value:String):void

filterControl

property

filterControl:IFilterControl

An IFilterControl that was responsible for the creation of this argument. Used in case of IConverterFilterControl, which in addition to being a filter control, also encapsulates the logic of performing the comparisions and actual matching of the filter criteria.

Implementation
public function get filterControl():IFilterControl
public function set filterControl(value:IFilterControl):void

filterControlValue

property

filterControlValue:Object

For some filter controls, the expression is different than the selected value. We store the actual value of the filter control, so it can be rebuilt.

Implementation
public function get filterControlValue():Object
public function set filterControlValue(value:Object):void

filterOperation

property

filterOperation:String

The filter operation to apply - one of the FILTER_OPERATION_TYPE constant values

Implementation
public function get filterOperation():String
public function set filterOperation(value:String):void

recurse

property

recurse:Boolean

Applies to Ultimate only. When set to true, will check to see if either the current item, or any of it's children or grandchildren match the criteria. Used in hierarchical searches, when the parent does not match, but one of the children matches so we have to show the parent as well.

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

Implementation
public function get recurse():Boolean
public function set recurse(value:Boolean):void

staticEventDispatcher

property

staticEventDispatcher:IEventDispatcher [read-only]

Implementation
public static function get staticEventDispatcher():IEventDispatcher

wasContains

property

public var wasContains:Boolean = false

Constructor Detail

FilterExpression

()

Constructor

public function FilterExpression(columnName:String, filterOperation:String = Equals, expression:Object = null)

Creates a filter expression

Parameters

	`columnName:String` — The column to search

	`filterOperation:String` (default = `Equals`) — The filter operation to apply. See the list of FILTER_OPERATION_TYPE constants

	`expression:Object` (default = `null`) — The expression to compare against

Method Detail

addEventListener

()

method

 public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, weakRef:Boolean = false):void

Parameters

	`type:String`

	`listener:Function`

	`useCapture:Boolean` (default = `false`)

	`priority:int` (default = `0`)

	`weakRef:Boolean` (default = `false`)

clone

()

method

public function clone():FilterExpression

Returns

FilterExpression

convert

()

method

public static function convert(filterComparisionType:String, object:Object):Object

Parameters

	`filterComparisionType:String`

	`object:Object`

Returns

Object

copyFrom

()

method

public function copyFrom(filterExpression:Object):FilterExpression

Parameters

filterExpression:Object

Returns

FilterExpression

createFilterExpression

()

method

 public static function createFilterExpression(filter:Filter, columnName:String, filterOperation:String, expression:Object, wasContains:Boolean = false):FilterExpression

Creates a filter expression

Parameters

	`filter:Filter` — The filter create the expression for

	`columnName:String` — The column to search

	`filterOperation:String` — The filter operation to apply. See the list of FILTER_OPERATION_TYPE constants

	`expression:Object` — The expression to compare against

	`wasContains:Boolean` (default = `false`)

Returns

FilterExpression

dispatchEvent

()

method

public function dispatchEvent(event:Event):Boolean

Parameters

event:Event

Returns

Boolean

hasEventListener

()

method

public function hasEventListener(type:String):Boolean

Parameters

type:String

Returns

Boolean

parseBoolean

()

method

public static function parseBoolean(str:String):Boolean

Parameters

str:String

Returns

Boolean

removeEventListener

()

method

public function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void

Parameters

	`type:String`

	`listener:Function`

	`useCapture:Boolean` (default = `false`)

willTrigger

()

method

public function willTrigger(type:String):Boolean

Parameters

type:String

Returns

Boolean

Mon Jun 24 2013, 11:00 PM -04:00

Flexicious Library Documentation	All Packages \| All Classes \| Index \| Frames No Frames
FilterExpression	Properties \| Methods

Package	com.flexicious.grids.filters
Class	public class FilterExpression
Inheritance	FilterExpression Object
Implements	flash.events.IEventDispatcher