API svyPopupFilter

Classes

AbstractPopupFilter

SvyCheckFilterAbstractPopupFilter

SvyDateFilterAbstractPopupFilter

SvyIntegerFilterAbstractPopupFilter

SvyNumberFilterAbstractPopupFilter

SvySelectFilterAbstractPopupFilter

SvyTokenFilterAbstractPopupFilter

Functions

applyLocaleStrings(formName, formType)

Applies the locale strings set on svyToolbarFilter.TOOLBAR_LOCALE to the matching elements for the given form identifier which is one of TOOLBAR_LOCALE's main properties

createCheckFilter()SvyCheckFilter

createDateFilter()SvyDateFilter

createIntegerFilter()SvyIntegerFilter

createNumberFilter()SvyNumberFilter

createSelectFilter(dataProvider, lookup)SvySelectFilte

createTokenFilter()SvyTokenFilter

getVersion()String

Gets the version of this module

AbstractPopupFilter

abstractPopupFilter.addParam(param)

Add a params to be added into the onSelect callback arguments

ParamType

param

Object

abstractPopupFilter.clearParams()

Clear the params

abstractPopupFilter.createPopUp(callback) ⇒ plugins.window.FormPopup

Creates and returns the popupFilter

ParamTypeDescription

callback

function

The function that will be called when a selection is made; the callback returns the following arguments: {Array} record, {Array<String

abstractPopupFilter.createWindow([x], [y], [width], [height], [jsWindowType]) ⇒ JSWindow

Returns: JSWindow - returns a JSWindow which can be used to show the popupFilter in it using popupFilter.showWindow(window)

ParamTypeDescription

[x]

Number

[y]

Number

[width]

Number

The width of the pop-up. Optional. Default is component width

[height]

Number

The height of the pop-up. Optional. Default is form height.

[jsWindowType]

Number

Type of window; should be an option of JSWindow, Default JSWindow.MODAL_DIALOG

abstractPopupFilter.getDataProvider() ⇒ String

Gets the popupFilter dataprovider

abstractPopupFilter.getID() ⇒ String

Gets the filter name

abstractPopupFilter.getOperator() ⇒ String

abstractPopupFilter.getParams() ⇒ Array

abstractPopupFilter.getState() ⇒ Object

abstractPopupFilter.getText() ⇒ String

Gets the popupFilter text

abstractPopupFilter.getValues() ⇒ Array

abstractPopupFilter.removeParam(index)

Removes a param at the specified index

ParamType

index

Number

abstractPopupFilter.restoreState(jsonState) ⇒ AbstractPopupFilter

ParamType

jsonState

Object

abstractPopupFilter.setDataProvider(dataProvider)

Sets the popupFilter dataprovider

ParamType

dataProvider

String

abstractPopupFilter.setOperator(operator)

ParamTypeDescription

operator

String

a value from scopes.svyPopupFilter.OPERATOR

abstractPopupFilter.setRendererForm(popupFilterForm)

ParamType

popupFilterForm

RuntimeForm. | RuntimeForm.<AbstractLookup>

abstractPopupFilter.setText(text)

Sets the popupFilter text

ParamType

text

String

abstractPopupFilter.setValues(values)

ParamType

values

Array

abstractPopupFilter.showModalWindow([callback], [x], [y], [width], [height]) ⇒ Array.<JSRecord> | Array.<(String|Date|Number)>

Shows the popupFilter in a modal Window

Returns: Array.<JSRecord> | Array.<(String|Date|Number)> - returns the selected records; if the popupFilterDataprovider has been set instead it returns the popupFilterDataprovider values on the selected records. Returns null if the window is closed without a selection or an empty selection

ParamTypeDescription

[callback]

function

The function that will be called when a selection is made; the callback returns the following arguments: {Array} record, {Array<String

[x]

Number

[y]

Number

[width]

Number

The width of the popupFilter. Optional. Default is same as target component

[height]

Number

The height of the popupFilter. Optional. Default is implementation-specifc.

abstractPopupFilter.showPopUp(callback, target, [width], [height])

Shows the popupFilter

ParamTypeDescription

callback

function

The function that will be called when a selection is made; the callback returns the following arguments: {Array} record, {Array<String

target

RuntimeComponent

The component to show relative to

[width]

Number

The width of the popupFilter. Optional. Default is same as target component

[height]

Number

The height of the popupFilter. Optional. Default is implementation-specifc.

abstractPopupFilter.showWindow(win, [callback]) ⇒ [ 'Array' ].<(String|Date|Number)>

Shows the popupFilter in a Window

Returns: [ 'Array' ].<(String|Date|Number)> - returns the selected records; if the popupFilterDataprovider has been set instead it returns the popupFilterDataprovider values on the selected records. Returns null if the window is closed without a selection or an empty selection

ParamTypeDescription

win

JSWindow

the JSWindow object to show

[callback]

function

The function that will be called when a selection is made; the callback returns the following arguments: {Array} record, {Array<String

SvyCheckFilter ⇐ AbstractPopupFilter

Extends: AbstractPopupFilter

svyCheckFilter.addParam(param)

Add a params to be added into the onSelect callback arguments

ParamType

param

Object

svyCheckFilter.clearParams()

Clear the params

svyCheckFilter.createPopUp(callback) ⇒ plugins.window.FormPopup

Creates and returns the popupFilter

ParamTypeDescription

callback

function

The function that will be called when a selection is made; the callback returns the following arguments: {Array} record, {Array<String

svyCheckFilter.createWindow([x], [y], [width], [height], [jsWindowType]) ⇒ JSWindow

Returns: JSWindow - returns a JSWindow which can be used to show the popupFilter in it using popupFilter.showWindow(window)

ParamTypeDescription

[x]

Number

[y]

Number

[width]

Number

The width of the pop-up. Optional. Default is component width

[height]

Number

The height of the pop-up. Optional. Default is form height.

[jsWindowType]

Number

Type of window; should be an option of JSWindow, Default JSWindow.MODAL_DIALOG

svyCheckFilter.getDataProvider() ⇒ String

Gets the popupFilter dataprovider

svyCheckFilter.getID() ⇒ String

Gets the filter name

svyCheckFilter.getOperator() ⇒ String

svyCheckFilter.getParams() ⇒ Array

svyCheckFilter.getState() ⇒ Object

svyCheckFilter.getText() ⇒ String

Gets the popupFilter text

svyCheckFilter.getValues() ⇒ Array

svyCheckFilter.removeParam(index)

Removes a param at the specified index

ParamType

index

Number

svyCheckFilter.restoreState(jsonState) ⇒ AbstractPopupFilter

ParamType

jsonState

Object

svyCheckFilter.setDataProvider(dataProvider)

Sets the popupFilter dataprovider

ParamType

dataProvider

String

svyCheckFilter.setOperator(operator)

ParamTypeDescription

operator

String

a value from scopes.svyPopupFilter.OPERATOR

svyCheckFilter.setRendererForm(popupFilterForm)

ParamType

popupFilterForm

RuntimeForm.<AbstractPopupFilter> | RuntimeForm.<AbstractLookup>

svyCheckFilter.setText(text)

Sets the popupFilter text

ParamType

text

String

svyCheckFilter.setValues(values)

ParamType

values

Array

svyCheckFilter.showModalWindow([callback], [x], [y], [width], [height]) ⇒ Array.<JSRecord> | Array.<(String|Date|Number)>

Shows the popupFilter in a modal Window

Returns: Array.<JSRecord> | Array.<(String|Date|Number)> - returns the selected records; if the popupFilterDataprovider has been set instead it returns the popupFilterDataprovider values on the selected records. Returns null if the window is closed without a selection or an empty selection

ParamTypeDescription

[callback]

function

The function that will be called when a selection is made; the callback returns the following arguments: {Array} record, {Array<String

[x]

Number

[y]

Number

[width]

Number

The width of the popupFilter. Optional. Default is same as target component

[height]

Number

The height of the popupFilter. Optional. Default is implementation-specifc.

svyCheckFilter.showPopUp(callback, target, [width], [height])

Shows the popupFilter

ParamTypeDescription

callback

function

The function that will be called when a selection is made; the callback returns the following arguments: {Array} record, {Array<String

target

RuntimeComponent

The component to show relative to

[width]

Number

The width of the popupFilter. Optional. Default is same as target component

[height]

Number

The height of the popupFilter. Optional. Default is implementation-specifc.

svyCheckFilter.showWindow(win, [callback]) ⇒ [ 'Array' ].<(String|Date|Number)>

Shows the popupFilter in a Window

Returns: [ 'Array' ].<(String|Date|Number)> - returns the selected records; if the popupFilterDataprovider has been set instead it returns the popupFilterDataprovider values on the selected records. Returns null if the window is closed without a selection or an empty selection

ParamTypeDescription

win

JSWindow

the JSWindow object to show

[callback]

function

The function that will be called when a selection is made; the callback returns the following arguments: {Array} record, {Array<String


SvyDateFilter ⇐ AbstractPopupFilter

Extends: AbstractPopupFilter

svyDateFilter.addParam(param)

Add a params to be added into the onSelect callback arguments

ParamType

param

Object

svyDateFilter.clearParams()

Clear the params

svyDateFilter.createPopUp(callback) ⇒ plugins.window.FormPopup

Creates and returns the popupFilter

ParamTypeDescription

callback

function

The function that will be called when a selection is made; the callback returns the following arguments: {Array} record, {Array<String

svyDateFilter.createWindow([x], [y], [width], [height], [jsWindowType]) ⇒ JSWindow

Returns: JSWindow - returns a JSWindow which can be used to show the popupFilter in it using popupFilter.showWindow(window)

ParamTypeDescription

[x]

Number

[y]

Number

[width]

Number

The width of the pop-up. Optional. Default is component width

[height]

Number

The height of the pop-up. Optional. Default is form height.

[jsWindowType]

Number

Type of window; should be an option of JSWindow, Default JSWindow.MODAL_DIALOG

svyDateFilter.getDataProvider() ⇒ String

Gets the popupFilter dataprovider

svyDateFilter.getID() ⇒ String

Gets the filter name

svyDateFilter.getOperator() ⇒ String

svyDateFilter.getParams() ⇒ Array

svyDateFilter.getState() ⇒ Object

svyDateFilter.getText() ⇒ String

Gets the popupFilter text

svyDateFilter.getValues() ⇒ Array

svyDateFilter.removeParam(index)

Removes a param at the specified index

ParamType

index

Number

svyDateFilter.restoreState(jsonState) ⇒ AbstractPopupFilter

ParamType

jsonState

Object

svyDateFilter.setDataProvider(dataProvider)

Sets the popupFilter dataprovider

ParamType

dataProvider

String

svyDateFilter.setOperator(operator)

ParamTypeDescription

operator

String

a value from scopes.svyPopupFilter.OPERATOR

svyDateFilter.setRendererForm(popupFilterForm)

ParamType

popupFilterForm

RuntimeForm.<AbstractPopupFilter> | RuntimeForm.<AbstractLookup>

svyDateFilter.setText(text)

Sets the popupFilter text

ParamType

text

String

svyDateFilter.setValues(values)

ParamType

values

Array

svyDateFilter.showModalWindow([callback], [x], [y], [width], [height]) ⇒ Array.<JSRecord> | Array.<(String|Date|Number)>

Shows the popupFilter in a modal Window

Returns: Array.<JSRecord> | Array.<(String|Date|Number)> - returns the selected records; if the popupFilterDataprovider has been set instead it returns the popupFilterDataprovider values on the selected records. Returns null if the window is closed without a selection or an empty selection

ParamTypeDescription

[callback]

function

The function that will be called when a selection is made; the callback returns the following arguments: {Array} record, {Array<String

[x]

Number

[y]

Number

[width]

Number

The width of the popupFilter. Optional. Default is same as target component

[height]

Number

The height of the popupFilter. Optional. Default is implementation-specifc.

svyDateFilter.showPopUp(callback, target, [width], [height])

Shows the popupFilter

ParamTypeDescription

callback

function

The function that will be called when a selection is made; the callback returns the following arguments: {Array} record, {Array<String

target

RuntimeComponent

The component to show relative to

[width]

Number

The width of the popupFilter. Optional. Default is same as target component

[height]

Number

The height of the popupFilter. Optional. Default is implementation-specifc.

svyDateFilter.showWindow(win, [callback]) ⇒ [ 'Array' ].<(String|Date|Number)>

Shows the popupFilter in a Window

Returns: [ 'Array' ].<(String|Date|Number)> - returns the selected records; if the popupFilterDataprovider has been set instead it returns the popupFilterDataprovider values on the selected records. Returns null if the window is closed without a selection or an empty selection

ParamTypeDescription

win

JSWindow

the JSWindow object to show

[callback]

function

The function that will be called when a selection is made; the callback returns the following arguments: {Array} record, {Array<String

SvyIntegerFilter ⇐ AbstractPopupFilter

Extends: AbstractPopupFilter

svyIntegerFilter.addParam(param)

Add a params to be added into the onSelect callback arguments

ParamType

param

Object

svyIntegerFilter.clearParams()

Clear the params

svyIntegerFilter.createPopUp(callback) ⇒ plugins.window.FormPopup

Creates and returns the popupFilter

ParamTypeDescription

callback

function

The function that will be called when a selection is made; the callback returns the following arguments: {Array} record, {Array<String

svyIntegerFilter.createWindow([x], [y], [width], [height], [jsWindowType]) ⇒ JSWindow

Returns: JSWindow - returns a JSWindow which can be used to show the popupFilter in it using popupFilter.showWindow(window)

ParamTypeDescription

[x]

Number

[y]

Number

[width]

Number

The width of the pop-up. Optional. Default is component width

[height]

Number

The height of the pop-up. Optional. Default is form height.

[jsWindowType]

Number

Type of window; should be an option of JSWindow, Default JSWindow.MODAL_DIALOG

svyIntegerFilter.getDataProvider() ⇒ String

Gets the popupFilter dataprovider

svyIntegerFilter.getID() ⇒ String

Gets the filter name

svyIntegerFilter.getOperator() ⇒ String

svyIntegerFilter.getParams() ⇒ Array

svyIntegerFilter.getState() ⇒ Object

svyIntegerFilter.getText() ⇒ String

Gets the popupFilter text

svyIntegerFilter.getValues() ⇒ Array

svyIntegerFilter.removeParam(index)

Removes a param at the specified index

ParamType

index

Number

svyIntegerFilter.restoreState(jsonState) ⇒ AbstractPopupFilter

ParamType

jsonState

Object

svyIntegerFilter.setDataProvider(dataProvider)

Sets the popupFilter dataprovider

ParamType

dataProvider

String

svyIntegerFilter.setOperator(operator)

ParamTypeDescription

operator

String

a value from scopes.svyPopupFilter.OPERATOR

svyIntegerFilter.setRendererForm(popupFilterForm)

ParamType

popupFilterForm

RuntimeForm.<AbstractPopupFilter> | RuntimeForm.<AbstractLookup>

svyIntegerFilter.setText(text)

Sets the popupFilter text

ParamType

text

String

svyIntegerFilter.setValues(values)

ParamType

values

Array

svyIntegerFilter.showModalWindow([callback], [x], [y], [width], [height]) ⇒ Array.<JSRecord> | Array.<(String|Date|Number)>

Shows the popupFilter in a modal Window

Returns: Array.<JSRecord> | Array.<(String|Date|Number)> - returns the selected records; if the popupFilterDataprovider has been set instead it returns the popupFilterDataprovider values on the selected records. Returns null if the window is closed without a selection or an empty selection

ParamTypeDescription

[callback]

function

The function that will be called when a selection is made; the callback returns the following arguments: {Array} record, {Array<String

[x]

Number

[y]

Number

[width]

Number

The width of the popupFilter. Optional. Default is same as target component

[height]

Number

The height of the popupFilter. Optional. Default is implementation-specifc.

svyIntegerFilter.showPopUp(callback, target, [width], [height])

Shows the popupFilter

ParamTypeDescription

callback

function

The function that will be called when a selection is made; the callback returns the following arguments: {Array} record, {Array<String

target

RuntimeComponent

The component to show relative to

[width]

Number

The width of the popupFilter. Optional. Default is same as target component

[height]

Number

The height of the popupFilter. Optional. Default is implementation-specifc.

svyIntegerFilter.showWindow(win, [callback]) ⇒ [ 'Array' ].<(String|Date|Number)>

Shows the popupFilter in a Window

Returns: [ 'Array' ].<(String|Date|Number)> - returns the selected records; if the popupFilterDataprovider has been set instead it returns the popupFilterDataprovider values on the selected records. Returns null if the window is closed without a selection or an empty selection

ParamTypeDescription

win

JSWindow

the JSWindow object to show

[callback]

function

The function that will be called when a selection is made; the callback returns the following arguments: {Array} record, {Array<String

SvyNumberFilter ⇐ AbstractPopupFilter

Extends: AbstractPopupFilter

svyNumberFilter.addParam(param)

Add a params to be added into the onSelect callback arguments

ParamType

param

Object

svyNumberFilter.clearParams()

Clear the params

svyNumberFilter.createPopUp(callback) ⇒ plugins.window.FormPopup

Creates and returns the popupFilter

ParamTypeDescription

callback

function

The function that will be called when a selection is made; the callback returns the following arguments: {Array} record, {Array<String

svyNumberFilter.createWindow([x], [y], [width], [height], [jsWindowType]) ⇒ JSWindow

Returns: JSWindow - returns a JSWindow which can be used to show the popupFilter in it using popupFilter.showWindow(window)

ParamTypeDescription

[x]

Number

[y]

Number

[width]

Number

The width of the pop-up. Optional. Default is component width

[height]

Number

The height of the pop-up. Optional. Default is form height.

[jsWindowType]

Number

Type of window; should be an option of JSWindow, Default JSWindow.MODAL_DIALOG

svyNumberFilter.getDataProvider() ⇒ String

Gets the popupFilter dataprovider

svyNumberFilter.getID() ⇒ String

Gets the filter name

svyNumberFilter.getOperator() ⇒ String

svyNumberFilter.getParams() ⇒ Array

svyNumberFilter.getState() ⇒ Object

svyNumberFilter.getText() ⇒ String

Gets the popupFilter text

svyNumberFilter.getValues() ⇒ Array

svyNumberFilter.removeParam(index)

Removes a param at the specified index

ParamType

index

Number

svyNumberFilter.restoreState(jsonState) ⇒ AbstractPopupFilter

ParamType

jsonState

Object

svyNumberFilter.setDataProvider(dataProvider)

Sets the popupFilter dataprovider

ParamType

dataProvider

String

svyNumberFilter.setOperator(operator)

ParamTypeDescription

operator

String

a value from scopes.svyPopupFilter.OPERATOR

svyNumberFilter.setRendererForm(popupFilterForm)

ParamType

popupFilterForm

RuntimeForm.<AbstractPopupFilter> | RuntimeForm.<AbstractLookup>

svyNumberFilter.setText(text)

Sets the popupFilter text

ParamType

text

String

svyNumberFilter.setValues(values)

ParamType

values

Array

svyNumberFilter.showModalWindow([callback], [x], [y], [width], [height]) ⇒ Array.<JSRecord> | Array.<(String|Date|Number)>

Shows the popupFilter in a modal Window

Returns: Array.<JSRecord> | Array.<(String|Date|Number)> - returns the selected records; if the popupFilterDataprovider has been set instead it returns the popupFilterDataprovider values on the selected records. Returns null if the window is closed without a selection or an empty selection

ParamTypeDescription

[callback]

function

The function that will be called when a selection is made; the callback returns the following arguments: {Array} record, {Array<String

[x]

Number

[y]

Number

[width]

Number

The width of the popupFilter. Optional. Default is same as target component

[height]

Number

The height of the popupFilter. Optional. Default is implementation-specifc.

svyNumberFilter.showPopUp(callback, target, [width], [height])

Shows the popupFilter

ParamTypeDescription

callback

function

The function that will be called when a selection is made; the callback returns the following arguments: {Array} record, {Array<String

target

RuntimeComponent

The component to show relative to

[width]

Number

The width of the popupFilter. Optional. Default is same as target component

[height]

Number

The height of the popupFilter. Optional. Default is implementation-specifc.

svyNumberFilter.showWindow(win, [callback]) ⇒ [ 'Array' ].<(String|Date|Number)>

Shows the popupFilter in a Window

Returns: [ 'Array' ].<(String|Date|Number)> - returns the selected records; if the popupFilterDataprovider has been set instead it returns the popupFilterDataprovider values on the selected records. Returns null if the window is closed without a selection or an empty selection

ParamTypeDescription

win

JSWindow

the JSWindow object to show

[callback]

function

The function that will be called when a selection is made; the callback returns the following arguments: {Array} record, {Array<String


SvySelectFilter ⇐ AbstractPopupFilter

Extends: AbstractPopupFilter

svySelectFilter.addParam(param)

Add a params to be added into the onSelect callback arguments

ParamType

param

Object

svySelectFilter.clearParams()

Clear the params

svySelectFilter.createPopUp(callback) ⇒ plugins.window.FormPopup

Creates and returns the popupFilter

Overrides: createPopUp

svySelectFilter.createWindow([x], [y], [width], [height], [jsWindowType]) ⇒ JSWindow

Overrides: createWindow Returns: JSWindow - returns a JSWindow which can be used to show the popupFilter in it using popupFilter.showWindow(window)

ParamTypeDescription

[x]

Number

[y]

Number

[width]

Number

The width of the pop-up. Optional. Default is component width

[height]

Number

The height of the pop-up. Optional. Default is form height.

[jsWindowType]

Number

Type of window; should be an option of JSWindow, Default JSWindow.MODAL_DIALOG

svySelectFilter.getDataProvider() ⇒ String

Gets the popupFilter dataprovider

svySelectFilter.getID() ⇒ String

Gets the filter name

svySelectFilter.getLookup() ⇒ scopes.svyLookup.Lookup

svySelectFilter.getOperator() ⇒ String

svySelectFilter.getParams() ⇒ Array

svySelectFilter.getState() ⇒ Object

Overrides: getState

svySelectFilter.getText() ⇒ String

Gets the popupFilter text

svySelectFilter.getValues() ⇒ Array

svySelectFilter.removeParam(index)

Removes a param at the specified index

ParamType

index

Number

svySelectFilter.restoreState(jsonState) ⇒ AbstractPopupFilter

Overrides: restoreState

ParamType

jsonState

Object

svySelectFilter.setDataProvider(dataProvider)

Sets the popupFilter dataprovider

ParamType

dataProvider

String

svySelectFilter.setOperator(operator)

ParamTypeDescription

operator

String

a value from scopes.svyPopupFilter.OPERATOR

svySelectFilter.setRendererForm(popupFilterForm)

ParamType

popupFilterForm

RuntimeForm.<AbstractPopupFilter> | RuntimeForm.<AbstractLookup>

svySelectFilter.setText(text)

Sets the popupFilter text

ParamType

text

String

svySelectFilter.setValues(values)

Overrides: setValues

ParamType

values

Array

svySelectFilter.showModalWindow([callback], [x], [y], [width], [height]) ⇒ Array.<JSRecord> | Array.<(String|Date|Number)>

Shows the popupFilter in a modal Window

Overrides: showModalWindow Returns: Array.<JSRecord> | Array.<(String|Date|Number)> - returns the selected records; if the popupFilterDataprovider has been set instead it returns the popupFilterDataprovider values on the selected records. Returns null if the window is closed without a selection or an empty selection

ParamTypeDescription

[callback]

function

The function that will be called when a selection is made; the callback returns the following arguments: {Array} record, {Array<String

[x]

Number

[y]

Number

[width]

Number

The width of the popupFilter. Optional. Default is same as target component

[height]

Number

The height of the popupFilter. Optional. Default is implementation-specifc.

svySelectFilter.showPopUp(callback, target, [width], [height])

Shows the popupFilter

Overrides: showPopUp

ParamTypeDescription

callback

function

The function that will be called when a selection is made; the callback returns the following arguments: {Array} record, {Array<String

target

RuntimeComponent

The component to show relative to

[width]

Number

The width of the popupFilter. Optional. Default is same as target component

[height]

Number

The height of the popupFilter. Optional. Default is implementation-specifc.

svySelectFilter.showWindow(win, [callback]) ⇒ Array.<JSRecord> | Array.<(String|Date|Number)>

Shows the popupFilter in a Window

Overrides: showWindow Returns: Array.<JSRecord> | Array.<(String|Date|Number)> - returns the selected records; if the popupFilterDataprovider has been set instead it returns the popupFilterDataprovider values on the selected records. Returns null if the window is closed without a selection or an empty selection

ParamTypeDescription

win

JSWindow

the JSWindow object to show

[callback]

function

The function that will be called when a selection is made; the callback returns the following arguments: {Array<String

new SvySelectFilter(dataProvider, lookup)

ParamTypeDescription

dataProvider

String

will override the lookupDataProvider

lookup

scopes.svyLookup.Lookup


SvyTokenFilter ⇐ AbstractPopupFilter

Extends: AbstractPopupFilter

svyTokenFilter.addParam(param)

Add a params to be added into the onSelect callback arguments

ParamType

param

Object

svyTokenFilter.clearParams()

Clear the params

svyTokenFilter.createPopUp(callback) ⇒ plugins.window.FormPopup

Creates and returns the popupFilter

ParamTypeDescription

callback

function

The function that will be called when a selection is made; the callback returns the following arguments: {Array} record, {Array<String

svyTokenFilter.createWindow([x], [y], [width], [height], [jsWindowType]) ⇒ JSWindow

Returns: JSWindow - returns a JSWindow which can be used to show the popupFilter in it using popupFilter.showWindow(window)

ParamTypeDescription

[x]

Number

[y]

Number

[width]

Number

The width of the pop-up. Optional. Default is component width

[height]

Number

The height of the pop-up. Optional. Default is form height.

[jsWindowType]

Number

Type of window; should be an option of JSWindow, Default JSWindow.MODAL_DIALOG

svyTokenFilter.getDataProvider() ⇒ String

Gets the popupFilter dataprovider

svyTokenFilter.getID() ⇒ String

Gets the filter name

svyTokenFilter.getOperator() ⇒ String

svyTokenFilter.getParams() ⇒ Array

svyTokenFilter.getState() ⇒ Object

svyTokenFilter.getText() ⇒ String

Gets the popupFilter text

svyTokenFilter.getValues() ⇒ Array

svyTokenFilter.removeParam(index)

Removes a param at the specified index

ParamType

index

Number

svyTokenFilter.restoreState(jsonState) ⇒ AbstractPopupFilter

ParamType

jsonState

Object

svyTokenFilter.setDataProvider(dataProvider)

Sets the popupFilter dataprovider

ParamType

dataProvider

String

svyTokenFilter.setOperator(operator)

ParamTypeDescription

operator

String

a value from scopes.svyPopupFilter.OPERATOR

svyTokenFilter.setRendererForm(popupFilterForm)

ParamType

popupFilterForm

RuntimeForm.<AbstractPopupFilter> | RuntimeForm.<AbstractLookup>

svyTokenFilter.setText(text)

Sets the popupFilter text

ParamType

text

String

svyTokenFilter.setValues(values)

ParamType

values

Array

svyTokenFilter.showModalWindow([callback], [x], [y], [width], [height]) ⇒ Array.<JSRecord> | Array.<(String|Date|Number)>

Shows the popupFilter in a modal Window

Returns: Array.<JSRecord> | Array.<(String|Date|Number)> - returns the selected records; if the popupFilterDataprovider has been set instead it returns the popupFilterDataprovider values on the selected records. Returns null if the window is closed without a selection or an empty selection

ParamTypeDescription

[callback]

function

The function that will be called when a selection is made; the callback returns the following arguments: {Array} record, {Array<String

[x]

Number

[y]

Number

[width]

Number

The width of the popupFilter. Optional. Default is same as target component

[height]

Number

The height of the popupFilter. Optional. Default is implementation-specifc.

svyTokenFilter.showPopUp(callback, target, [width], [height])

Shows the popupFilter

ParamTypeDescription

callback

function

The function that will be called when a selection is made; the callback returns the following arguments: {Array} record, {Array<String

target

RuntimeComponent

The component to show relative to

[width]

Number

The width of the popupFilter. Optional. Default is same as target component

[height]

Number

The height of the popupFilter. Optional. Default is implementation-specifc.

svyTokenFilter.showWindow(win, [callback]) ⇒ [ 'Array' ].<(String|Date|Number)>

Shows the popupFilter in a Window

Returns: [ 'Array' ].<(String|Date|Number)> - returns the selected records; if the popupFilterDataprovider has been set instead it returns the popupFilterDataprovider values on the selected records. Returns null if the window is closed without a selection or an empty selection

ParamTypeDescription

win

JSWindow

the JSWindow object to show

[callback]

function

The function that will be called when a selection is made; the callback returns the following arguments: {Array} record, {Array<String

LOCALE

Properties

NameDefault

filterPopupMenu

{"addFilter":"Add filter"}

svyCheckPopupFilter

{"labelChecked":"Yes","labelUnchecked":"No"}

svyDatePopupFilter

{"labelTitle":"Date","labelToday":"Today","labelTomorrow":"Tomorrow","labelThisWeek":"This week","labelNextWeek":"Next week","labelThisMonth":"This month","labelNextMonth":"Next month","labelThisYear":"This year","labelLastYear":"Last year","operator":""}

svyTokenPopupFilter

{"searchbox":"","labelRemoveAll":"Remove all"}

svySelectPopupFilter

{"searchText":"","labelSelectAll":"Select all","labelDeselectAll":"Deselect all"}

svyIntegerPopupFilter

{"labelTitle":"Type filter value...","labelEqualTo":"Equal to","labelGreater":"Bigger than","labelSmaller":"Smaller than","labelBetween":"Between"}

svyNumberPopupFilter

{"labelTitle":"Type filter value...","labelEqualTo":"Equal to","labelGreater":"Bigger than","labelSmaller":"Smaller than","labelBetween":"Between"}

OPERATOR

Properties

NameDefaultDescription

IS_NULL

isNull

NOT_NULL

!isNull

EQUALS

eq

EQUALS_OR_NULL

^

eq

LIKE

like

All values starting with search input e.g. LIKE SEARCH_WORD%

LIKE_CONTAINS

like_contains

All values containing search input e.g. LIKE %SEARCH_WORD%

GREATER_EQUAL

ge

GREATER_THEN

gt

SMALLER_EQUAL

le

SMALLER_THEN

lt

BETWEEN

BETWEEN

IS_IN

IN

STYLING

Properties

NameDefault

MUTLI_SELECT_ICON_COLUMN_WIDTH

50

MULTI_SELECT_SHOW_TILE_HEADERS

true

CLOSE_ICON

fa fa-close

REMOVE_ICON

fa fa-trash

EXCLUDE_ICON

fas fa-minus-circle

INCLUDE_ICON

fas fa-check-circle

OPEN_FILTER_ICON

fas fa-angle-down

REMOVE_FILTER_ICON

fas fa-times

applyLocaleStrings(formName, formType)

Applies the locale strings set on svyToolbarFilter.TOOLBAR_LOCALE to the matching elements for the given form identifier which is one of TOOLBAR_LOCALE's main properties

ParamType

formName

String

formType

String

createCheckFilter() ⇒ SvyCheckFilter

createDateFilter() ⇒ SvyDateFilter

createIntegerFilter() ⇒ SvyIntegerFilter

createNumberFilter() ⇒ SvyNumberFilter

createSelectFilter(dataProvider, lookup) ⇒ SvySelectFilter

ParamType

dataProvider

String

lookup

scopes.svyLookup.Lookup

createTokenFilter() ⇒ SvyTokenFilter

getVersion() ⇒ String

Gets the version of this module

Returns: String - the version of the module using the format Major.Minor.Revision


Last updated