Home Reference Source 
import FilterContainerImpl from 'flexicious-react-datagrid/js/flexgrid/grids/filters/FilterContainerImpl.js'
public class | source

FilterContainerImpl

Extends:

TypedObject → FilterContainerImpl

A Class that encapsulates functionality that containers of filter controls should have.

Constructor Summary

Public Constructor
public

constructor(iEventDispatcher: *)

Member Summary

Public Members
public
public

Method Summary

Public Methods
public

Clear all filter controls
public
public

Return filter arguments
public

getFilterExpression(iFilterControl: *): flexiciousNmsp.FilterExpression

Get filter expression from filter control
public

getFilterValue(column: flexiciousNmsp.FlexDataGridColumn): Object

Get filter value from column
public

getNextFilter(event: *): *

public

getNextFocusableFilter(myIndex: Number, forward: Boolean, inclusive: Boolean): *

Returns next focusable filter

public

hasField(column: flexiciousNmsp.FlexDataGridColumn): Boolean

Check whether filter control search field belongs to this column or not
public

isIFilterControlRegistered(iFilterControl: *): *

Check whether filter control component already resgister or not
public

kill()

public

onChangeHandler(event: *)

public

onKeyUp(event: *)

public

Process filter
public

registerIFilterControl(iFilterControl: *)

Resgister a filter control component
public

Remove all filter controls
public

setFilterFocus(fld: *): *

public

setFilterValue(column: flexiciousNmsp.FlexDataGridColumn, value: Object)

Set filter value to column
public

setFocusOnChild(child: *)

set focus on its child component
public

unRegisterIFilterControl(iFilterControl: *)

Unresgister a filter control component

Inherited Summary

From class TypedObject
public

typeCache: {}

public
public

Returns a list of strings that represent the object hierarchy for this object.
public

Returns true if the class name to check is in the list of class names defined for this class.

Public Constructors

public constructor(iEventDispatcher: *) source

Override:

TypedObject#constructor

Params:

NameTypeAttributeDescription
iEventDispatcher *

Public Members

public filterControls: *[] source

public iEventDispatcher: * source

Public Methods

public clearFilter() source

Clear all filter controls

public getClassNames(): string source

Returns a list of strings that represent the object hierarchy for this object.

Override:

TypedObject#getClassNames

Return:

string

public getFilterArguments(): Array source

Return filter arguments

Return:

Array

public getFilterExpression(iFilterControl: *): flexiciousNmsp.FilterExpression source

Get filter expression from filter control

Params:

NameTypeAttributeDescription
iFilterControl *

Return:

flexiciousNmsp.FilterExpression

public getFilterValue(column: flexiciousNmsp.FlexDataGridColumn): Object source

Get filter value from column

Params:

NameTypeAttributeDescription
column flexiciousNmsp.FlexDataGridColumn

Return:

Object

value

public getNextFilter(event: *): * source

Params:

NameTypeAttributeDescription
event *

Return:

*

public getNextFocusableFilter(myIndex: Number, forward: Boolean, inclusive: Boolean): * source

Returns next focusable filter

Params:

NameTypeAttributeDescription
myIndex Number

current focusable filter index
forward Boolean

forward or backward mode
inclusive Boolean

exclusive or inclusive mode

Return:

*

public hasField(column: flexiciousNmsp.FlexDataGridColumn): Boolean source

Check whether filter control search field belongs to this column or not

Params:

NameTypeAttributeDescription
column flexiciousNmsp.FlexDataGridColumn

Return:

Boolean

public isIFilterControlRegistered(iFilterControl: *): * source

Check whether filter control component already resgister or not

Params:

NameTypeAttributeDescription
iFilterControl *

Return:

*

public kill() source

public onChangeHandler(event: *) source

Params:

NameTypeAttributeDescription
event *

public onKeyUp(event: *) source

Params:

NameTypeAttributeDescription
event *

public processFilter() source

Process filter

public registerIFilterControl(iFilterControl: *) source

Resgister a filter control component

Params:

NameTypeAttributeDescription
iFilterControl *

public resetFilterControls() source

Remove all filter controls

public setFilterFocus(fld: *): * source

Params:

NameTypeAttributeDescription
fld *

The string to match the searchField property of the filter control with.

Return:

*

True if focus was set, false if otherwise. Focus may not be set if the given search field does not exist,
or if the filter control for the given search field does not
implement IFocusManagerComponent.

public setFilterValue(column: flexiciousNmsp.FlexDataGridColumn, value: Object) source

Set filter value to column

Params:

NameTypeAttributeDescription
column flexiciousNmsp.FlexDataGridColumn
value Object

public setFocusOnChild(child: *) source

set focus on its child component

Params:

NameTypeAttributeDescription
child *

public unRegisterIFilterControl(iFilterControl: *) source

Unresgister a filter control component

Params:

NameTypeAttributeDescription
iFilterControl *