API svyPopupFilter v1
Classes
SvyDateFilter ⇐ AbstractPopupFilter
SvyNumberFilter ⇐ AbstractPopupFilter
SvySelectFilter ⇐ AbstractPopupFilter
SvyTokenFilter ⇐ AbstractPopupFilter
Functions
createDateFilter() ⇒ SvyDateFilter
createNumberFilter() ⇒ SvyNumberFilter
createSelectFilter(dataProvider, lookup) ⇒ SvySelectFilter
createTokenFilter() ⇒ SvyTokenFilter
AbstractPopupFilter
.createPopUp(callback) ⇒
plugins.window.FormPopup
.getDataProvider() ⇒
String
.getID() ⇒
String
.getOperator() ⇒
String
.getParams() ⇒
Array
.getState() ⇒
Object
.getValues() ⇒
Array
.showModalWindow([callback], [x], [y], [width], [height]) ⇒
Array.<JSRecord>
|Array.<(String|Date|Number)>
.showWindow(win, [callback]) ⇒
[ 'Array' ].<(String|Date|Number)>
abstractPopupFilter.addParam(param)
Add a params to be added into the onSelect callback arguments
param
Object
abstractPopupFilter.clearParams()
Clear the params
abstractPopupFilter.createPopUp(callback) ⇒ plugins.window.FormPopup
plugins.window.FormPopup
Creates and returns the popupFilter
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
JSWindow
Returns: JSWindow
- returns a JSWindow which can be used to show the popupFilter in it using popupFilter.showWindow(window)
[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
String
Gets the popupFilter dataprovider
abstractPopupFilter.getID() ⇒ String
String
Gets the filter name
abstractPopupFilter.getOperator() ⇒ String
String
abstractPopupFilter.getParams() ⇒ Array
Array
abstractPopupFilter.getState() ⇒ Object
Object
abstractPopupFilter.getValues() ⇒ Array
Array
abstractPopupFilter.removeParam(index)
Removes a param at the specified index
index
Number
abstractPopupFilter.restoreState(jsonState) ⇒ AbstractPopupFilter
AbstractPopupFilter
jsonState
Object
abstractPopupFilter.setDataProvider(dataProvider)
Sets the popupFilter dataprovider
dataProvider
String
abstractPopupFilter.setOperator(operator)
operator
String
a value from scopes.svyPopupFilter.OPERATOR
abstractPopupFilter.setRendererForm(popupFilterForm)
popupFilterForm
abstractPopupFilter.setValues(values)
values
Array
abstractPopupFilter.showModalWindow([callback], [x], [y], [width], [height]) ⇒ Array.<JSRecord>
| Array.<(String|Date|Number)>
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
[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
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)>
[ '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
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
AbstractPopupFilter
Extends: AbstractPopupFilter
SvyDateFilter ⇐
AbstractPopupFilter
.createPopUp(callback) ⇒
plugins.window.FormPopup
.getDataProvider() ⇒
String
.getID() ⇒
String
.getOperator() ⇒
String
.getParams() ⇒
Array
.getState() ⇒
Object
.getValues() ⇒
Array
.showModalWindow([callback], [x], [y], [width], [height]) ⇒
Array.<JSRecord>
|Array.<(String|Date|Number)>
.showWindow(win, [callback]) ⇒
[ 'Array' ].<(String|Date|Number)>
svyDateFilter.addParam(param)
Add a params to be added into the onSelect callback arguments
param
Object
svyDateFilter.clearParams()
Clear the params
svyDateFilter.createPopUp(callback) ⇒ plugins.window.FormPopup
plugins.window.FormPopup
Creates and returns the popupFilter
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
JSWindow
Returns: JSWindow
- returns a JSWindow which can be used to show the popupFilter in it using popupFilter.showWindow(window)
[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
String
Gets the popupFilter dataprovider
svyDateFilter.getID() ⇒ String
String
Gets the filter name
svyDateFilter.getOperator() ⇒ String
String
svyDateFilter.getParams() ⇒ Array
Array
svyDateFilter.getState() ⇒ Object
Object
svyDateFilter.getValues() ⇒ Array
Array
svyDateFilter.removeParam(index)
Removes a param at the specified index
index
Number
svyDateFilter.restoreState(jsonState) ⇒ AbstractPopupFilter
AbstractPopupFilter
jsonState
Object
svyDateFilter.setDataProvider(dataProvider)
Sets the popupFilter dataprovider
dataProvider
String
svyDateFilter.setOperator(operator)
operator
String
a value from scopes.svyPopupFilter.OPERATOR
svyDateFilter.setRendererForm(popupFilterForm)
popupFilterForm
svyDateFilter.setValues(values)
values
Array
svyDateFilter.showModalWindow([callback], [x], [y], [width], [height]) ⇒ Array.<JSRecord>
| Array.<(String|Date|Number)>
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
[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
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)>
[ '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
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
AbstractPopupFilter
Extends: AbstractPopupFilter
SvyNumberFilter ⇐
AbstractPopupFilter
.createPopUp(callback) ⇒
plugins.window.FormPopup
.getDataProvider() ⇒
String
.getID() ⇒
String
.getOperator() ⇒
String
.getParams() ⇒
Array
.getState() ⇒
Object
.getValues() ⇒
Array
.showModalWindow([callback], [x], [y], [width], [height]) ⇒
Array.<JSRecord>
|Array.<(String|Date|Number)>
.showWindow(win, [callback]) ⇒
[ 'Array' ].<(String|Date|Number)>
svyNumberFilter.addParam(param)
Add a params to be added into the onSelect callback arguments
param
Object
svyNumberFilter.clearParams()
Clear the params
svyNumberFilter.createPopUp(callback) ⇒ plugins.window.FormPopup
plugins.window.FormPopup
Creates and returns the popupFilter
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
JSWindow
Returns: JSWindow
- returns a JSWindow which can be used to show the popupFilter in it using popupFilter.showWindow(window)
[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
String
Gets the popupFilter dataprovider
svyNumberFilter.getID() ⇒ String
String
Gets the filter name
svyNumberFilter.getOperator() ⇒ String
String
svyNumberFilter.getParams() ⇒ Array
Array
svyNumberFilter.getState() ⇒ Object
Object
svyNumberFilter.getValues() ⇒ Array
Array
svyNumberFilter.removeParam(index)
Removes a param at the specified index
index
Number
svyNumberFilter.restoreState(jsonState) ⇒ AbstractPopupFilter
AbstractPopupFilter
jsonState
Object
svyNumberFilter.setDataProvider(dataProvider)
Sets the popupFilter dataprovider
dataProvider
String
svyNumberFilter.setOperator(operator)
operator
String
a value from scopes.svyPopupFilter.OPERATOR
svyNumberFilter.setRendererForm(popupFilterForm)
popupFilterForm
svyNumberFilter.setValues(values)
values
Array
svyNumberFilter.showModalWindow([callback], [x], [y], [width], [height]) ⇒ Array.<JSRecord>
| Array.<(String|Date|Number)>
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
[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
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)>
[ '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
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
AbstractPopupFilter
Extends: AbstractPopupFilter
SvySelectFilter ⇐
AbstractPopupFilter
.createPopUp(callback) ⇒
plugins.window.FormPopup
.getDataProvider() ⇒
String
.getID() ⇒
String
.getLookup() ⇒
scopes.svyLookup.Lookup
.getOperator() ⇒
String
.getParams() ⇒
Array
.getState() ⇒
Object
.getValues() ⇒
Array
.showModalWindow([callback], [x], [y], [width], [height]) ⇒
Array.<JSRecord>
|Array.<(String|Date|Number)>
.showWindow(win, [callback]) ⇒
Array.<JSRecord>
|Array.<(String|Date|Number)>
svySelectFilter.addParam(param)
Add a params to be added into the onSelect callback arguments
param
Object
svySelectFilter.clearParams()
Clear the params
svySelectFilter.createPopUp(callback) ⇒ plugins.window.FormPopup
plugins.window.FormPopup
Creates and returns the popupFilter
Overrides: createPopUp
callback
function
The function that will be called when a selection is made; the callback returns the following arguments: {Array} record, {Array<String
svySelectFilter.createWindow([x], [y], [width], [height], [jsWindowType]) ⇒ JSWindow
JSWindow
Overrides: createWindow
Returns: JSWindow
- returns a JSWindow which can be used to show the popupFilter in it using popupFilter.showWindow(window)
[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
String
Gets the popupFilter dataprovider
svySelectFilter.getID() ⇒ String
String
Gets the filter name
svySelectFilter.getLookup() ⇒ scopes.svyLookup.Lookup
scopes.svyLookup.Lookup
svySelectFilter.getOperator() ⇒ String
String
svySelectFilter.getParams() ⇒ Array
Array
svySelectFilter.getState() ⇒ Object
Object
Overrides: getState
svySelectFilter.getValues() ⇒ Array
Array
svySelectFilter.removeParam(index)
Removes a param at the specified index
index
Number
svySelectFilter.restoreState(jsonState) ⇒ AbstractPopupFilter
AbstractPopupFilter
Overrides: restoreState
jsonState
Object
svySelectFilter.setDataProvider(dataProvider)
Sets the popupFilter dataprovider
dataProvider
String
svySelectFilter.setOperator(operator)
operator
String
a value from scopes.svyPopupFilter.OPERATOR
svySelectFilter.setRendererForm(popupFilterForm)
popupFilterForm
svySelectFilter.setValues(values)
values
Array
svySelectFilter.showModalWindow([callback], [x], [y], [width], [height]) ⇒ Array.<JSRecord>
| Array.<(String|Date|Number)>
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
[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
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)>
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
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)
dataProvider
String
will override the lookupDataProvider
lookup
scopes.svyLookup.Lookup
SvyTokenFilter ⇐ AbstractPopupFilter
AbstractPopupFilter
Extends: AbstractPopupFilter
SvyTokenFilter ⇐
AbstractPopupFilter
.createPopUp(callback) ⇒
plugins.window.FormPopup
.getDataProvider() ⇒
String
.getID() ⇒
String
.getOperator() ⇒
String
.getParams() ⇒
Array
.getState() ⇒
Object
.getValues() ⇒
Array
.showModalWindow([callback], [x], [y], [width], [height]) ⇒
Array.<JSRecord>
|Array.<(String|Date|Number)>
.showWindow(win, [callback]) ⇒
[ 'Array' ].<(String|Date|Number)>
svyTokenFilter.addParam(param)
Add a params to be added into the onSelect callback arguments
param
Object
svyTokenFilter.clearParams()
Clear the params
svyTokenFilter.createPopUp(callback) ⇒ plugins.window.FormPopup
plugins.window.FormPopup
Creates and returns the popupFilter
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
JSWindow
Returns: JSWindow
- returns a JSWindow which can be used to show the popupFilter in it using popupFilter.showWindow(window)
[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
String
Gets the popupFilter dataprovider
svyTokenFilter.getID() ⇒ String
String
Gets the filter name
svyTokenFilter.getOperator() ⇒ String
String
svyTokenFilter.getParams() ⇒ Array
Array
svyTokenFilter.getState() ⇒ Object
Object
svyTokenFilter.getValues() ⇒ Array
Array
svyTokenFilter.removeParam(index)
Removes a param at the specified index
index
Number
svyTokenFilter.restoreState(jsonState) ⇒ AbstractPopupFilter
AbstractPopupFilter
jsonState
Object
svyTokenFilter.setDataProvider(dataProvider)
Sets the popupFilter dataprovider
dataProvider
String
svyTokenFilter.setOperator(operator)
operator
String
a value from scopes.svyPopupFilter.OPERATOR
svyTokenFilter.setRendererForm(popupFilterForm)
popupFilterForm
svyTokenFilter.setValues(values)
values
Array
svyTokenFilter.showModalWindow([callback], [x], [y], [width], [height]) ⇒ Array.<JSRecord>
| Array.<(String|Date|Number)>
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
[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
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)>
[ '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
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
OPERATOR
Properties
EQUALS
eq
GREATER_EQUAL
ge
GREATER_THEN
gt
SMALLER_EQUAL
le
SMALLER_THEN
lt
BETWEEN
BETWEEN
IS_IN
IN
createDateFilter() ⇒ SvyDateFilter
SvyDateFilter
createNumberFilter() ⇒ SvyNumberFilter
SvyNumberFilter
createSelectFilter(dataProvider, lookup) ⇒ SvySelectFilter
SvySelectFilter
dataProvider
String
lookup
scopes.svyLookup.Lookup
createTokenFilter() ⇒ SvyTokenFilter
SvyTokenFilter
Last updated