Table Row (tr) |
---|
| Table Head (th) |
---|
| Method Details |
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
addClientInfo |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| void |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| addClientInfo |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
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. The new piece of client information is added on behalf of the running Servoy client. This function can be called more than once, if you want to add multiple lines of client information. NOTE: This function can also be used with the function <em>getClientCountForInfo</em> to count the number of clients with matching addditional client information. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters {String} info – A line of text to be added as additional client information on behalf of the running Servoy client. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns void |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
application.addClientInfo('SaaS company name');
application.addClientInfo('For any issues call +31-SA-AS');
|
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| void |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| beep |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Produces a "beep" sound; commonly used to indicate an error or warning dialog. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns void |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
application.beep();
|
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| Boolean |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| closeForm |
Span |
---|
| ([windowOrDialogName/closeAll]) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Close the dialog/window with the given name (call this method to hide the form shown with 'showFormInDialog' or 'showFormInWindow'). If (true) is passed, then all the windows/dialogs will be closed. If the name is missing or null, the default dialog/window will be closed. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters [windowOrDialogName/closeAll] – Name of the dialog/window to close, or (true) to close all open dialogs/windows. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Boolean – Boolean (true) if the dialog(s)/window(s) were closed, (false) otherwise |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
application.closeForm(); // closes the current dialog/window
//application.closeForm('windowOrDialogName'); //closes the dialog/window with this specific name
|
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
closeSolution |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| void |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| closeSolution |
Span |
---|
| ([solutionToLoad], [method], [argument]) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Close the current open solution and optionally open a new one. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters [solutionToLoad] – Name of the solution to load [method] – Name of the global method to call [argument] – Argument passed to the global method |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns void |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
application.closeSolution();
//application.closeSolution('solution_name','global_method_name','my_argument');//log out, open solution 'solution_name', call global method 'global_method_name' with argument 'my_argument'
//note: specifying a solution will not work in developer due to debugger dependencies
|
|
|
|
|
Table Body (tbody) |
---|
id | createNewFormInstance |
---|
class | node |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| Boolean |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| createNewFormInstance |
Span |
---|
| (designFormName, newInstanceScriptName) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Create a new form instance. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters {String} designFormName – Name of the design form {String} newInstanceScriptName – Name of the new form instance |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Boolean – Boolean (true) if the instance was created succesfully, (false) otherwise |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
var ok = application.createNewFormInstance('orders','orders_view');
if (ok)
{
application.showFormInDialog(forms.orders_view)
//forms['orders_view'].controller.show()
//forms.xyz.elements.myTabPanel.addTab(forms['orders_view'])
//forms['orders_view'].elements.mylabel.setLocation(10,20)
}
|
|
|
|
|
Table Body (tbody) |
---|
id | executeProgram |
---|
class | node |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
executeProgram |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| String |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| executeProgram |
Span |
---|
| (programName(fullpath), [arg1], [arg2], [argN], [#], environmentvar1, [environmentvarN], [startdirectory]) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Execute a program and returns output. Specify the cmd as you would do in a console. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters programName(fullpath) – Name of the program to execute [arg1] – Argument [arg2] – Argument [argN] – Argument [#] – Divider between program args, environment vars and startdir environmentvar1 – Environment variable [environmentvarN] – Environment variable [startdirectory] – Program start directory |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns String – The output generated by the program execution. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
//'#' is divider between program args, environment vars and startdir
var program_output = application.executeProgram('c:/temp/program.ext','arg0','arg1','argN','#','path=c:/temp','#','c:/temp');
|
|
|
|
|
Table Body (tbody) |
---|
id | executeProgramInBackground |
---|
class | node |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
executeProgramInBackground |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| void |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| executeProgramInBackground |
Span |
---|
| (programName(fullpath), [arg1], [arg2], [argN], [#], [environmentvar1], [environmentvarN], [startdirectory]) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Execute a program in the background. Specify the cmd as you would do in a console. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters programName(fullpath) – Name of the program to execute in background [arg1] – Argument [arg2] – Argument [argN] – Argument [#] – Divider between program args, environment vars and startdir [environmentvar1] – Environment variable [environmentvarN] – Environment variable [startdirectory] – Environment variable |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns void |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
//'#' is divider between program args, environment vars and startdir
application.executeProgramInBackground('c:/temp/program.ext','arg0','arg1','argN');
|
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| void |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| exit |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Stop and exit application. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns void |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
// exit application
application.exit();
|
|
|
|
|
Table Body (tbody) |
---|
id | getActiveClientCount |
---|
class | node |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getActiveClientCount |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| Number |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| getActiveClientCount |
Span |
---|
| (currentSolutionOnly) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Get the active user count on the server (can be limited to current solution). |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters {Boolean} currentSolutionOnly – Boolean (true) to get the active user count on server only to the current solution |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Number – Active user count on the server |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
var count = application.getActiveClientCount(true);
|
|
|
|
|
Table Body (tbody) |
---|
id | getApplicationType |
---|
class | node |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getApplicationType |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| Number |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| getApplicationType |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Get the application type. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Number – Constant application type |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
var type = application.getApplicationType();
//see application type contstant
|
|
|
|
|
Table Body (tbody) |
---|
id | getClientCountForInfo |
---|
class | node |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getClientCountForInfo |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| Number |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| getClientCountForInfo |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Gets the count for all clients displaying the same additional information in the Clients page of Servoy Server Administration Console. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters {String} info – The additional client info string to search for. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Number – Number of clients |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
var count = application.getClientCountForInfo('SaaS company name');
application.output('Including yourself, there are ' + count + ' client(s) running on behalf of the company.');
|
|
|
|
|
Table Body (tbody) |
---|
id | getClipboardString |
---|
class | node |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getClipboardString |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| String |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| getClipboardString |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Gets a string from the clipboard, null if not a string or empty. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns String – The string from the clipboard |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
var fromClipboard = application.getClipboardString();
|
|
|
|
|
Table Body (tbody) |
---|
id | getCurrentLookAndFeelName |
---|
class | node |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getCurrentLookAndFeelName |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| String |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| getCurrentLookAndFeelName |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Gets the name of the current Look And Feel specified in Application Preferences. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns String – Current Look And Feel |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
var laf = application.getCurrentLookAndFeelName();
|
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getHostName |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| String |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| getHostName |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Get the name of the localhost. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns String – Name of the localhost |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
var hostName = application.getHostName();
|
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getIPAddress |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| String |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| getIPAddress |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Get the clients' IP address. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns String – IP address of the client |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
var ip = application.getIPAddress();
|
|
|
|
|
Table Body (tbody) |
---|
id | getLicenseNames |
---|
class | node |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getLicenseNames |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| String[] |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| getLicenseNames |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Get the names of the used client licenses (as strings in array). |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns String[] – Client licenses names |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
var array = application.getLicenseNames();
|
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| String |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| getOSName |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns the name of the operating system. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns String – Name of the operating system |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
var osname = application.getOSName();
|
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getPrinters |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| String[] |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| getPrinters |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Get all the printer names in an array. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns String[] – All printer names |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
var printersArray = application.getPrinters();
|
|
|
|
|
Table Body (tbody) |
---|
id | getScreenHeight |
---|
class | node |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getScreenHeight |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| Number |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| getScreenHeight |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Get the screen height in pixels. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Number – Screen height |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
var height = application.getScreenHeight();
|
|
|
|
|
Table Body (tbody) |
---|
id | getScreenWidth |
---|
class | node |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getScreenWidth |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| Number |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| getScreenWidth |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Get the screen width in pixels. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Number – Screen width |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
var width = application.getScreenWidth();
|
|
|
|
|
Table Body (tbody) |
---|
id | getServerTimeStamp |
---|
class | node |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getServerTimeStamp |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| Date |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| getServerTimeStamp |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns a date object initialized on server with current date and time. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Date – Server time |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
var servertime = application.getServerTimeStamp();
|
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getServerURL |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| String |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| getServerURL |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Gets the HTTP server url. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns String – HTTP server URL |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
var url = application.getServerURL();
|
|
|
|
|
Table Body (tbody) |
---|
id | getSolutionName |
---|
class | node |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getSolutionName |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| String |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| getSolutionName |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns the name of the current solution. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns String – Current solution name |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
var solutionName = application.getSolutionName();
|
|
|
|
|
Table Body (tbody) |
---|
id | getSolutionRelease |
---|
class | node |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getSolutionRelease |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| Number |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| getSolutionRelease |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Get the solution release number. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Number – Current solution release number |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
var release = application.getSolutionRelease();
|
|
|
|
|
Table Body (tbody) |
---|
id | getStartupArguments |
---|
class | node |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getStartupArguments |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| Object[] |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| getStartupArguments |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Get the parameters which are provided by startup. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Object[] – Array with 2 elements, the startup argument and an object containing all startup arguments, or null if there is no argument passed |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
var args_array = application.getStartupArguments();
// the first element in the array is the 'argument' value from the startup
var argument = args_array[0];
// the second element is an object containing all the startup arguments
var startupArgumentObj = args_array[1];
var arg1 = startupArgumentObj.arg1_name;
var arg2 = startupArgumentObj.arg2_name;
|
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getTimeStamp |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| Date |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| getTimeStamp |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns a date object initialized in client with current date and time. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Date – Current time at the client |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
var clienttime = application.getTimeStamp();
|
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| UUID |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| getUUID |
Span |
---|
| ([uuidStringOrByteArray]) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Get a new UUID object (also known as GUID) or convert the parameter (that can be string or byte array) to an UUID object. A table column marked as UUID will work with such objects. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters [uuidStringOrByteArray] – String or byte array representing an uuid |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns UUID – The new UUID object |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
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
|
|
|
|
|
Table Body (tbody) |
---|
id | getUserProperty |
---|
class | node |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getUserProperty |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| String |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| getUserProperty |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Get a persistent user property. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters {String} name – Name of the property |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns String – Property value |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
var value = application.getUserProperty('showOrders');
|
|
|
|
|
Table Body (tbody) |
---|
id | getUserPropertyNames |
---|
class | node |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getUserPropertyNames |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| String[] |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| getUserPropertyNames |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Get all persistent user property names. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns String[] – Array of all user property names |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
// display all user properties
allPropertyNames = application.getUserPropertyNames();
for(var i = 0; i < allPropertyNames.length; i++)
application.output(allPropertyNames[i] + " = " + application.getUserProperty(allPropertyNames[i]));
|
|
|
|
|
Table Body (tbody) |
---|
id | getValueListArray |
---|
class | node |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getValueListArray |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| Array |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| getValueListArray |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Retrieve a valuelist as array, to get real-values for display-values. NOTE: this doesn't return a value for a valuelist that depends on a database relation or is a global method valuelist. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters {String} name – The name of the valuelist |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Array – Named array for the valuelist |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
var packet_types = application.getValueListArray('packet_types');
if (a_realValue == packet_types['displayValue'])
{
}
|
|
|
|
|
Table Body (tbody) |
---|
id | getValueListDisplayValue |
---|
class | node |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getValueListDisplayValue |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| Object |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| getValueListDisplayValue |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Retrieve a valuelist display-value for a real-value. NOTE: this doesn't return a value for a valuelist that depends on a database relation or is a global method valuelist. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters {String} name – Name of the valuelist {Object} realValue – Real value of the valuelist |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Object – Display value of the real value from the valuelist |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
var displayable_status = application.getValueListDisplayValue('case_status',status);
|
|
|
|
|
Table Body (tbody) |
---|
id | getValueListItems |
---|
class | node |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getValueListItems |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| JSDataSet |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| getValueListItems |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Get all values from a custom or database type value list as dataset (with columns displayValue,realValue). NOTE: this doesn't return a value for a valuelist that depends on a database relation or is a global method valuelist. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters {String} name – Name of the valuelist |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns JSDataSet – DataSet with valuelist's display values and real values |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
//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)
|
|
|
|
|
Table Body (tbody) |
---|
id | getValueListNames |
---|
class | node |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getValueListNames |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| String[] |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| getValueListNames |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Get all the valuelist names as array. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns String[] – Array with all valuelist names |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
var array = application.getValueListNames();
|
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getVersion |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| String |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| getVersion |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns the application version. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns String – Application version |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
application.getVersion();
|
|
|
|
|
Table Body (tbody) |
---|
id | getWindowHeight |
---|
class | node |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getWindowHeight |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| Number |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| getWindowHeight |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Get the window height in pixels. If windowName is not specified or null, it will use either the default dialog (if it is shown) or the main application window. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters [windowName] – Name of the window |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Number – Window height |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
var height = application.getWindowHeight('customerDialog');
|
|
|
|
|
Table Body (tbody) |
---|
id | getWindowWidth |
---|
class | node |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getWindowWidth |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| Number |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| getWindowWidth |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Get the window width in pixels. If windowName is not specified or null, it will use either the default dialog (if it is shown) or the main application window. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters [windowName] – Name of the window |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Number – Window width |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
var width = application.getWindowWidth('customerDialog');
|
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getWindowX |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| Number |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| getWindowX |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Get the window X location in pixels. If windowName is not specified or null, it will use either the default dialog (if it is shown) or the main application window. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters [windowName] – Window name |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Number – Window X location |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
var x = application.getWindowX('customerDialog');
|
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getWindowY |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| Number |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| getWindowY |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Get the window Y location in pixels. If windowName is not specified or null, it will use either the default dialog (if it is shown) or the main application window. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters [windowName] – Name of the window |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Number – Window Y location |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
var y = application.getWindowY('customerDialog');
|
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
isInDeveloper |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| Boolean |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| isInDeveloper |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns true if the solution is running in the developer. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Boolean – Boolean (true) if the solution is running in the developer, (false) otherwise |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
var flag = application.isInDeveloper();
|
|
|
|
|
Table Body (tbody) |
---|
id | isLastPrintPreviewPrinted |
---|
class | node |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
isLastPrintPreviewPrinted |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| Boolean |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| isLastPrintPreviewPrinted |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Check if the last printpreview did print. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Boolean – Boolean (true) is the last print preview did print, (false) otherwise |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
//attached this method to onShow on the form being shown after printpreview
//set a global called globals.showPrintPreview to 1 in the onPrintPreview method
if (globals.showPrintPreview == 1)
{
globals.showPrintPreview = 0;//clear for next time
if (application.isLastPrintPreviewPrinted())
{
plugins.dialogs.showInfoDialog('Alert', 'There is printed in printpreview', 'OK')
}
}
|
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| void |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| output |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Output something on the out stream. (if running in debugger view output console tab) |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters {Object} msg – Object to send to output stream {Number} [level] – the log level where it should log to. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns void |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
// 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
application.output('my very important msg',LOGGINGLEVEL.LOGLEVEL_ERROR);// log level: error
|
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
overrideStyle |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| void |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| overrideStyle |
Span |
---|
| (originalStyleName, newStyleName) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Overrides one style (defined in in a form) with another. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters {String} originalStyleName – Name of the style to override {String} newStyleName – Name of the new style |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns void |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
//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
|
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| void |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| playSound |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Play a sound (AU file, an AIFF file, a WAV file, and a MIDI file). |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters {String} url – URL of the sound file |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns void |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
application.playSound('media:///click.wav');
|
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| void |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| redo |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Redo last action (if possible). |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns void |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
application.redo();
|
|
|
|
|
Table Body (tbody) |
---|
id | removeAllClientInfo |
---|
class | node |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
removeAllClientInfo |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| void |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| removeAllClientInfo |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Removes all names given to the client via the admin page. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns void |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
application.removeAllClientInfo();
|
|
|
|
|
Table Body (tbody) |
---|
id | setClipboardContent |
---|
class | node |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
setClipboardContent |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| void |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| setClipboardContent |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sets a string object in the clipboard. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters {Object} string – New content of the clipboard |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns void |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
application.setClipboardContent('test');
|
|
|
|
|
Table Body (tbody) |
---|
id | setNumpadEnterAsFocusNextEnabled |
---|
class | node |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
setNumpadEnterAsFocusNextEnabled |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| void |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| setNumpadEnterAsFocusNextEnabled |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Set if numpad enter should behave like focus next. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters {Boolean} enabled – Boolean (true) if numpad enter should behave like focus next |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns void |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
application.setNumpadEnterAsFocusNextEnabled(true);
|
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
setStatusText |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| void |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| setStatusText |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Set the status area value. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters text – New status text [tip] – Status tooltip text |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns void |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
application.setStatusText('Your status text');
|
|
|
|
|
Table Body (tbody) |
---|
id | setToolbarVisible |
---|
class | node |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| void |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| setToolbarVisible |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Make a toolbar visible or invisible. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters {String} name – Name of the toolbar {Boolean} visible – Visibility of the toolbar |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns void |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
//example: hide the text toolbar
application.setToolbarVisible('text',false);
|
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
setUIProperty |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| Boolean |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| setUIProperty |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sets a UI property. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters {Object} name – Name of the UI property {Object} value – New value of the UI property |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Boolean – Boolean (true) if the UI property was set with the new value |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
//Only use this function from the solution on open method!
//In smart client, use this to set javax.swing.UIDefaults properties.
application.setUIProperty('ToolTip.hideAccelerator', true)
//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.setUIProperty('templates.dir','green_skin');
|
|
|
|
|
Table Body (tbody) |
---|
id | setUserProperty |
---|
class | node |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
setUserProperty |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| void |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| setUserProperty |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Set a persistent user property. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters {String} name – Name of the user property {String} value – New value of the user property |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns void |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
application.setUserProperty('showOrders','1');
|
|
|
|
|
Table Body (tbody) |
---|
id | setValueListItems |
---|
class | node |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
setValueListItems |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| void |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| setValueListItems |
Span |
---|
| (name, displayValArray/dataset, [realValuesArray], [autoconvert(false)]) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Fill a custom type valuelist with values from array(s) or dataset. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters name – Name of the valuelist displayValArray/dataset – Display values array or DataSet [realValuesArray] – Real values array [autoconvert(false)] – Boolean (true) if display values and return values should be converted to numbers |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns void |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
//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);
|
|
|
|
|
Table Body (tbody) |
---|
id | setWindowLocation |
---|
class | node |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
setWindowLocation |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| void |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| setWindowLocation |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Set the window location. If windowName is not specified or null, it will use either the default dialog (if it is shown) or the main application window. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters x – Window new X location y – Window new Y location [windowName] – Name of the window |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns void |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
application.setWindowLocation(10,10,'customerDialog');
|
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
setWindowSize |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| void |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| setWindowSize |
Span |
---|
| (width, height, [windowName]) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Set the window size. If windowName is not specified or null, it will resize either the default dialog (if it is shown) or the main application window. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters width – Window new width height – Window new height [windowName] – Name of the window |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns void |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
application.setWindowSize(400,400,'customerDialog');
|
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
showCalendar |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| Date |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| showCalendar |
Span |
---|
| ([selecteddate], [dateformat]) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Show the calendar, returns selected date or null if canceled. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters [selecteddate] – Default selected date [dateformat] – Date format |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Date – Selected date or null if canceled |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
var selectedDate = application.showCalendar();
|
|
|
|
|
Table Body (tbody) |
---|
id | showColorChooser |
---|
class | node |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
showColorChooser |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| String |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| showColorChooser |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Show the colorChooser. Returned value is in format #RRGGBB or null if canceled. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters [colorString] – Default color |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns String – selected color or null if canceled |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
var selectedColor = application.showColorChooser();
|
|
|
|
|
Table Body (tbody) |
---|
id | showFontChooser |
---|
class | node |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
showFontChooser |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| String |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| showFontChooser |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Show the font chooser dialog. Returns the selected font. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters [fontString] – Default font |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns String – selected font |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
var selectedFont = application.showFontChooser();
elements.myfield.font = selectedFont
|
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| void |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| showForm |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Show the form specified by the parameter, that can be a name (is case sensitive!) or a form object. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters {Object} form – Form object or name |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns void |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
application.showForm('MyForm');
|
|
|
|
|
Table Body (tbody) |
---|
id | showFormInDialog |
---|
class | node |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| void |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| showFormInDialog |
Span |
---|
| (form, [x], [y], [width], [height], [dialogTitle], [resizable], [showTextToolbar], [windowName], [modal]) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Show the specified form in a dialog. (NOTE: x, y, width, height are initial bounds - applied only the fist time a dialog is shown) NOTE: In the Smart Client, no code is executed after the function showFormInDialog <em>if the dialog is modal</em>. NOTE: x, y, width and height coordinates are only applied the first time the specified dialog is shown. Use APP_UI_PROPERTY.FULL_SCREEN for these values when the dialog should be full-screen. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters form – The form to be shown in the dialog. [x] – The "x" coordinate of the dialog. [y] – The "y" coordinate of the dialog. [width] – The width of the dialog. [height] – The height of the dialog. [dialogTitle] – The title of the dialog. [resizable] – <em>true</em> if the dialog size should be modifiable; <em>false</em> if not. [showTextToolbar] – <em>true</em> to add a text toolbar; <em>false</em> to not add a text toolbar. [windowName] – The name of the window; defaults to "dialog" if nothing is specified. Window and dialog names share the same namespace. [modal] – <em>true</em> if the dialog should be modal; <em>false</em> if not. Defaults to <em>true</em>. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns void |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
//Show the specified form in a modal dialog, on default initial location and size (x,y,w,h)
//application.showFormInDialog(forms.contacts);
//Note: No code is executed after the showFormInDialog until the dialog is closed if it is created as a modal dialog.
//Show the specified form in a non-modal dialog with a specified name, on default initial location and size (x,y,w,h)
//application.showFormInDialog(forms.contacts,'contactsdialog',false);
//Show the specified form in a modal dialog, at a specified initial location and size with custom title, not resizable but with text toolbar
application.showFormInDialog(forms.contacts,100,80,500,300,'my own dialog title',false,true,'mydialog',true);
|
|
|
|
|
Table Body (tbody) |
---|
id | showFormInWindow |
---|
class | node |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| void |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| showFormInWindow |
Span |
---|
| (form, [x], [y], [width], [height], [dialogTitle], [resizable], [showTextToolbar], [windowName]) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Show the specified form in a window. (NOTE: x, y, width, height are initial bounds - applied only the fist time a window is shown) NOTE: Forms in windows cannot be modal. They are more independent then dialogs, even non-modal ones. For example in SC, a non-modal dialog will always be shown on top of the parent window and it will not have a separate entry in the OS window manager (for example Windows taskbar). NOTE: x, y, width and height coordinates are only applied the first time the specified window is shown. Use APP_UI_PROPERTY.FULL_SCREEN for these values when the window should be full-screen. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters form – The form to be shown in the dialog. [x] – The "x" coordinate of the dialog. [y] – The "y" coordinate of the dialog. [width] – The width of the dialog. [height] – The height of the dialog. [dialogTitle] – The title of the dialog. [resizable] – <em>true</em> if the dialog size should be modifiable; <em>false</em> if not. [showTextToolbar] – <em>true</em> to add a text toolbar; <em>false</em> to not add a text toolbar. [windowName] – The name of the window; defaults to "dialog" if nothing is specified. Window and dialog names share the same namespace. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns void |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
//Show the specified form in a window, on default initial location and size
//application.showFormInWindow(forms.contacts);
//Show the specified form in a window with a specified name, on default initial location and size
//application.showFormInWindow(forms.contacts,'contactsWindow');
//Show the specified form in a window, at a specified initial location and size with custom title, not resizable but with text toolbar
application.showFormInWindow(forms.contacts,100,80,500,300,'my own window title',false,true,'mywindow');
|
|
|
|
|
Table Body (tbody) |
---|
id | showI18NDialog |
---|
class | node |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
showI18NDialog |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| String |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| showI18NDialog |
Span |
---|
| ([keyToSelect], [languageToSelect]) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Opens the i18n dialog so users can change translations. Returns the key selected by the user (not it's translation) or null if cancel is pressed. Optional parameters specify the initial selections in the dialog. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters [keyToSelect] – Default selected key [languageToSelect] – Default selected language |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns String – selected I18N key or null if cancel is pressed |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
application.showI18NDialog("servoy.button.close", "en");
|
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| Boolean |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| showURL |
Span |
---|
| (url, [webclientTarget], [webclientTargetOptions/timeout], [timeout]) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Shows an URL in a browser. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters url – URL to show [webclientTarget] – Target frame or named dialog/window [webclientTargetOptions/timeout] – Dialog options used when a dialog is specified / a timeout in seconds when the url should be shown [timeout] – A timeout in seconds when the url should be shown |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Boolean – Boolean (true) if URL was shown |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
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'
|
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| void |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| sleep |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sleep for specified time (in milliseconds). |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters {Number} ms – Sleep time in milliseconds |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns void |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
//Sleep for 3 seconds
application.sleep(3000);
|
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| void |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| undo |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Undo last action (if possible). |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns void |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
application.undo();
|
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| void |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| updateUI |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Updates the UI (painting). If in a script an element changed and the script continues doing things, you can give an number in ms how long this can take. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters [milliseconds] – How long the update should take in milliseconds |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns void |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
application.updateUI(500);
//continue doing things
|
|
|
|
|
|