Class: FilterControl

FilterControl()

new FilterControl()

Extends

Methods

applyFilter()

Applies filter values.

clearSelects()

Clears all selected values.

filter(field, op, values)

Filters on the specified db field.
Parameters:
Name Type Description
field Object
op String
values Array
Inherited From:

getAllValues() → {Array}

Returns all available values.
Returns:
all available values
Type
Array

getApplyToComponents() → {Array}

Returns all component instance names when the filter is applied.
Returns:
Type
Array

getAssocDBField(dsid, callback)

Returns the associated DB field object with the specified dsid.
Parameters:
Name Type Description
dsid String
callback function
Inherited From:

getBindFields() → {Array}

Returns the bound fields in this filter control.
Returns:
field array
Type
Array

getDispValues(mode) → {Array}

Returns display values with the specified mode.
Parameters:
Name Type Description
mode Number 0: all, 1: selected
Returns:
display value string array.
Type
Array

getRealValues(mode) → {Array}

Returns real values with the specified mode.
Parameters:
Name Type Description
mode Number 0: all, 1: selected
Returns:
real value string array.
Type
Array

isAllSelected()

Tests whether all values are selected.

isFilterable() → {Boolean}

Returns whether this data container supports filter function.
Inherited From:
Returns:
Type
Boolean

isSortable() → {Boolean}

Returns whether this data container supports sort function.
Inherited From:
Returns:
Type
Boolean
Searches values which contain the specified characters.
Parameters:
Name Type Description
key String The characters you want to search for.
options Object
Properties
Name Type Description
insensitive Boolean Whether it is not case sensitive. The default value is true.
matchword Boolean
wholeword Boolean
Returns:
Matched filter values in an array.
Type
Array

select(key, selected)

Selects the specified item with the seclected flag.
Parameters:
Name Type Description
key String
selected Boolean

selectAll(selected)

Selects/Unselects all values.
Parameters:
Name Type Description
selected Boolean

sort(field, order)

Sorts on the specified db field by the specified ascending or descending order.
Parameters:
Name Type Description
field Object
order String
Inherited From: