DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY (EXCEPT INSIDE THE DIV BELOW WITH ID=DESCRIPTION), UNLESS YOU KNOW WHAT YOU'RE DOING.
THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO AUTO UPDATE THE CONTENT THROUGH THE DOC GENERATOR
Return Types
{column:width=80px|padding=0px}{column}{column}{column}
Method Summary
void
addClientInfo(info)
Adds a string of client information which gets stored on the server,
and can be viewed on the Clients page of Servoy Server Administration Console.
void
beep()
Produces a "beep" sound; commonly used to indicate an error or warning dialog.
closeAllWindows()
Close all visible windows (except main application window).
void
closeSolution()
Closes the currently open solution and optionally opens another solution, calling a specified global method with the specified arguments.
void
closeSolution(solutionToLoad)
Closes the currently open solution and optionally opens another solution, calling a specified global method with the specified arguments.
void
closeSolution(solutionToLoad, methodName)
Closes the currently open solution and optionally opens another solution, calling a specified global method with the specified arguments.
void
closeSolution(solutionToLoad, methodName, methodArgument)
Closes the currently open solution and optionally opens another solution, calling a specified global method with the specified arguments.
createNewFormInstance(designFormName, newInstanceScriptName)
Create a new form instance.
createWindow(windowName, type)
Creates a new window that can be used for displaying forms.
createWindow(windowName, type, parentWindow)
Creates a new window that can be used for displaying forms.
executeProgram(program)
Execute a program and returns output.
executeProgram(program, params)
Execute a program and returns output.
executeProgram(program, params, environmentVars)
Execute a program and returns output.
executeProgram(program, params, environmentVars, startDir)
Execute a program and returns output.
void
executeProgramInBackground(program)
Execute a program in the background.
void
executeProgramInBackground(program, params)
Execute a program in the background.
void
executeProgramInBackground(program, params, environmentVars)
Execute a program in the background.
void
executeProgramInBackground(program, params, environmentVars, startDir)
Execute a program in the background.
getActiveClientCount(currentSolutionOnly)
Get the active user count on the server (can be limited to current solution).
getActiveWindow()
This gets the currently focused active window; this can be the main application window or a modal dialog.
getApplicationType()
Get the application type.
getClientCountForInfo(info)
Gets the count for all clients displaying the same additional information
in the Clients page of Servoy Server Administration Console.
getClientProperty(name)
Sets a UI property.
getClipboardString()
Gets a string from the clipboard, null if not a string or empty.
getCurrentLookAndFeelName()
Gets the name of the current Look And Feel specified in Application Preferences.
getHostName()
Get the name of the localhost.
getIPAddress()
Get the clients' IP address.
String[]
getLicenseNames()
Get the names of the used client licenses (as strings in array).
String[]
getPrinters()
Get all the printer names in an array.
getScreenHeight()
Get the screen height in pixels.
getScreenWidth()
Get the screen width in pixels.
getServerTimeStamp()
Returns a date object initialized on server with current date and time.
getServerURL()
Gets the HTTP server url.
getSolutionName()
Returns the name of the current solution.
getSolutionRelease()
Get the solution release number.
getTimeStamp()
Returns a date object initialized in client with current date and time.
getUserProperty(name)
Get a persistent user property.
String[]
getUserPropertyNames()
Get all persistent user property names.
getValueListArray(name)
Retrieve a valuelist as array, to get real-values for display-values.
getValueListDisplayValue(name, realValue)
Retrieve a valuelist display-value for a real-value.
getValueListItems(name)
Get all values from a custom or database type value list as dataset (with columns displayValue,realValue).
String[]
getValueListNames()
Get all the valuelist names as array.
getVersion()
Returns the application version.
isInDeveloper()
Returns true if the solution is running in the developer.
isLastPrintPreviewPrinted()
Check if the last printpreview did print.
void
output(msg)
Output something on the out stream.
void
output(msg, level)
Output something on the out stream.
void
overrideStyle(originalStyleName, newStyleName)
Overrides one style (defined in in a form) with another.
void
playSound(url)
Play a sound (AU file, an AIFF file, a WAV file, and a MIDI file).
putClientProperty(name, value)
Sets a UI property.
void
redo()
Redo last action (if possible).
void
removeAllClientInfo()
Removes all names given to the client via the admin page.
removeClientInfo(info)
Removes a string of client information which is stored on the server and
previously was added using the application.
void
setClipboardContent(string)
Sets a string object in the clipboard.
void
setNumpadEnterAsFocusNextEnabled(enabled)
Set if numpad enter should behave like focus next.
void
setStatusText(text)
Set the status area value.
void
setStatusText(text, tooltip)
Set the status area value.
void
setToolbarVisible(name, visible)
Make a toolbar visible or invisible.
void
setUserProperty(name, value)
Set a persistent user property.
void
setValueListItems(name, dataset)
Fill a custom type valuelist with values from array(s) or dataset.
void
setValueListItems(name, dataset, autoconvert)
Fill a custom type valuelist with values from array(s) or dataset.
void
setValueListItems(name, displayValues)
Fill a custom type valuelist with values from array(s) or dataset.
void
setValueListItems(name, displayValues, autoconvert)
Fill a custom type valuelist with values from array(s) or dataset.
void
setValueListItems(name, displayValues, realValues)
Fill a custom type valuelist with values from array(s) or dataset.
void
setValueListItems(name, displayValues, realValues, autoconvert)
Fill a custom type valuelist with values from array(s) or dataset.
showCalendar()
Show the calendar, returns selected date or null if canceled.
showCalendar(dateFormat)
Show the calendar, returns selected date or null if canceled.
showCalendar(selectedDate)
Show the calendar, returns selected date or null if canceled.
showCalendar(selectedDate, dateFormat)
Show the calendar, returns selected date or null if canceled.
showColorChooser()
Show the colorChooser.
showColorChooser(colorString)
Show the colorChooser.
showFontChooser()
Show the font chooser dialog.
showFontChooser(defaultFont)
Show the font chooser dialog.
void
showForm(form)
Show the form specified by the parameter, that can be a name (is case sensitive!) or a form object.
showI18NDialog()
Opens the i18n dialog so users can change translations.
showI18NDialog(keyToSelect)
Opens the i18n dialog so users can change translations.
showI18NDialog(keyToSelect, languageToSelect)
Opens the i18n dialog so users can change translations.
void
sleep(ms)
Sleep for specified time (in milliseconds).
void
undo()
Undo last action (if possible).
{column:width=100%|padding=0px}{column}
Method Details
void
addClientInfo
(info)
Parameters
{String} info – A line of text to be added as additional client information
on behalf of the running Servoy client.
Returns
void
Sample
application.addClientInfo('SaaS company name'); application.addClientInfo('For any issues call +31-SA-AS');
void
beep
()
Returns
void
Sample
application.beep();
closeAllWindows
()
Returns
Boolean – Boolean true if all windows were closed and false otherwise.
Sample
var win = application.createWindow("aWindowName", JSWindow.WINDOW, null); win.setInitialBounds(10, 10, 300, 300); win.title = "This is a window"; controller.show(win); var win2 = application.createWindow("anotherWindowName", JSWindow.WINDOW, null); win2.setInitialBounds(100, 100, 300, 300); win2.title = "This is another window"; controller.show(win2); var qdialog = plugins.dialogs.showQuestionDialog("QuestionDialog","Do you want to close the windows?","Yes","No"); if (qdialog == "Yes") { application.closeAllWindows(); controller.show(null); }
void
closeSolution
()
Returns
void
Sample
//application.showURL('http://www.servoy.com', '_self'); //Web Client only application.closeSolution(); //close current solution, open solution 'solution_name', call global method 'global_method_name' with argument 'my_argument'. //if the user has been logged in, he will stay logged in //application.closeSolution('solution_name','global_method_name','my_argument'); //Note: specifying a solution will not work in the Developer due to debugger dependencies //specified solution should be of compatible type with client (normal type or client specific(Smart client only/Web client only) type )
void
closeSolution
(solutionToLoad)
Parameters
{String} solutionToLoad – Name of the solution to load
Returns
void
Sample
//application.showURL('http://www.servoy.com', '_self'); //Web Client only application.closeSolution(); //close current solution, open solution 'solution_name', call global method 'global_method_name' with argument 'my_argument'. //if the user has been logged in, he will stay logged in //application.closeSolution('solution_name','global_method_name','my_argument'); //Note: specifying a solution will not work in the Developer due to debugger dependencies //specified solution should be of compatible type with client (normal type or client specific(Smart client only/Web client only) type )
void
closeSolution
(solutionToLoad, methodName)
Returns
void
Sample
//application.showURL('http://www.servoy.com', '_self'); //Web Client only application.closeSolution(); //close current solution, open solution 'solution_name', call global method 'global_method_name' with argument 'my_argument'. //if the user has been logged in, he will stay logged in //application.closeSolution('solution_name','global_method_name','my_argument'); //Note: specifying a solution will not work in the Developer due to debugger dependencies //specified solution should be of compatible type with client (normal type or client specific(Smart client only/Web client only) type )
void
closeSolution
(solutionToLoad, methodName, methodArgument)
Returns
void
Sample
//application.showURL('http://www.servoy.com', '_self'); //Web Client only application.closeSolution(); //close current solution, open solution 'solution_name', call global method 'global_method_name' with argument 'my_argument'. //if the user has been logged in, he will stay logged in //application.closeSolution('solution_name','global_method_name','my_argument'); //Note: specifying a solution will not work in the Developer due to debugger dependencies //specified solution should be of compatible type with client (normal type or client specific(Smart client only/Web client only) type )
createNewFormInstance
(designFormName, newInstanceScriptName)
Returns
Boolean – Boolean (true) if the instance was created succesfully, (false) otherwise
Sample
var ok = application.createNewFormInstance('orders','orders_view'); if (ok) { var dialog = application.createWindow("myDialog", JSWindow.DIALOG); dialog.show('orders_view') //forms['orders_view'].controller.show() //forms.xyz.elements.myTabPanel.addTab(forms['orders_view']) //forms['orders_view'].elements.mylabel.setLocation(10,20) }
createWindow
(windowName, type)
Sample
// create and show a window, with specified title, initial location and size // type of the window can be one of JSWindow.DIALOG, JSWindow.MODAL_DIALOG, JSWindow.WINDOW // If parentWindow is not specified, the current window will be used as parent; parentWindow parameter is only used by dialogs var win = application.createWindow("windowName", JSWindow.WINDOW); win.setInitialBounds(10, 10, 300, 300); win.title = "This is a window"; controller.show(win); // create and show a non-modal dialog with default initial bounds/title var nmd = application.createWindow("nonModalDialogName", JSWindow.DIALOG); controller.showRecords(15, nmd); // 15 is a single-number pk in this case
createWindow
(windowName, type, parentWindow)
Parameters
{String} windowName – the name of the window.
{Number} type – the type of the window. Can be one of JSWindow.DIALOG, JSWindow.MODAL_DIALOG, JSWindow.WINDOW.
{JSWindow} parentWindow – the parent JSWindow object. If it is not specified, the current window will be used as parent. This parameter is only used by dialogs.
Sample
// create and show a window, with specified title, initial location and size var win = application.createWindow("windowName", JSWindow.WINDOW); win.setInitialBounds(10, 10, 300, 300); win.title = "This is a window"; controller.show(win); // create and show a non-modal dialog with default initial bounds/title var nmd = application.createWindow("nonModalDialogName", JSWindow.DIALOG); controller.showRecords(15, nmd); // 15 is a single-number pk in this case
executeProgram
(program)
Parameters
{String} program – (fullpath) of the program to execute
Returns
String – The output generated by the program execution.
Sample
// For Windows systems: // Runs a binary located in the user's home directory. The application will run in the current working // directory, which in general is the one where Servoy was started from. application.executeProgram("c:\\Users\\myself\\myapp.exe", ["arg1", "arg2", "arg3"]); // The same as above, but run the application in the user's home directory. application.executeProgram("c:\\Users\\myself\\myapp.exe", ["arg1", "arg2", "arg3"], null, "c:\\Users\\myself\\"); // The same as above, but also set an environment variable for the called program. application.executeProgram("c:\\Users\\myself\\myapp.exe", ["arg1", "arg2", "arg3"], ["MY_ENV_VAR=something"], "c:\\Users\\myself\\"); // For non-Windows systems: application.executeProgram("/home/myself/myapp", ["arg1", "arg2", "arg3"]); application.executeProgram("/home/myself/myapp", ["arg1", "arg2", "arg3"], null, "/home/myself/"); application.executeProgram("/home/myself/myapp", ["arg1", "arg2", "arg3"], ["MY_ENV_VAR=something"], "/home/myself/"); // Open a file with the default application associated with it. (on Windows) application.executeProgram("rundll32.exe", ["url.dll,FileProtocolHandler", "filename"]); // Open a file with the default application associated with it. (on Linux) application.executeProgram("xdg-open", ["filename"]); // Open a file with the default application associated with it. (on MacOS) application.executeProgram("open", ["filename"]); // Open a file with a specific application (on MacOS). application.executeProgram("open", ["-a", "OpenOffice.org.app", "filename.doc"]);
executeProgram
(program, params)
Returns
String – The output generated by the program execution.
Sample
// For Windows systems: // Runs a binary located in the user's home directory. The application will run in the current working // directory, which in general is the one where Servoy was started from. application.executeProgram("c:\\Users\\myself\\myapp.exe", ["arg1", "arg2", "arg3"]); // The same as above, but run the application in the user's home directory. application.executeProgram("c:\\Users\\myself\\myapp.exe", ["arg1", "arg2", "arg3"], null, "c:\\Users\\myself\\"); // The same as above, but also set an environment variable for the called program. application.executeProgram("c:\\Users\\myself\\myapp.exe", ["arg1", "arg2", "arg3"], ["MY_ENV_VAR=something"], "c:\\Users\\myself\\"); // For non-Windows systems: application.executeProgram("/home/myself/myapp", ["arg1", "arg2", "arg3"]); application.executeProgram("/home/myself/myapp", ["arg1", "arg2", "arg3"], null, "/home/myself/"); application.executeProgram("/home/myself/myapp", ["arg1", "arg2", "arg3"], ["MY_ENV_VAR=something"], "/home/myself/"); // Open a file with the default application associated with it. (on Windows) application.executeProgram("rundll32.exe", ["url.dll,FileProtocolHandler", "filename"]); // Open a file with the default application associated with it. (on Linux) application.executeProgram("xdg-open", ["filename"]); // Open a file with the default application associated with it. (on MacOS) application.executeProgram("open", ["filename"]); // Open a file with a specific application (on MacOS). application.executeProgram("open", ["-a", "OpenOffice.org.app", "filename.doc"]);
executeProgram
(program, params, environmentVars)
Parameters
{String} program – (fullpath) of the program to execute
{String[]} params – an array of strings as program arguments
{String[]} environmentVars – array of strings, each element of which has environment variable settings in the format name=value, or null if the subprocess should inherit the environment of the current process.
Returns
String – The output generated by the program execution.
Sample
// For Windows systems: // Runs a binary located in the user's home directory. The application will run in the current working // directory, which in general is the one where Servoy was started from. application.executeProgram("c:\\Users\\myself\\myapp.exe", ["arg1", "arg2", "arg3"]); // The same as above, but run the application in the user's home directory. application.executeProgram("c:\\Users\\myself\\myapp.exe", ["arg1", "arg2", "arg3"], null, "c:\\Users\\myself\\"); // The same as above, but also set an environment variable for the called program. application.executeProgram("c:\\Users\\myself\\myapp.exe", ["arg1", "arg2", "arg3"], ["MY_ENV_VAR=something"], "c:\\Users\\myself\\"); // For non-Windows systems: application.executeProgram("/home/myself/myapp", ["arg1", "arg2", "arg3"]); application.executeProgram("/home/myself/myapp", ["arg1", "arg2", "arg3"], null, "/home/myself/"); application.executeProgram("/home/myself/myapp", ["arg1", "arg2", "arg3"], ["MY_ENV_VAR=something"], "/home/myself/"); // Open a file with the default application associated with it. (on Windows) application.executeProgram("rundll32.exe", ["url.dll,FileProtocolHandler", "filename"]); // Open a file with the default application associated with it. (on Linux) application.executeProgram("xdg-open", ["filename"]); // Open a file with the default application associated with it. (on MacOS) application.executeProgram("open", ["filename"]); // Open a file with a specific application (on MacOS). application.executeProgram("open", ["-a", "OpenOffice.org.app", "filename.doc"]);
executeProgram
(program, params, environmentVars, startDir)
Parameters
{String} program – (fullpath) of the program to execute
{String[]} params – an array of strings as program arguments
{String[]} environmentVars – array of strings, each element of which has environment variable settings in the format name=value, or null if the subprocess should inherit the environment of the current process.
{String} startDir – the working directory of the subprocess, or null if the subprocess should inherit the working directory of the current process.
Returns
String – The output generated by the program execution.
Sample
// For Windows systems: // Runs a binary located in the user's home directory. The application will run in the current working // directory, which in general is the one where Servoy was started from. application.executeProgram("c:\\Users\\myself\\myapp.exe", ["arg1", "arg2", "arg3"]); // The same as above, but run the application in the user's home directory. application.executeProgram("c:\\Users\\myself\\myapp.exe", ["arg1", "arg2", "arg3"], null, "c:\\Users\\myself\\"); // The same as above, but also set an environment variable for the called program. application.executeProgram("c:\\Users\\myself\\myapp.exe", ["arg1", "arg2", "arg3"], ["MY_ENV_VAR=something"], "c:\\Users\\myself\\"); // For non-Windows systems: application.executeProgram("/home/myself/myapp", ["arg1", "arg2", "arg3"]); application.executeProgram("/home/myself/myapp", ["arg1", "arg2", "arg3"], null, "/home/myself/"); application.executeProgram("/home/myself/myapp", ["arg1", "arg2", "arg3"], ["MY_ENV_VAR=something"], "/home/myself/"); // Open a file with the default application associated with it. (on Windows) application.executeProgram("rundll32.exe", ["url.dll,FileProtocolHandler", "filename"]); // Open a file with the default application associated with it. (on Linux) application.executeProgram("xdg-open", ["filename"]); // Open a file with the default application associated with it. (on MacOS) application.executeProgram("open", ["filename"]); // Open a file with a specific application (on MacOS). application.executeProgram("open", ["-a", "OpenOffice.org.app", "filename.doc"]);
void
executeProgramInBackground
(program)
Parameters
{String} program – (fullpath) of the program to execute
Returns
void
Sample
// For Windows systems: // Runs a binary located in the user's home directory. The application will run in the current working // directory, which in general is the one where Servoy was started from. application.executeProgramInBackground("c:\\Users\\myself\\myapp.exe", ["arg1", "arg2", "arg3"]); // The same as above, but run the application in the user's home directory. application.executeProgramInBackground("c:\\Users\\myself\\myapp.exe", ["arg1", "arg2", "arg3"], null, "c:\\Users\\myself\\"); // The same as above, but also set an environment variable for the called program. application.executeProgramInBackground("c:\\Users\\myself\\myapp.exe", ["arg1", "arg2", "arg3"], ["MY_ENV_VAR=something"], "c:\\Users\\myself\\"); // For non-Windows systems: application.executeProgramInBackground("/home/myself/myapp", ["arg1", "arg2", "arg3"]); application.executeProgramInBackground("/home/myself/myapp", ["arg1", "arg2", "arg3"], null, "/home/myself/"); application.executeProgramInBackground("/home/myself/myapp", ["arg1", "arg2", "arg3"], ["MY_ENV_VAR=something"], "/home/myself/"); // Open a file with the default application associated with it. (on Windows) application.executeProgramInBackground("rundll32.exe", ["url.dll,FileProtocolHandler", "filename"]); // Open a file with the default application associated with it. (on Linux) application.executeProgramInBackground("xdg-open", ["filename"]); // Open a file with the default application associated with it. (on MacOS) application.executeProgramInBackground("open", ["filename"]); // Open a file with a specific application (on MacOS). application.executeProgram("open", ["-a", "OpenOffice.org.app", "filename.doc"]);
void
executeProgramInBackground
(program, params)
Returns
void
Sample
// For Windows systems: // Runs a binary located in the user's home directory. The application will run in the current working // directory, which in general is the one where Servoy was started from. application.executeProgramInBackground("c:\\Users\\myself\\myapp.exe", ["arg1", "arg2", "arg3"]); // The same as above, but run the application in the user's home directory. application.executeProgramInBackground("c:\\Users\\myself\\myapp.exe", ["arg1", "arg2", "arg3"], null, "c:\\Users\\myself\\"); // The same as above, but also set an environment variable for the called program. application.executeProgramInBackground("c:\\Users\\myself\\myapp.exe", ["arg1", "arg2", "arg3"], ["MY_ENV_VAR=something"], "c:\\Users\\myself\\"); // For non-Windows systems: application.executeProgramInBackground("/home/myself/myapp", ["arg1", "arg2", "arg3"]); application.executeProgramInBackground("/home/myself/myapp", ["arg1", "arg2", "arg3"], null, "/home/myself/"); application.executeProgramInBackground("/home/myself/myapp", ["arg1", "arg2", "arg3"], ["MY_ENV_VAR=something"], "/home/myself/"); // Open a file with the default application associated with it. (on Windows) application.executeProgramInBackground("rundll32.exe", ["url.dll,FileProtocolHandler", "filename"]); // Open a file with the default application associated with it. (on Linux) application.executeProgramInBackground("xdg-open", ["filename"]); // Open a file with the default application associated with it. (on MacOS) application.executeProgramInBackground("open", ["filename"]); // Open a file with a specific application (on MacOS). application.executeProgram("open", ["-a", "OpenOffice.org.app", "filename.doc"]);
void
executeProgramInBackground
(program, params, environmentVars)
Parameters
{String} program – (fullpath) of the program to execute
{String[]} params – an array of strings as program arguments
{String[]} environmentVars – array of strings, each element of which has environment variable settings in the format name=value, or null if the subprocess should inherit the environment of the current process.
Returns
void
Sample
// For Windows systems: // Runs a binary located in the user's home directory. The application will run in the current working // directory, which in general is the one where Servoy was started from. application.executeProgramInBackground("c:\\Users\\myself\\myapp.exe", ["arg1", "arg2", "arg3"]); // The same as above, but run the application in the user's home directory. application.executeProgramInBackground("c:\\Users\\myself\\myapp.exe", ["arg1", "arg2", "arg3"], null, "c:\\Users\\myself\\"); // The same as above, but also set an environment variable for the called program. application.executeProgramInBackground("c:\\Users\\myself\\myapp.exe", ["arg1", "arg2", "arg3"], ["MY_ENV_VAR=something"], "c:\\Users\\myself\\"); // For non-Windows systems: application.executeProgramInBackground("/home/myself/myapp", ["arg1", "arg2", "arg3"]); application.executeProgramInBackground("/home/myself/myapp", ["arg1", "arg2", "arg3"], null, "/home/myself/"); application.executeProgramInBackground("/home/myself/myapp", ["arg1", "arg2", "arg3"], ["MY_ENV_VAR=something"], "/home/myself/"); // Open a file with the default application associated with it. (on Windows) application.executeProgramInBackground("rundll32.exe", ["url.dll,FileProtocolHandler", "filename"]); // Open a file with the default application associated with it. (on Linux) application.executeProgramInBackground("xdg-open", ["filename"]); // Open a file with the default application associated with it. (on MacOS) application.executeProgramInBackground("open", ["filename"]); // Open a file with a specific application (on MacOS). application.executeProgram("open", ["-a", "OpenOffice.org.app", "filename.doc"]);
void
executeProgramInBackground
(program, params, environmentVars, startDir)
Parameters
{String} program – (fullpath) of the program to execute
{String[]} params – an array of strings as program arguments
{String[]} environmentVars – array of strings, each element of which has environment variable settings in the format name=value, or null if the subprocess should inherit the environment of the current process.
{String} startDir – the working directory of the subprocess, or null if the subprocess should inherit the working directory of the current process.
Returns
void
Sample
// For Windows systems: // Runs a binary located in the user's home directory. The application will run in the current working // directory, which in general is the one where Servoy was started from. application.executeProgramInBackground("c:\\Users\\myself\\myapp.exe", ["arg1", "arg2", "arg3"]); // The same as above, but run the application in the user's home directory. application.executeProgramInBackground("c:\\Users\\myself\\myapp.exe", ["arg1", "arg2", "arg3"], null, "c:\\Users\\myself\\"); // The same as above, but also set an environment variable for the called program. application.executeProgramInBackground("c:\\Users\\myself\\myapp.exe", ["arg1", "arg2", "arg3"], ["MY_ENV_VAR=something"], "c:\\Users\\myself\\"); // For non-Windows systems: application.executeProgramInBackground("/home/myself/myapp", ["arg1", "arg2", "arg3"]); application.executeProgramInBackground("/home/myself/myapp", ["arg1", "arg2", "arg3"], null, "/home/myself/"); application.executeProgramInBackground("/home/myself/myapp", ["arg1", "arg2", "arg3"], ["MY_ENV_VAR=something"], "/home/myself/"); // Open a file with the default application associated with it. (on Windows) application.executeProgramInBackground("rundll32.exe", ["url.dll,FileProtocolHandler", "filename"]); // Open a file with the default application associated with it. (on Linux) application.executeProgramInBackground("xdg-open", ["filename"]); // Open a file with the default application associated with it. (on MacOS) application.executeProgramInBackground("open", ["filename"]); // Open a file with a specific application (on MacOS). application.executeProgram("open", ["-a", "OpenOffice.org.app", "filename.doc"]);
void
exit
()
Returns
void
Sample
// exit application application.exit();
getActiveClientCount
(currentSolutionOnly)
Parameters
{Boolean} currentSolutionOnly – Boolean (true) to get the active user count on server only to the current solution
Sample
var count = application.getActiveClientCount(true);
getActiveWindow
()
Sample
// get the currently active/focused window or dialog var activeWindow = application.getActiveWindow();
getApplicationType
()
Sample
var type = application.getApplicationType(); //see application type contstant
getClientCountForInfo
(info)
Parameters
{String} info – The additional client info string to search for.
Sample
var count = application.getClientCountForInfo('SaaS company name'); application.output('Including yourself, there are ' + count + ' client(s) running on behalf of the company.');
getClientProperty
(name)
Returns
Object – the property value for the given name/key, null of nothing was found
Sample
//Only use this function from the solution on open method! //In smart client, use this to set javax.swing.UIDefaults properties. application.putClientProperty('ToolTip.hideAccelerator', true) //To change the comboboxes selection background color, do this: application.putClientProperty('ComboBox.selectionBackground', new Packages.javax.swing.plaf.ColorUIResource(java.awt.Color.RED)) //In web client, use this to change the template directory. //To change the default dir of templates/default to templates/green_skin, do this: application.putClientProperty('templates.dir','green_skin');
getClipboardString
()
Sample
var fromClipboard = application.getClipboardString();
getCurrentLookAndFeelName
()
Sample
var laf = application.getCurrentLookAndFeelName();
getHostName
()
Sample
var hostName = application.getHostName();
getIPAddress
()
Sample
var ip = application.getIPAddress();
String[]
getLicenseNames
()
Sample
var array = application.getLicenseNames();
getOSName
()
Sample
var osname = application.getOSName();
String[]
getPrinters
()
Sample
var printersArray = application.getPrinters();
getScreenHeight
()
Sample
var height = application.getScreenHeight();
getScreenWidth
()
Sample
var width = application.getScreenWidth();
getServerTimeStamp
()
Sample
var servertime = application.getServerTimeStamp();
getServerURL
()
Sample
var url = application.getServerURL();
getSolutionName
()
Sample
var solutionName = application.getSolutionName();
getSolutionRelease
()
Sample
var release = application.getSolutionRelease();
getTimeStamp
()
Sample
var clienttime = application.getTimeStamp();
Sample
var new_uuid_object = application.getUUID(); // generate new uuid object var uuid_object1 = application.getUUID(new_uuid_object.toString()); // convert a string representing an uuid to an uuid object var uuid_object2 = application.getUUID(new_uuid_object.toBytes()); // convert a byte array representing an uuid to an uuid object
getUUID
(byteArray)
Parameters
{byte[]} byteArray – Byte array representing an uuid
Sample
var new_uuid_object = application.getUUID(); // generate new uuid object var uuid_object1 = application.getUUID(new_uuid_object.toString()); // convert a string representing an uuid to an uuid object var uuid_object2 = application.getUUID(new_uuid_object.toBytes()); // convert a byte array representing an uuid to an uuid object
getUUID
(uuidString)
Parameters
{String} uuidString – String representing an uuid
Sample
var new_uuid_object = application.getUUID(); // generate new uuid object var uuid_object1 = application.getUUID(new_uuid_object.toString()); // convert a string representing an uuid to an uuid object var uuid_object2 = application.getUUID(new_uuid_object.toBytes()); // convert a byte array representing an uuid to an uuid object
getUserProperty
(name)
Sample
var value = application.getUserProperty('showOrders');
String[]
getUserPropertyNames
()
Sample
// display all user properties allPropertyNames = application.getUserPropertyNames(); for(var i = 0; i < allPropertyNames.length; i++) { application.output(allPropertyNames[i] + " = " + application.getUserProperty(allPropertyNames[i])); }
getValueListArray
(name)
Sample
var packet_types = application.getValueListArray('packet_types'); if (a_realValue == packet_types['displayValue']) { }
getValueListDisplayValue
(name, realValue)
Returns
Object – Display value of the real value from the valuelist
Sample
var displayable_status = application.getValueListDisplayValue('case_status',status);
getValueListItems
(name)
Returns
JSDataSet – DataSet with valuelist's display values and real values
Sample
//Note:see databaseManager.JSDataSet for full details of dataset var dataset = application.getValueListItems('my_en_types'); //example to calc a strange total global_total = 0; for( var i = 1 ; i <= dataset.getMaxRowIndex() ; i++ ) { global_total = global_total + dataset.getValue(i,1); } //example to assign to dataprovider //employee_salary = dataset.getValue(1,1)
String[]
getValueListNames
()
Sample
var array = application.getValueListNames();
getVersion
()
Sample
application.getVersion();
getWindow
()
Sample
// close and dispose window resources var mainAppWindow = application.getWindow();
getWindow
(name)
Parameters
{String} name – the name of the window. If not specified, the main application JSWindow will be returned.
Returns
JSWindow – the JSWindow with the specified name, or null if no such window exists.
Sample
// close and dispose window resources var win = application.getWindow("someWindowName"); if (win != null) { win.destroy(); }
isInDeveloper
()
Returns
Boolean – Boolean (true) if the solution is running in the developer, (false) otherwise
Sample
var flag = application.isInDeveloper();
isLastPrintPreviewPrinted
()
Returns
Boolean – Boolean (true) is the last print preview did print, (false) otherwise
Sample
//attached this method to onShow on the form being shown after printpreview //set a global called scopes.globals.showPrintPreview to 1 in the onPrintPreview method if (scopes.globals.showPrintPreview == 1) { scopes.globals.showPrintPreview = 0;//clear for next time if (application.isLastPrintPreviewPrinted()) { plugins.dialogs.showInfoDialog('Alert', 'There is printed in printpreview', 'OK') } }
void
output
(msg)
Returns
void
Sample
// log level is used to determine how/if to log in servoy_log.txt; for smart client java out and err streams are used application.output('my very important trace msg');// default log level: info
void
output
(msg, level)
Returns
void
Sample
// log level is used to determine how/if to log in servoy_log.txt; for smart client java out and err streams are used application.output('my very important msg',LOGGINGLEVEL.ERROR);// log level: error
void
overrideStyle
(originalStyleName, newStyleName)
Returns
void
Sample
//This function will only have effect on forms not yet created, so solution onLoad is the best place to override' //For example overriding the use of default/designed style anywhere in the solution from 'mystyle' to 'mystyle_mac' application.overrideStyle('mystyle','mystyle_mace')//in this case both styles should have about the same classes
void
playSound
(url)
Returns
void
Sample
application.playSound('media:///click.wav');
putClientProperty
(name, value)
Returns
Boolean – Boolean (true) if the client property was set with the new value
Sample
//Only use this function from the solution on open method! //In smart client, use this to set javax.swing.UIDefaults properties. application.putClientProperty('ToolTip.hideAccelerator', true) //To change the comboboxes selection background color, do this: application.putClientProperty('ComboBox.selectionBackground', new Packages.javax.swing.plaf.ColorUIResource(java.awt.Color.RED)) //In web client, use this to change the template directory. //To change the default dir of templates/default to templates/green_skin, do this: application.putClientProperty('templates.dir','green_skin');
void
redo
()
Returns
void
Sample
application.redo();
void
removeAllClientInfo
()
Returns
void
Sample
application.removeAllClientInfo();
removeClientInfo
(info)
Parameters
{String} info – A line of text to be removed from the client information
on behalf of the running Servoy client.
Returns
Boolean – boolean indicator if info was removed successfully
Sample
var removed = application.removeClientInfo('SaaS company name');
void
setClipboardContent
(string)
Returns
void
Sample
application.setClipboardContent('test');
void
setNumpadEnterAsFocusNextEnabled
(enabled)
Parameters
{Boolean} enabled – Boolean (true) if numpad enter should behave like focus next
Returns
void
Sample
application.setNumpadEnterAsFocusNextEnabled(true);
void
setStatusText
(text)
Returns
void
Sample
application.setStatusText('Your status text');
void
setStatusText
(text, tooltip)
Returns
void
Sample
application.setStatusText('Your status text','Your status tooltip text');
void
setToolbarVisible
(name, visible)
Returns
void
Sample
//example: hide the text toolbar application.setToolbarVisible('text',false);
void
setUserProperty
(name, value)
Returns
void
Sample
application.setUserProperty('showOrders','1');
void
setValueListItems
(name, dataset)
Returns
void
Sample
//set display values (return values will be same as display values) application.setValueListItems('my_en_types',new Array('Item 1', 'Item 2', 'Item 3')); //set display values and return values (which are stored in dataprovider) //application.setValueListItems('my_en_types',new Array('Item 1', 'Item 2', 'Item 3'),new Array(10000,10010,10456)); //set display values and return values converted to numbers //application.setValueListItems('my_en_types',new Array('Item 1', 'Item 2', 'Item 3'),new Array('10000','10010', '10456'), true); //do query and fill valuelist (see databaseManager for full details of queries/dataset) //var query = 'select display_value,optional_real_value from test_table'; //var dataset = databaseManager.getDataSetByQuery(databaseManager.getDataSourceServerName(controller.getDataSource()), query, null, 25); //application.setValueListItems('my_en_types',dataset);
void
setValueListItems
(name, dataset, autoconvert)
Returns
void
Sample
//set display values (return values will be same as display values) application.setValueListItems('my_en_types',new Array('Item 1', 'Item 2', 'Item 3')); //set display values and return values (which are stored in dataprovider) //application.setValueListItems('my_en_types',new Array('Item 1', 'Item 2', 'Item 3'),new Array(10000,10010,10456)); //set display values and return values converted to numbers //application.setValueListItems('my_en_types',new Array('Item 1', 'Item 2', 'Item 3'),new Array('10000','10010', '10456'), true); //do query and fill valuelist (see databaseManager for full details of queries/dataset) //var query = 'select display_value,optional_real_value from test_table'; //var dataset = databaseManager.getDataSetByQuery(databaseManager.getDataSourceServerName(controller.getDataSource()), query, null, 25); //application.setValueListItems('my_en_types',dataset);
void
setValueListItems
(name, displayValues)
Returns
void
Sample
//set display values (return values will be same as display values) application.setValueListItems('my_en_types',new Array('Item 1', 'Item 2', 'Item 3')); //set display values and return values (which are stored in dataprovider) //application.setValueListItems('my_en_types',new Array('Item 1', 'Item 2', 'Item 3'),new Array(10000,10010,10456)); //set display values and return values converted to numbers //application.setValueListItems('my_en_types',new Array('Item 1', 'Item 2', 'Item 3'),new Array('10000','10010', '10456'), true); //do query and fill valuelist (see databaseManager for full details of queries/dataset) //var query = 'select display_value,optional_real_value from test_table'; //var dataset = databaseManager.getDataSetByQuery(databaseManager.getDataSourceServerName(controller.getDataSource()), query, null, 25); //application.setValueListItems('my_en_types',dataset);
void
setValueListItems
(name, displayValues, autoconvert)
Returns
void
Sample
//set display values (return values will be same as display values) application.setValueListItems('my_en_types',new Array('Item 1', 'Item 2', 'Item 3')); //set display values and return values (which are stored in dataprovider) //application.setValueListItems('my_en_types',new Array('Item 1', 'Item 2', 'Item 3'),new Array(10000,10010,10456)); //set display values and return values converted to numbers //application.setValueListItems('my_en_types',new Array('Item 1', 'Item 2', 'Item 3'),new Array('10000','10010', '10456'), true); //do query and fill valuelist (see databaseManager for full details of queries/dataset) //var query = 'select display_value,optional_real_value from test_table'; //var dataset = databaseManager.getDataSetByQuery(databaseManager.getDataSourceServerName(controller.getDataSource()), query, null, 25); //application.setValueListItems('my_en_types',dataset);
void
setValueListItems
(name, displayValues, realValues)
Returns
void
Sample
//set display values (return values will be same as display values) application.setValueListItems('my_en_types',new Array('Item 1', 'Item 2', 'Item 3')); //set display values and return values (which are stored in dataprovider) //application.setValueListItems('my_en_types',new Array('Item 1', 'Item 2', 'Item 3'),new Array(10000,10010,10456)); //set display values and return values converted to numbers //application.setValueListItems('my_en_types',new Array('Item 1', 'Item 2', 'Item 3'),new Array('10000','10010', '10456'), true); //do query and fill valuelist (see databaseManager for full details of queries/dataset) //var query = 'select display_value,optional_real_value from test_table'; //var dataset = databaseManager.getDataSetByQuery(databaseManager.getDataSourceServerName(controller.getDataSource()), query, null, 25); //application.setValueListItems('my_en_types',dataset);
void
setValueListItems
(name, displayValues, realValues, autoconvert)
Returns
void
Sample
//set display values (return values will be same as display values) application.setValueListItems('my_en_types',new Array('Item 1', 'Item 2', 'Item 3')); //set display values and return values (which are stored in dataprovider) //application.setValueListItems('my_en_types',new Array('Item 1', 'Item 2', 'Item 3'),new Array(10000,10010,10456)); //set display values and return values converted to numbers //application.setValueListItems('my_en_types',new Array('Item 1', 'Item 2', 'Item 3'),new Array('10000','10010', '10456'), true); //do query and fill valuelist (see databaseManager for full details of queries/dataset) //var query = 'select display_value,optional_real_value from test_table'; //var dataset = databaseManager.getDataSetByQuery(databaseManager.getDataSourceServerName(controller.getDataSource()), query, null, 25); //application.setValueListItems('my_en_types',dataset);
showCalendar
()
Sample
var selectedDate = application.showCalendar();
showCalendar
(dateFormat)
Sample
var selectedDate = application.showCalendar();
showCalendar
(selectedDate)
Sample
var selectedDate = application.showCalendar();
showCalendar
(selectedDate, dateFormat)
Sample
var selectedDate = application.showCalendar();
showColorChooser
()
Sample
var selectedColor = application.showColorChooser();
showColorChooser
(colorString)
Sample
var selectedColor = application.showColorChooser();
showFontChooser
()
Sample
var selectedFont = application.showFontChooser(); elements.myfield.font = selectedFont
showFontChooser
(defaultFont)
Sample
var selectedFont = application.showFontChooser(); elements.myfield.font = selectedFont
void
showForm
(form)
Returns
void
Sample
application.showForm('MyForm');
showI18NDialog
()
Returns
String – selected I18N key or null if cancel is pressed
Sample
application.showI18NDialog("servoy.button.close", "en");
showI18NDialog
(keyToSelect)
Returns
String – selected I18N key or null if cancel is pressed
Sample
application.showI18NDialog("servoy.button.close", "en");
showI18NDialog
(keyToSelect, languageToSelect)
Returns
String – selected I18N key or null if cancel is pressed
Sample
application.showI18NDialog("servoy.button.close", "en");
showURL
(url)
Sample
application.showURL('http://www.example.com'); //webclient specific additional parameters... //2nd parameter: target frame or named dialog/window, so its possible to control in which (internal) frame or dialog the url is loaded, '_self' is current window,'_blank' is new dialog, '_top' is main window //3rd parameter: dialog options used when a dialog is specified, example: 'height=200,width=400,status=yes,toolbar=no,menubar=no,location=no' //3th or 4th parameter: a timeout in seconds when the url should be shown, immediantly/0 is default'
showURL
(url, webclientTarget)
Sample
application.showURL('http://www.example.com'); //webclient specific additional parameters... //2nd parameter: target frame or named dialog/window, so its possible to control in which (internal) frame or dialog the url is loaded, '_self' is current window,'_blank' is new dialog, '_top' is main window //3rd parameter: dialog options used when a dialog is specified, example: 'height=200,width=400,status=yes,toolbar=no,menubar=no,location=no' //3th or 4th parameter: a timeout in seconds when the url should be shown, immediantly/0 is default'
showURL
(url, webclientTarget, timeout)
Sample
application.showURL('http://www.example.com'); //webclient specific additional parameters... //2nd parameter: target frame or named dialog/window, so its possible to control in which (internal) frame or dialog the url is loaded, '_self' is current window,'_blank' is new dialog, '_top' is main window //3rd parameter: dialog options used when a dialog is specified, example: 'height=200,width=400,status=yes,toolbar=no,menubar=no,location=no' //3th or 4th parameter: a timeout in seconds when the url should be shown, immediantly/0 is default'
showURL
(url, webclientTarget, webclientTargetOptions)
Sample
application.showURL('http://www.example.com'); //webclient specific additional parameters... //2nd parameter: target frame or named dialog/window, so its possible to control in which (internal) frame or dialog the url is loaded, '_self' is current window,'_blank' is new dialog, '_top' is main window //3rd parameter: dialog options used when a dialog is specified, example: 'height=200,width=400,status=yes,toolbar=no,menubar=no,location=no' //3th or 4th parameter: a timeout in seconds when the url should be shown, immediantly/0 is default'
showURL
(url, webclientTarget, webclientTargetOptions, timeout)
Parameters
{String} url – URL to show
{String} webclientTarget – Target frame or named dialog/window
{String} webclientTargetOptions – Dialog options used when a dialog is specified / a timeout in seconds when the url should be shown
{Number} timeout – A timeout in seconds when the url should be shown
Sample
application.showURL('http://www.example.com'); //webclient specific additional parameters... //2nd parameter: target frame or named dialog/window, so its possible to control in which (internal) frame or dialog the url is loaded, '_self' is current window,'_blank' is new dialog, '_top' is main window //3rd parameter: dialog options used when a dialog is specified, example: 'height=200,width=400,status=yes,toolbar=no,menubar=no,location=no' //3th or 4th parameter: a timeout in seconds when the url should be shown, immediantly/0 is default'
void
sleep
(ms)
Returns
void
Sample
//Sleep for 3 seconds application.sleep(3000);
void
undo
()
Returns
void
Sample
application.undo();
void
updateUI
()
Returns
void
void
updateUI
(milliseconds)
Parameters
{Number} milliseconds – How long the update should take in milliseconds
Returns
void