API svyPopupFilter v1

Classes

AbstractPopupFilter

SvyDateFilterAbstractPopupFilter

SvyNumberFilterAbstractPopupFilter

SvySelectFilterAbstractPopupFilter

SvyTokenFilterAbstractPopupFilter

Functions

createDateFilter()SvyDateFilter

createNumberFilter()SvyNumberFilter

createSelectFilter(dataProvider, lookup)SvySelectFilter

createTokenFilter()SvyTokenFilter

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.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.<AbstractPopupFilter> | RuntimeForm.<AbstractLookup>

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


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.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.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


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.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.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