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
{column:width=80px|padding=0px}{column}{column}{column}
Constants Summary
FULL_SCREEN
Value that can be used for bounds in order to specify that a dialog/window should completely fill the screen.
MODAL_DIALOG
Window type constant that identifies a modal dialog type.
{column:width=80px|padding=0px}{column}{column}{column}
Property Summary
controller
Get the current controller from the window/dialog.
storeBounds
Tells whether or not the bounds of this window should be stored/persisted (default false).
undecorated
Gets/Sets the undecorated property.
{column:width=80px|padding=0px}{column}{column}{column}
Method Summary
void
destroy()
Frees the resources allocated by this window.
void
resetBounds()
Deletes the window's currently stored bounds.
void
setInitialBounds(x, y, width, height)
Sets the initial window bounds.
void
setLocation(x, y)
Set the window location.
void
setSize(width, height)
Set the window size.
void
show(form)
Shows the given form(form name, form object or JSForm) in this window.
void
showTextToolbar(showTextToolbar)
Sets whether or not this window should have a text tool bar.
void
toBack()
Shows this window behind other windows, if possible.
void
toFront()
Bring this window in front of other windows, if possible.
{column:width=100%|padding=0px}{column}
Constants Details
Sample
// show a dialog that self-determines bounds the first time it it open, then remembers last bounds for future show operations var win = application.createWindow("myName", JSWindow.DIALOG); win.setInitialBounds(JSWindow.DEFAULT, JSWindow.DEFAULT, JSWindow.DEFAULT, JSWindow.DEFAULT); // will be shown initially centred and with preferred size forms.myForm.show(win);
Sample
// create a non-modal dialog on top of current active form's window and show a form inside it var myWindow = application.createWindow("myName", JSWindow.DIALOG); myWindow.show(forms.myForm);
Sample
// create and show a window, with specified title, full screen var win = application.createWindow("windowName", JSWindow.WINDOW); win.setInitialBounds(JSWindow.FULL_SCREEN, JSWindow.FULL_SCREEN, JSWindow.FULL_SCREEN, JSWindow.FULL_SCREEN); win.setTitle("This is a window"); controller.show(win);
Sample
// create a modal dialog on top of current active form's window and show a form inside it var myWindow = application.createWindow("myName", JSWindow.MODAL_DIALOG); myWindow.show(forms.myForm);
Sample
// create a window and show a form inside it var myWindow = application.createWindow("myName", JSWindow.WINDOW); myWindow.show(forms.myForm);
{column:width=100%|padding=0px}{column}
Property Details
Sample
var formName = application.getWindow('test').controller.getName();
Sample
var someWindow = application.getWindow("someWindowName"); if (someWindow.isVisible() == false) { controller.show(someWindow); someWindow.resizable = false; }
Sample
var win1 = application.createWindow("Window 1", JSWindow.DIALOG, null); win1.setInitialBounds(200, 200, 450, 350); win1.resizable = false; win1.storeBounds = true; win1.title = "Window 1"; controller.show(win1);
Sample
var win1 = application.createWindow("Window 1", JSWindow.WINDOW, null); win1.setInitialBounds(200, 200, 450, 350); win1.title = "Window 1"; controller.show(win1);
Sample
var someWindow = application.createWindow("someWindowName", JSWindow.WINDOW, null); someWindow.setInitialBounds(200, 200, 450, 350); controller.show(someWindow); var name = "Name: " + someWindow.getName() + "\n" var parent = "Parent: " + (someWindow.getParent() == null ? "none" : someWindow.getParent()) + "\n" var type = "TypeNumber: " + someWindow.getType() + "\n" var height = "Height: " + someWindow.getHeight() + "\n" var width = "Width: " + someWindow.getWidth() + "\n" var undecorated = "Undecorated: " + someWindow.isUndecorated() + "\n" var locationX = "Location-X-coordinate: " + someWindow.getX() + "\n" var locationY = "Location-Y-coordinate: " + someWindow.getY() + "\n" var info = name + parent + type + height + width + locationX + locationY + undecorated + "\n" var closeMsg = "Press 'Ok' to close this dialog." var infoDialog = plugins.dialogs.showInfoDialog("Window Info", info + closeMsg, "Ok"); if (infoDialog == "Ok") someWindow.close()
{column:width=100%|padding=0px}{column}
Method Details
void
destroy
()
Returns
void
Sample
var getWindow = application.getWindow("someWindowName"); getWindow.destroy(); getWindow = application.getWindow("someWindowName"); if (getWindow == null) { application.output("Window has been destroyed"); } else { application.output("Window could not be destroyed"); }
getHeight
()
Sample
var someWindow = application.createWindow("someWindowName", JSWindow.WINDOW, null); someWindow.setInitialBounds(200, 200, 450, 350); controller.show(someWindow); var name = "Name: " + someWindow.getName() + "\n" var parent = "Parent: " + (someWindow.getParent() == null ? "none" : someWindow.getParent()) + "\n" var type = "TypeNumber: " + someWindow.getType() + "\n" var height = "Height: " + someWindow.getHeight() + "\n" var width = "Width: " + someWindow.getWidth() + "\n" var undecorated = "Undecorated: " + someWindow.isUndecorated() + "\n" var locationX = "Location-X-coordinate: " + someWindow.getX() + "\n" var locationY = "Location-Y-coordinate: " + someWindow.getY() + "\n" var info = name + parent + type + height + width + locationX + locationY + undecorated + "\n" var closeMsg = "Press 'Ok' to close this dialog." var infoDialog = plugins.dialogs.showInfoDialog("Window Info", info + closeMsg, "Ok"); if (infoDialog == "Ok") someWindow.close()
getName
()
Sample
var someWindow = application.createWindow("someWindowName", JSWindow.WINDOW, null); someWindow.setInitialBounds(200, 200, 450, 350); controller.show(someWindow); var name = "Name: " + someWindow.getName() + "\n" var parent = "Parent: " + (someWindow.getParent() == null ? "none" : someWindow.getParent()) + "\n" var type = "TypeNumber: " + someWindow.getType() + "\n" var height = "Height: " + someWindow.getHeight() + "\n" var width = "Width: " + someWindow.getWidth() + "\n" var undecorated = "Undecorated: " + someWindow.isUndecorated() + "\n" var locationX = "Location-X-coordinate: " + someWindow.getX() + "\n" var locationY = "Location-Y-coordinate: " + someWindow.getY() + "\n" var info = name + parent + type + height + width + locationX + locationY + undecorated + "\n" var closeMsg = "Press 'Ok' to close this dialog." var infoDialog = plugins.dialogs.showInfoDialog("Window Info", info + closeMsg, "Ok"); if (infoDialog == "Ok") someWindow.close()
getParent
()
Returns
JSWindow – the parent JSWindow, if available. If there is no parent JSWindow, it will return null.
Sample
var someWindow = application.createWindow("someWindowName", JSWindow.WINDOW, null); someWindow.setInitialBounds(200, 200, 450, 350); controller.show(someWindow); var name = "Name: " + someWindow.getName() + "\n" var parent = "Parent: " + (someWindow.getParent() == null ? "none" : someWindow.getParent()) + "\n" var type = "TypeNumber: " + someWindow.getType() + "\n" var height = "Height: " + someWindow.getHeight() + "\n" var width = "Width: " + someWindow.getWidth() + "\n" var undecorated = "Undecorated: " + someWindow.isUndecorated() + "\n" var locationX = "Location-X-coordinate: " + someWindow.getX() + "\n" var locationY = "Location-Y-coordinate: " + someWindow.getY() + "\n" var info = name + parent + type + height + width + locationX + locationY + undecorated + "\n" var closeMsg = "Press 'Ok' to close this dialog." var infoDialog = plugins.dialogs.showInfoDialog("Window Info", info + closeMsg, "Ok"); if (infoDialog == "Ok") someWindow.close()
getType
()
Returns
Number – the window type. Can be one of JSWindow.DIALOG, JSWindow.MODAL_DIALOG, JSWindow.WINDOW.
Sample
var someWindow = application.createWindow("someWindowName", JSWindow.WINDOW, null); someWindow.setInitialBounds(200, 200, 450, 350); controller.show(someWindow); var name = "Name: " + someWindow.getName() + "\n" var parent = "Parent: " + (someWindow.getParent() == null ? "none" : someWindow.getParent()) + "\n" var type = "TypeNumber: " + someWindow.getType() + "\n" var height = "Height: " + someWindow.getHeight() + "\n" var width = "Width: " + someWindow.getWidth() + "\n" var undecorated = "Undecorated: " + someWindow.isUndecorated() + "\n" var locationX = "Location-X-coordinate: " + someWindow.getX() + "\n" var locationY = "Location-Y-coordinate: " + someWindow.getY() + "\n" var info = name + parent + type + height + width + locationX + locationY + undecorated + "\n" var closeMsg = "Press 'Ok' to close this dialog." var infoDialog = plugins.dialogs.showInfoDialog("Window Info", info + closeMsg, "Ok"); if (infoDialog == "Ok") someWindow.close()
getWidth
()
Sample
var someWindow = application.createWindow("someWindowName", JSWindow.WINDOW, null); someWindow.setInitialBounds(200, 200, 450, 350); controller.show(someWindow); var name = "Name: " + someWindow.getName() + "\n" var parent = "Parent: " + (someWindow.getParent() == null ? "none" : someWindow.getParent()) + "\n" var type = "TypeNumber: " + someWindow.getType() + "\n" var height = "Height: " + someWindow.getHeight() + "\n" var width = "Width: " + someWindow.getWidth() + "\n" var undecorated = "Undecorated: " + someWindow.isUndecorated() + "\n" var locationX = "Location-X-coordinate: " + someWindow.getX() + "\n" var locationY = "Location-Y-coordinate: " + someWindow.getY() + "\n" var info = name + parent + type + height + width + locationX + locationY + undecorated + "\n" var closeMsg = "Press 'Ok' to close this dialog." var infoDialog = plugins.dialogs.showInfoDialog("Window Info", info + closeMsg, "Ok"); if (infoDialog == "Ok") someWindow.close()
Sample
var someWindow = application.createWindow("someWindowName", JSWindow.WINDOW, null); someWindow.setInitialBounds(200, 200, 450, 350); controller.show(someWindow); var name = "Name: " + someWindow.getName() + "\n" var parent = "Parent: " + (someWindow.getParent() == null ? "none" : someWindow.getParent()) + "\n" var type = "TypeNumber: " + someWindow.getType() + "\n" var height = "Height: " + someWindow.getHeight() + "\n" var width = "Width: " + someWindow.getWidth() + "\n" var undecorated = "Undecorated: " + someWindow.isUndecorated() + "\n" var locationX = "Location-X-coordinate: " + someWindow.getX() + "\n" var locationY = "Location-Y-coordinate: " + someWindow.getY() + "\n" var info = name + parent + type + height + width + locationX + locationY + undecorated + "\n" var closeMsg = "Press 'Ok' to close this dialog." var infoDialog = plugins.dialogs.showInfoDialog("Window Info", info + closeMsg, "Ok"); if (infoDialog == "Ok") someWindow.close()
Sample
var someWindow = application.createWindow("someWindowName", JSWindow.WINDOW, null); someWindow.setInitialBounds(200, 200, 450, 350); controller.show(someWindow); var name = "Name: " + someWindow.getName() + "\n" var parent = "Parent: " + (someWindow.getParent() == null ? "none" : someWindow.getParent()) + "\n" var type = "TypeNumber: " + someWindow.getType() + "\n" var height = "Height: " + someWindow.getHeight() + "\n" var width = "Width: " + someWindow.getWidth() + "\n" var undecorated = "Undecorated: " + someWindow.isUndecorated() + "\n" var locationX = "Location-X-coordinate: " + someWindow.getX() + "\n" var locationY = "Location-Y-coordinate: " + someWindow.getY() + "\n" var info = name + parent + type + height + width + locationX + locationY + undecorated + "\n" var closeMsg = "Press 'Ok' to close this dialog." var infoDialog = plugins.dialogs.showInfoDialog("Window Info", info + closeMsg, "Ok"); if (infoDialog == "Ok") someWindow.close()
Returns
Boolean – Boolean true if the window was successfully closed and false otherwise.
Sample
//creates and shows a window for 3 seconds before closing it var win = application.createWindow("someWindowName", JSWindow.WINDOW, null); win.setInitialBounds(200, 200, 450, 350); controller.show(win); application.sleep(3000); win.hide();
isVisible
()
Returns
Boolean – true if the window is visible, false otherwise.
Sample
var someWindow = application.getWindow("someWindowName"); if (someWindow.isVisible() == false) { controller.show(someWindow); someWindow.resizable = false; }
void
resetBounds
()
Returns
void
Sample
var win1 = application.createWindow("Window 1", JSWindow.DIALOG, null); win1.title = "Window 1"; win1.setInitialBounds(200, 200, 400, 600); win1.storeBounds = true; if (newSolutionVersion) win1.resetBounds(); win1.show(forms.myform);
void
setInitialBounds
(x, y, width, height)
Parameters
{Number} x – the initial x coordinate of the window. Can be JSWindow.DEFAULT, JSWindow.FULL_SCREEN.
{Number} y – the initial y coordinate of the window. Can be JSWindow.DEFAULT, JSWindow.FULL_SCREEN.
{Number} width – the initial width of the window. Can be JSWindow.DEFAULT, JSWindow.FULL_SCREEN.
{Number} height – the initial height of the window. Can be JSWindow.DEFAULT, JSWindow.FULL_SCREEN.
Returns
void
Sample
var win = application.createWindow("myName", JSWindow.DIALOG); win.setInitialBounds(20, 10, 300, 200); forms.myForm.show(win);
void
setLocation
(x, y)
Returns
void
Sample
var window = application.createWindow('test',JSWindow.DIALOG); window.show(forms.child1); window.setLocation(0,0); window.setSize(400,600);
void
setSize
(width, height)
Returns
void
Sample
var window = application.createWindow('test',JSWindow.DIALOG); window.show(forms.child1); window.setLocation(0,0); window.setSize(400,600);
void
show
(form)
Parameters
{Object} form – the form that will be shown inside this window. It can be a form name or a form object (actual form or JSForm).
Returns
void
Sample
win.show(forms.myForm); // win.show("myForm");
void
showTextToolbar
(showTextToolbar)
Parameters
{Boolean} showTextToolbar – true if you want a text tool bar to be added to this window, false otherwise.
Returns
void
Sample
var win1 = application.createWindow("Window 1", JSWindow.WINDOW, null); win1.setInitialBounds(200, 200, 450, 350); win1.setTitle("Window 1"); win1.showTextToolbar(false); controller.show(win1); var win2 = application.createWindow("Window 2", JSWindow.WINDOW, null); win2.setInitialBounds(500, 500, 450, 350); win2.setTitle("Window 2"); win2.showTextToolbar(false); controller.show(win2); var win3 = application.createWindow("Window 3", JSWindow.WINDOW, null); win3.setInitialBounds(650, 700, 450, 350); win3.setTitle("Window 3"); win3.showTextToolbar(true); controller.show(win3); application.sleep(2000); win3.toBack(); application.sleep(2000); win1.toFront();
void
toBack
()
Returns
void
Sample
var win1 = application.createWindow("Window 1", JSWindow.WINDOW, null); win1.setInitialBounds(200, 200, 450, 350); win1.setTitle("Window 1"); win1.showTextToolbar(false); controller.show(win1); var win2 = application.createWindow("Window 2", JSWindow.WINDOW, null); win2.setInitialBounds(500, 500, 450, 350); win2.setTitle("Window 2"); win2.showTextToolbar(false); controller.show(win2); var win3 = application.createWindow("Window 3", JSWindow.WINDOW, null); win3.setInitialBounds(650, 700, 450, 350); win3.setTitle("Window 3"); win3.showTextToolbar(true); controller.show(win3); application.sleep(2000); win3.toBack(); application.sleep(2000); win1.toFront();
void
toFront
()
Returns
void
Sample
var win1 = application.createWindow("Window 1", JSWindow.WINDOW, null); win1.setInitialBounds(200, 200, 450, 350); win1.setTitle("Window 1"); win1.showTextToolbar(false); controller.show(win1); var win2 = application.createWindow("Window 2", JSWindow.WINDOW, null); win2.setInitialBounds(500, 500, 450, 350); win2.setTitle("Window 2"); win2.showTextToolbar(false); controller.show(win2); var win3 = application.createWindow("Window 3", JSWindow.WINDOW, null); win3.setInitialBounds(650, 700, 450, 350); win3.setTitle("Window 3"); win3.showTextToolbar(true); controller.show(win3); application.sleep(2000); win3.toBack(); application.sleep(2000); win1.toFront();