API svyPopupFilter v1 - Servoy/svyPopupFilter GitHub Wiki

AbstractPopupFilter

SvyDateFilter ⇐ AbstractPopupFilter

SvyNumberFilter ⇐ AbstractPopupFilter

SvySelectFilter ⇐ AbstractPopupFilter

SvyTokenFilter ⇐ AbstractPopupFilter

createDateFilter() ⇒ SvyDateFilter

createNumberFilter() ⇒ SvyNumberFilter

createSelectFilter(dataProvider, lookup) ⇒ SvySelectFilter

createTokenFilter() ⇒ SvyTokenFilter

• 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
  • .getValues() ⇒ Array
  • .removeParam(index)
  • .restoreState(jsonState) ⇒ AbstractPopupFilter
  • .setDataProvider(dataProvider)
  • .setOperator(operator)
  • .setRendererForm(popupFilterForm)
  • .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)>

---

Add a params to be added into the onSelect callback arguments

Param	Type
param	Object

---

Clear the params

---

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

---

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

---

Gets the popupFilter dataprovider

---

Gets the filter name

---

---

---

---

---

Removes a param at the specified index

Param	Type
index	Number

---

Param	Type
jsonState	Object

---

Sets the popupFilter dataprovider

Param	Type
dataProvider	String

---

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

---

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

---

Param	Type
values	Array

---

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.

---

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.

---

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

---

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
  • .getValues() ⇒ Array
  • .removeParam(index)
  • .restoreState(jsonState) ⇒ AbstractPopupFilter
  • .setDataProvider(dataProvider)
  • .setOperator(operator)
  • .setRendererForm(popupFilterForm)
  • .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)>

---

Add a params to be added into the onSelect callback arguments

Param	Type
param	Object

---

Clear the params

---

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

---

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

---

Gets the popupFilter dataprovider

---

Gets the filter name

---

---

---

---

---

Removes a param at the specified index

Param	Type
index	Number

---

Param	Type
jsonState	Object

---

Sets the popupFilter dataprovider

Param	Type
dataProvider	String

---

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

---

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

---

Param	Type
values	Array

---

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.

---

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.

---

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

---

Extends: AbstractPopupFilter

• SvyNumberFilter ⇐ 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
  • .getValues() ⇒ Array
  • .removeParam(index)
  • .restoreState(jsonState) ⇒ AbstractPopupFilter
  • .setDataProvider(dataProvider)
  • .setOperator(operator)
  • .setRendererForm(popupFilterForm)
  • .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)>

---

Add a params to be added into the onSelect callback arguments

Param	Type
param	Object

---

Clear the params

---

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

---

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

---

Gets the popupFilter dataprovider

---

Gets the filter name

---

---

---

---

---

Removes a param at the specified index

Param	Type
index	Number

---

Param	Type
jsonState	Object

---

Sets the popupFilter dataprovider

Param	Type
dataProvider	String

---

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

---

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

---

Param	Type
values	Array

---

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.

---

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.

---

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

---

Extends: AbstractPopupFilter

• SvySelectFilter ⇐ AbstractPopupFilter
  • .addParam(param)
  • .clearParams()
  • .createPopUp(callback) ⇒ plugins.window.FormPopup
  • .createWindow([x], [y], [width], [height], [jsWindowType]) ⇒ JSWindow
  • .getDataProvider() ⇒ String
  • .getID() ⇒ String
  • .getLookup() ⇒ scopes.svyLookup.Lookup
  • .getOperator() ⇒ String
  • .getParams() ⇒ Array
  • .getState() ⇒ Object
  • .getValues() ⇒ Array
  • .removeParam(index)
  • .restoreState(jsonState) ⇒ AbstractPopupFilter
  • .setDataProvider(dataProvider)
  • .setOperator(operator)
  • .setRendererForm(popupFilterForm)
  • .setValues(values)
  • .showModalWindow([callback], [x], [y], [width], [height]) ⇒ Array.<JSRecord> | Array.<(String|Date|Number)>
  • .showPopUp(callback, target, [width], [height])
  • .showWindow(win, [callback]) ⇒ Array.<JSRecord> | Array.<(String|Date|Number)>
  • new SvySelectFilter(dataProvider, lookup)

---

Add a params to be added into the onSelect callback arguments

Param	Type
param	Object

---

Clear the params

---

Creates and returns the popupFilter

Overrides: createPopUp

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

---

Overrides: createWindow
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

---

Gets the popupFilter dataprovider

---

Gets the filter name

---

---

---

---

Overrides: getState

---

---

Removes a param at the specified index

Param	Type
index	Number

---

Overrides: restoreState

Param	Type
jsonState	Object

---

Sets the popupFilter dataprovider

Param	Type
dataProvider	String

---

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

---

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

---

Param	Type
values	Array

---

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

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.

---

Shows the popupFilter

Overrides: showPopUp

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.

---

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

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

---

Param	Type	Description
dataProvider	String	will override the lookupDataProvider
lookup	scopes.svyLookup.Lookup

---

Extends: AbstractPopupFilter

• SvyTokenFilter ⇐ 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
  • .getValues() ⇒ Array
  • .removeParam(index)
  • .restoreState(jsonState) ⇒ AbstractPopupFilter
  • .setDataProvider(dataProvider)
  • .setOperator(operator)
  • .setRendererForm(popupFilterForm)
  • .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)>

---

Add a params to be added into the onSelect callback arguments

Param	Type
param	Object

---

Clear the params

---

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

---

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

---

Gets the popupFilter dataprovider

---

Gets the filter name

---

---

---

---

---

Removes a param at the specified index

Param	Type
index	Number

---

Param	Type
jsonState	Object

---

Sets the popupFilter dataprovider

Param	Type
dataProvider	String

---

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

---

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

---

Param	Type
values	Array

---

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.

---

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.

---

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

---

Properties

Name	Default
EQUALS	eq
GREATER_EQUAL	ge
GREATER_THEN	gt
SMALLER_EQUAL	le
SMALLER_THEN	lt
BETWEEN	BETWEEN
IS_IN	IN

---

---

---

Param	Type
dataProvider	String
lookup	scopes.svyLookup.Lookup

---

---