API svyPopupFilter

Classes

AbstractPopupFilter

SvyCheckFilter ⇐ AbstractPopupFilter

SvyDateFilter ⇐ AbstractPopupFilter

SvyIntegerFilter ⇐ AbstractPopupFilter

SvyNumberFilter ⇐ AbstractPopupFilter

SvySelectFilter ⇐ AbstractPopupFilter

SvyTokenFilter ⇐ AbstractPopupFilter

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)

  • .clearParams()

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

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

  • .getDataProvider() ⇒ String

  • .getID() ⇒ String

  • .getOperator() ⇒ String

  • .getParams() ⇒ Array

  • .getState() ⇒ Object

  • .getText() ⇒ String

  • .getValues() ⇒ Array

  • .removeParam(index)

  • .restoreState(jsonState) ⇒ AbstractPopupFilter

  • .setDataProvider(dataProvider)

  • .setOperator(operator)

  • .setRendererForm(popupFilterForm)

  • .setText(text)

  • .setValues(values)

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

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

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

abstractPopupFilter.addParam(param)

Add a params to be added into the onSelect callback arguments

Param	Type
param	Object

abstractPopupFilter.clearParams()

Clear the params

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

Creates and returns the popupFilter

Param	Type	Description
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)

Param	Type	Description
[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

Param	Type
index	Number

abstractPopupFilter.restoreState(jsonState) ⇒ AbstractPopupFilter

Param	Type
jsonState	Object

abstractPopupFilter.setDataProvider(dataProvider)

Sets the popupFilter dataprovider

Param	Type
dataProvider	String

abstractPopupFilter.setOperator(operator)

Param	Type	Description
operator	String	a value from scopes.svyPopupFilter.OPERATOR

abstractPopupFilter.setRendererForm(popupFilterForm)

Param	Type
popupFilterForm	RuntimeForm. | RuntimeForm.<AbstractLookup>

abstractPopupFilter.setText(text)

Sets the popupFilter text

Param	Type
text	String

abstractPopupFilter.setValues(values)

Param	Type
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

Param	Type	Description
[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

Param	Type	Description
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

Param	Type	Description
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 ⇐ AbstractPopupFilter

  • .addParam(param)

  • .clearParams()

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

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

  • .getDataProvider() ⇒ String

  • .getID() ⇒ String

  • .getOperator() ⇒ String

  • .getParams() ⇒ Array

  • .getState() ⇒ Object

  • .getText() ⇒ String

  • .getValues() ⇒ Array

  • .removeParam(index)

  • .restoreState(jsonState) ⇒ AbstractPopupFilter

  • .setDataProvider(dataProvider)

  • .setOperator(operator)

  • .setRendererForm(popupFilterForm)

  • .setText(text)

  • .setValues(values)

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

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

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

svyCheckFilter.addParam(param)

Add a params to be added into the onSelect callback arguments

Param	Type
param	Object

svyCheckFilter.clearParams()

Clear the params

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

Creates and returns the popupFilter

Param	Type	Description
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)

Param	Type	Description
[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

Param	Type
index	Number

svyCheckFilter.restoreState(jsonState) ⇒ AbstractPopupFilter

Param	Type
jsonState	Object

svyCheckFilter.setDataProvider(dataProvider)

Sets the popupFilter dataprovider

Param	Type
dataProvider	String

svyCheckFilter.setOperator(operator)

Param	Type	Description
operator	String	a value from scopes.svyPopupFilter.OPERATOR

svyCheckFilter.setRendererForm(popupFilterForm)

Param	Type
popupFilterForm	RuntimeForm.<AbstractPopupFilter> | RuntimeForm.<AbstractLookup>

svyCheckFilter.setText(text)

Sets the popupFilter text

Param	Type
text	String

svyCheckFilter.setValues(values)

Param	Type
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

Param	Type	Description
[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

Param	Type	Description
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

Param	Type	Description
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 ⇐ AbstractPopupFilter

  • .addParam(param)

  • .clearParams()

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

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

  • .getDataProvider() ⇒ String

  • .getID() ⇒ String

  • .getOperator() ⇒ String

  • .getParams() ⇒ Array

  • .getState() ⇒ Object

  • .getText() ⇒ String

  • .getValues() ⇒ Array

  • .removeParam(index)

  • .restoreState(jsonState) ⇒ AbstractPopupFilter

  • .setDataProvider(dataProvider)

  • .setOperator(operator)

  • .setRendererForm(popupFilterForm)

  • .setText(text)

  • .setValues(values)

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

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

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

svyDateFilter.addParam(param)

Add a params to be added into the onSelect callback arguments

Param	Type
param	Object

svyDateFilter.clearParams()

Clear the params

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

Creates and returns the popupFilter

Param	Type	Description
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)

Param	Type	Description
[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

Param	Type
index	Number

svyDateFilter.restoreState(jsonState) ⇒ AbstractPopupFilter

Param	Type
jsonState	Object

svyDateFilter.setDataProvider(dataProvider)

Sets the popupFilter dataprovider

Param	Type
dataProvider	String

svyDateFilter.setOperator(operator)

Param	Type	Description
operator	String	a value from scopes.svyPopupFilter.OPERATOR

svyDateFilter.setRendererForm(popupFilterForm)

Param	Type
popupFilterForm	RuntimeForm.<AbstractPopupFilter> | RuntimeForm.<AbstractLookup>

svyDateFilter.setText(text)

Sets the popupFilter text

Param	Type
text	String

svyDateFilter.setValues(values)

Param	Type
values	Array