JSWindow

Overview

The JSWindow object provides functionality for managing and scripting windows and dialogs in a solution. It supports creating modal and non-modal dialogs, customizing their appearance and behavior, and displaying forms within them. Windows can have properties like opacity, size, location, resizable state, and titles, and they can also maintain their state across sessions using bounds storage. ## Functionality

JSWindow provides constants such as DEFAULT for auto-determined bounds, DIALOG for non-modal windows, and MODAL_DIALOG for modal dialogs. These constants simplify the creation and configuration of different window types.

Properties allow fine control over the window’s characteristics. For example, opacity and transparent control visual appearance, while resizable, undecorated, and storeBounds affect interactivity and persistence. Methods enable developers to show or hide windows, manipulate their size and position dynamically, and manage associated forms.

Windows support advanced features like setting CSS classes for styling, managing design-time properties, and attaching handlers for specific events. These features enhance customization and integration within applications.

Refer to the Creating window documentation for additional details.

Constants Summarized

Type	Name	Summary
Number	DEFAULT	Value used for x, y, width, height of initial bounds when you want the window to auto-determine bounds when shown for the first time.
Number	DIALOG	Window type constant that identifies a non-modal dialog type.
Number	FULL_SCREEN	Value that can be used for bounds in order to specify that a dialog/window should completely fill the screen.
Number	MODAL_DIALOG	Window type constant that identifies a modal dialog type.

Properties Summarized

Type	Name	Summary
controller	controller	Get the current controller from the window/dialog.
Number	opacity	Gets/Sets the opacity property.
Boolean	resizable	Gets/Sets whether or not this window can be resized by the user (default true).
Boolean	storeBounds	Tells whether or not the bounds of this window should be stored/persisted (default false).
String	title	Gets/Sets the title text.
Boolean	transparent	Gets/Sets the transparency property.
Boolean	undecorated	Gets/Sets the undecorated property.

Methods Summarized

Type	Name	Summary
Boolean	destroy()	Frees the resources allocated by this window.
Number	getHeight()	Returns the height.
String	getName()	Returns the window name.
JSWindow	getParent()	Returns the parent JSWindow, if available.
Number	getType()	Returns the window type.
Number	getWidth()	Returns the width.
Number	getX()	Returns the x coordinate.
Number	getY()	Returns the y coordinate.
Boolean	hide()	Hides the window.
Boolean	isVisible()	Returns true if the window is visible, false otherwise.
void	resetBounds()	Deletes the window's currently stored bounds.
void	setCSSClass(cssClassName)	Sets the dialog CSS class, can not be used to alter it when already showing, this should be set before the dialog is used.
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.

Constants Detailed

DEFAULT

Value used for x, y, width, height of initial bounds when you want the window to auto-determine bounds when shown for the first time.

Type Number

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);

DIALOG

Window type constant that identifies a non-modal dialog type. Non-modal dialogs will allow the user to interact with parent windows, but are less independent then windows with WINDOW type. Dialogs will stay on top of parent windows and are less accessible through the OS window manager. In web-client dialogs will not open in a separate browser window.

Type Number

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);

FULL_SCREEN

Value that can be used for bounds in order to specify that a dialog/window should completely fill the screen.

Type Number

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);

MODAL_DIALOG

Window type constant that identifies a modal dialog type. Modal dialogs will not allow the user to interact with the parent window(s) until closed. Dialogs will stay on top of parent windows and are less accessible through the OS window manager. In web-client dialogs will not open in a separate browser window. NOTE: no code is executed in Smart Client after a modal dialog is shown (the show operation blocks) until this dialog closes.

Type Number

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);

Properties Detailed

controller

Get the current controller from the window/dialog.

Type controller

Sample

var formName = application.getWindow('test').controller.getName();

opacity

Gets/Sets the opacity property. By default will have value 1 (completely opaque), and can be assigned to values between 0 and 1. If set then window will also be undecorated. This should be set before the dialog/window is shown, otherwise it has no effect.

Type Number the opacity of this 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 opacity = "Opacity: " + someWindow.opacity + "\n"
var transparent = "Transparent: " + someWindow.transparent + "\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()

resizable

Gets/Sets whether or not this window can be resized by the user (default true).

Type Boolean

Sample

var someWindow = application.getWindow("someWindowName");
if (someWindow.isVisible() == false) {
	controller.show(someWindow);
	someWindow.resizable = false;
}

storeBounds

Tells whether or not the bounds of this window should be stored/persisted (default false). If true, the window's bounds will be stored when the window is closed. Stored bounds will be used when the window is shown again instead of initialBounds. For non resizable windows, only location is stored/persisted.

Type Boolean

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);

title

Gets/Sets the title text.

Type String

Sample

var win1 = application.createWindow("Window 1", JSWindow.WINDOW, null);
win1.setInitialBounds(200, 200, 450, 350);
win1.title = "Window 1";
controller.show(win1);

transparent

Gets/Sets the transparency property. NOTE: For smart clients, the window must be undecorated or the servoy.smartclient.allowLAFWindowDecoration property set to true

Type Boolean transparency state of the 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 opacity = "Opacity: " + someWindow.opacity + "\n"
var transparent = "Transparent: " + someWindow.transparent + "\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()

undecorated

Gets/Sets the undecorated property. If set then this window will not have any decoration and can't be moved/resized or closed. This should be set before dialog/window is shown, otherwise has no effect.

Type Boolean if this window will be undecorated

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 opacity = "Opacity: " + someWindow.opacity + "\n"
var transparent = "Transparent: " + someWindow.transparent + "\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()

Methods Detailed

destroy()

Frees the resources allocated by this window. If window is visible, it will close it first by calling hide() and if that fails because it couldn't be hidden it will return false. The window will no longer be available with application.getWindow('windowName') and will no longer be usable.

The main application window cannot be destroyed.

Returns: Boolean

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()

Returns the height.

Returns: Number the height.

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 opacity = "Opacity: " + someWindow.opacity + "\n"
var transparent = "Transparent: " + someWindow.transparent + "\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()

Returns the window name. It will be null in case of main application frame.

Returns: String the window name.

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 =