dojox/grid/enhanced/plugins/filter/FilterDefDialog (version 1.10)

Summary

Create the filter definition UI.

Usage

var foo = new FilterDefDialog(args);
dojox/grid/enhanced/plugins/filter/FilterDefDialog
Parameter Type Description
args undefined

Property Summary

Method Summary

Event Summary

  • _onSetFilter(filterDef) If someone clear the filter def in the store directly, we must clear it in the UI.
  • onCancel(e) Triggered when the "Cancel" buttton is clicked.
  • onClearFilter(e) Triggered when the "Clear" button is clicked.
  • onFilter(e) Triggered when the "Filter" button is clicked.
  • onMoveColumn(sourceViewIndex,destViewIndex,cellIndex,targetIndex,before)
  • onRendered(cbox) Triggered when the rendering of the filter definition dialog is completely finished.

Properties

Methods

_closeDlgAndUpdateGrid()
_prepareDialog(colIndex)
Parameter Type Description
colIndex int
_updateCBoxTitles()
addCriteriaBoxes(cnt)

Add cnt criteria boxes to the filter definition pane. Check overflow if necessary.

Parameter Type Description
cnt int
canFilter()
Returns:boolean
clearFilter(noRefresh)

Clear filter definition.

Parameter Type Description
noRefresh undefined
closeDialog()

Close the filter definition dialog.

getColumnLabelByValue(v)
Parameter Type Description
v undefined
Returns:undefined | string
getColumnType(colIndex)
Parameter Type Description
colIndex int
Returns:undefined
getConditionLabelByValue(type,c)
Parameter Type Description
type undefined
c undefined
Returns:undefined | string
getCriteria(idx)

Get the idx-th criteria.

Parameter Type Description
idx int
Returns:number | object | null
getExprForColumn(value,colIdx,type,condition)
Parameter Type Description
value undefined
colIdx undefined
type undefined
condition undefined
Returns:object
getExprForCriteria(rule)
Parameter Type Description
rule undefined
Returns:undefined
getFilter()
Returns:object
removeCriteriaBoxes(cnt,isIdx)

Remove criteria boxes from the filter definition pane.

Parameter Type Description
cnt int | CriteriaBox | int[]
isIdx bool
Optional
setFilter(rules,ruleRelation)
Parameter Type Description
rules undefined
ruleRelation undefined
showDialog(colIndex)

Show the filter definition dialog.

Parameter Type Description
colIndex int

Events

_onSetFilter(filterDef)

If someone clear the filter def in the store directly, we must clear it in the UI. If someone defines a filter, don't know how to handle it!

Parameter Type Description
filterDef undefined
onCancel(e)

Triggered when the "Cancel" buttton is clicked.

Parameter Type Description
e undefined
onClearFilter(e)

Triggered when the "Clear" button is clicked.

Parameter Type Description
e undefined
onFilter(e)

Triggered when the "Filter" button is clicked.

Parameter Type Description
e undefined
onMoveColumn(sourceViewIndex,destViewIndex,cellIndex,targetIndex,before)
Parameter Type Description
sourceViewIndex undefined
destViewIndex undefined
cellIndex undefined
targetIndex undefined
before undefined
onRendered(cbox)

Triggered when the rendering of the filter definition dialog is completely finished.

Parameter Type Description
cbox undefined

Current visible criteria box

Error in the documentation? Can’t find what you are looking for? Let us know!