Page History

...

style	display:none

...

id	description

...

padding	0px
width	80px

...

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Constants Summary

...

Table Cell (td)
Number

...

Table Cell (td)
Number

...

Cache

index	true
refresh	100d
showRefresh	true
id	doc
title	Refresh page
showDate	true
retry	Enable

servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClientsWordListNGClient

servoy sSummary12%30%58%height: 30px;3Constants SummaryValue used for x, y, width, height of initial bounds when you want the window to auto-determine bounds when shown for the first time.

...

Table Cell (td)
Number

...

Window type constant that identifies a non-modal dialog type.

...

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

...

Table Cell (td)
Number

...

Table Cell (td)
Number

...

c Window type constant that identifies a modal dialog type.

...

Window type constant that identifies a window type.

...

padding	0px
width	80px

...

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Property Summary

...

Table Cell (td)
controller

...

servoy sSummary

12%

30%

58%

height: 30px;

3

Property Summary

Get the current controller from the window/dialog

...

Table Cell (td)
Boolean

...

Table Cell (td)
Boolean

...

.

Gets/Sets the opacity property.

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

...

Table Cell (td)
String

...

Tells whether or not the bounds of this window should be stored/persisted (default false).

...

Table Cell (td)
Boolean

...

Gets/Sets the title text.

...

padding	0px
width	80px

...

Gets/Sets the transparency property.

Gets/Sets the undecorated property.

...

servoy sSummary

12%

30%

58%

height: 30px;

...

Table Head (th)

colspan	2

Method Summary

...

Table Cell (td)
void

...

3

Methods Summary

void

Frees the resources allocated by this window.

...

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#getHeight() Returns the height.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#getName() Returns the window name.

...

Table Cell (td)
JSWindow

...

Table Cell (td)
Number

...

Returns the height.

Returns the window name.

Returns the parent JSWindow, if available.

...

Returns the window type.

...

Table Cell (td)
Number

...

Returns the width.

...

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#getX() Returns the x coordinate.

...

Table Cell (td)
Number

...

Table Cell (td)
Boolean

...

Returns the x coordinate.

Returns the y coordinate.

...

Hides the window.

...

Table Cell (td)
Boolean

...

Returns true if the window is visible, false otherwise.

...

void

...

Deletes the window's currently stored bounds.

...

Table Cell (td)
void

...

void

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

Sets the initial window bounds.

...

void

...

Set the window location.

...

void

...

Set the window size.

...

Table Cell (td)
void

...

void

Shows the given form(form name, form object or JSForm) in this window.

...

void

...

Sets whether or not this window should have a text tool bar.

...

void

...

Shows this window behind other windows, if possible.

...

void

...

Bring this window in front of other windows, if possible.

...

constant

...

servoy sDetail

...

padding	0px
width	100%

...

Table Row (tr)

id	name

Table Cell (td)
MODAL_DIALOG

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


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

...

class	lastDetailRow

...

id	WINDOW

Table Row (tr)

id	name

Table Cell (td)
WINDOW

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Window type constant that identifies a window type. WINDOW type is the most independent type of window. It will be more accessible through the OS window
manager, it can appear both in front of and under other windows and it doesn't block user interaction for other windows. In web-client windows will
open in a separate browser window.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


// create a window and show a form inside it
var myWindow = application.createWindow("myName", JSWindow.WINDOW);
myWindow.show(forms.myForm);

...

class	lastDetailRow

...

id	property
class	servoy sDetail

...

padding	0px
width	100%

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	1

Property Details

...

id	controller

Table Row (tr)

id	name

Table Cell (td)
controller

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Get the current controller from the window/dialog.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

controller

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


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

...

class	lastDetailRow

...

id	resizable

Table Row (tr)

id	name

Table Cell (td)
resizable

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


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

...

class	lastDetailRow

...

id	storeBounds

Table Row (tr)

id	name

Table Cell (td)
storeBounds

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


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

...

class	lastDetailRow

...

id	title

Table Row (tr)

id	name

Table Cell (td)
title

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Gets/Sets the title text.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


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

...

class	lastDetailRow

...

id	undecorated

Table Row (tr)

id	name

Table Cell (td)
undecorated

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Gets/Sets the undecorated property.
If set then this window will not have any decoration and can't be moved/resized or closed.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean – if this window will be undecorated

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


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

...

class	lastDetailRow

...

HTML Table

id	function
class	servoy sDetail

Colgroup Tag

Column

padding	0px
width	100%

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	1

Method Details

Table Body (tbody)

id	destroy

Table Row (tr)

id	name

Table Cell (td)
destroy

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

destroy

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Frees the resources allocated by this window. If window is visible, it will close it first.
The window will no longer be available with application.getWindow('windowName') and will no longer be usable.

The main application window cannot be destroyed.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


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

Table Row (tr)

class	lastDetailRow

Table Cell (td) Table Body (tbody)

id	getHeight

Table Row (tr)

id	name

Table Cell (td)
getHeight

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Number

Span

style	font-weight: bold;

getHeight

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns the height.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number – the height.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


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

Table Row (tr)

class	lastDetailRow

Table Cell (td) Table Body (tbody)

id	getName

Table Row (tr)

id	name

Table Cell (td)
getName

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

getName

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String – the window name.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


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

Table Row (tr)

class	lastDetailRow

Table Cell (td) Table Body (tbody)

id	getParent

Table Row (tr)

id	name

Table Cell (td)
getParent

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSWindow

Span

style	font-weight: bold;

getParent

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns the parent JSWindow, if available.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSWindow – the parent JSWindow, if available. If there is no parent JSWindow, it will return null.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


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

Table Row (tr)

class	lastDetailRow

Table Cell (td) Table Body (tbody)

id	getType

Table Row (tr)

id	name

Table Cell (td)
getType

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Number

Span

style	font-weight: bold;

getType

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns the window type.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number – the window type. Can be one of JSWindow.DIALOG, JSWindow.MODAL_DIALOG, JSWindow.WINDOW.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


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

Table Row (tr)

class	lastDetailRow

Table Cell (td) Table Body (tbody)

id	getWidth

Table Row (tr)

id	name

Table Cell (td)
getWidth

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Number

Span

style	font-weight: bold;

getWidth

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns the width.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number – the width.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


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

Table Row (tr)

class	lastDetailRow

Table Cell (td) Table Body (tbody)

id	getX

Table Row (tr)

id	name

Table Cell (td)
getX

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Number

Span

style	font-weight: bold;

getX

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns the x coordinate.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number – the x coordinate.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


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

Table Row (tr)

class	lastDetailRow

Table Cell (td) Table Body (tbody)

id	getY

Table Row (tr)

id	name

Table Cell (td)
getY

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Number

Span

style	font-weight: bold;

getY

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns the y coordinate.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number – the y coordinate.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


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

Table Row (tr)

class	lastDetailRow

Table Cell (td) Table Body (tbody)

id	hide

Table Row (tr)

id	name

Table Cell (td)
hide

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

hide

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Hides the window. It can be shown again using window.show(), controller.show() or controller.showRecords().
The main application window cannot be hidden.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean – Boolean true if the window was successfully closed and false otherwise.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


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

Table Row (tr)

class	lastDetailRow

Table Cell (td) Table Body (tbody)

id	isVisible

Table Row (tr)

id	name

Table Cell (td)
isVisible

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

isVisible

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns true if the window is visible, false otherwise.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean – true if the window is visible, false otherwise.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


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

Table Row (tr)

class	lastDetailRow

Table Cell (td) Table Body (tbody)

id	resetBounds

Table Row (tr)

id	name

Table Cell (td)
resetBounds

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

resetBounds

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Deletes the window's currently stored bounds. It will only affect the next show of the window.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


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

Table Row (tr)

class	lastDetailRow

Table Cell (td) Table Body (tbody)

id	setInitialBounds-Number_Number_Number_Number

Table Row (tr)

id	name

Table Cell (td)
setInitialBounds

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

setInitialBounds

Span
(x, y, width, height)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Sets the initial window bounds.
The initial bounds are only used the first time this window is shown (what first show means depends on storeBounds property).

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{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.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


var win = application.createWindow("myName", JSWindow.DIALOG);
win.setInitialBounds(20, 10, 300, 200);
forms.myForm.show(win);

Table Row (tr)

class	lastDetailRow

Table Cell (td) Table Body (tbody)

id	setLocation-Number_Number

Table Row (tr)

id	name

Table Cell (td)
setLocation

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

setLocation

Span
(x, y)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Set the window location.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} x – x coordinate.
{Number} y – y coordinate.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


var window = application.createWindow('test',JSWindow.DIALOG);
window.show(forms.child1);
window.setLocation(0,0);
window.setSize(400,600);

Table Row (tr)

class	lastDetailRow

Table Cell (td) Table Body (tbody)

id	setSize-Number_Number

Table Row (tr)

id	name

Table Cell (td)
setSize

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

setSize

Span
(width, height)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Set the window size.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} width – the width.
{Number} height – the height.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


var window = application.createWindow('test',JSWindow.DIALOG);
window.show(forms.child1);
window.setLocation(0,0);
window.setSize(400,600);

Table Row (tr)

class	lastDetailRow

Table Cell (td) Table Body (tbody)

id	show-Object

Table Row (tr)

id	name

Table Cell (td)
show

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

show

Span
(form)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Shows the given form(form name, form object or JSForm) in this window.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{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).

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


win.show(forms.myForm);
// win.show("myForm");

Table Row (tr)

class	lastDetailRow

Table Cell (td) Table Body (tbody)

id	showTextToolbar-Boolean

Table Row (tr)

id	name

Table Cell (td)
showTextToolbar

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

showTextToolbar

Span
(showTextToolbar)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Sets whether or not this window should have a text tool bar. Has no effect on web client or smart client main application frame.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Boolean} showTextToolbar – true if you want a text tool bar to be added to this window, false otherwise.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


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

Table Row (tr)

class	lastDetailRow

Table Cell (td) Table Body (tbody)

id	toBack

Table Row (tr)

id	name

Table Cell (td)
toBack

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

toBack

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Shows this window behind other windows, if possible.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


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

Table Row (tr)

class	lastDetailRow

Table Cell (td) Table Body (tbody)

id	toFront

Table Row (tr)

id	name

Table Cell (td)
toFront

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

toFront

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Bring this window in front of other windows, if possible.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


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

Table Row (tr)

class	lastDetailRow

td

2100%

height:30px

...

Table Head (th)

colspan	1

Constants Details

...

id	DEFAULT

Table Row (tr)

id	name

Table Cell (td)
DEFAULT

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


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

...

class	lastDetailRow

...

id	DIALOG

Table Row (tr)

id	name

Table Cell (td)
DIALOG

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


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

...

class	lastDetailRow

...

id	FULL_SCREEN

Table Row (tr)

id	name

Table Cell (td)
FULL_SCREEN

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


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

...

class	lastDetailRow

...

id	MODAL_DIALOG

2

Constants Details

DEFAULT

name

DEFAULT

des

sIndent

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.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

DIALOG

name

DIALOG

des

sIndent

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.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

FULL_SCREEN

name

FULL_SCREEN

des

sIndent

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

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

MODAL_DIALOG

name

MODAL_DIALOG

des

sIndent

c
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.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

WINDOW

name

WINDOW

des

sIndent

Window type constant that identifies a window type. WINDOW type is the most independent type of window. It will be more accessible through the OS window
manager, it can appear both in front of and under other windows and it doesn't block user interaction for other windows. In web-client windows will
open in a separate browser window.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

propertyservoy sDetail2100%height:30px2Property Detailscontrollername

controller

des

sIndent

Get the current controller from the window/dialog.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

opacity

name

opacity

des

sIndent

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.

ret

Returns

sIndent

the opacity of this window

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

resizable

name

resizable

des

sIndent

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

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

storeBounds

name

storeBounds

des

sIndent

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.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

title

name

title

des

sIndent

Gets/Sets the title text.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

transparent

name

transparent

des

sIndent

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

ret

Returns

sIndent

transparency state of the window

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

undecorated

name

undecorated

des

sIndent

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.

ret

Returns

sIndent

if this window will be undecorated

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

functionservoy sDetail2100%height:30px2Methods Detailsdestroyname

destroy()

des

sIndent

Frees the resources allocated by this window. If window is visible, it will close it first.
The window will no longer be available with application.getWindow('windowName') and will no longer be usable.

The main application window cannot be destroyed.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getHeight

name

getHeight()

des

sIndent

Returns the height.

ret

Returns

sIndent

the height.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getName

name

getName()

des

sIndent

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

ret

Returns

sIndent

the window name.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getParent

name

getParent()

des

sIndent

Returns the parent JSWindow, if available.

ret

Returns

sIndent

the parent JSWindow, if available. If there is no parent JSWindow, it will return null.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getType

name

getType()

des

sIndent

Returns the window type.

ret

Returns

sIndent

the window type. Can be one of JSWindow.DIALOG, JSWindow.MODAL_DIALOG, JSWindow.WINDOW.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getWidth

name

getWidth()

des

sIndent

Returns the width.

ret

Returns

sIndent

the width.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getX

name

getX()

des

sIndent

Returns the x coordinate.

ret

Returns

sIndent

the x coordinate.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getY

name

getY()

des

sIndent

Returns the y coordinate.

ret

Returns

sIndent

the y coordinate.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

hide

name

hide()

des

sIndent

Hides the window. It can be shown again using window.show(), controller.show() or controller.showRecords().
The main application window cannot be hidden.

ret

Returns

sIndent

Boolean true if the window was successfully closed and false otherwise.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

isVisible

name

isVisible()

des

sIndent

Returns true if the window is visible, false otherwise.

ret

Returns

sIndent

true if the window is visible, false otherwise.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

resetBounds

name

resetBounds()

des

sIndent

Deletes the window's currently stored bounds. It will only affect the next show of the window.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

setCSSClass

name

setCSSClass(cssClassName)

des

sIndent

Sets the dialog CSS class, can not be used to alter it when already showing, this should be set before the dialog is used.
See sample code for examples of CSS classes for display customizations

prs

Parameters

sIndent

cssClassName

CSS class name

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

setInitialBounds

name

setInitialBounds(x, y, width, height)

des

sIndent

Sets the initial window bounds.
The initial bounds are only used the first time this window is shown (what first show means depends on storeBounds property).

prs

Parameters

sIndent

x

the initial x coordinate of the window. Can be JSWindow.DEFAULT, JSWindow.FULL_SCREEN.

y

the initial y coordinate of the window. Can be JSWindow.DEFAULT, JSWindow.FULL_SCREEN.

width

the initial width of the window. Can be JSWindow.DEFAULT, JSWindow.FULL_SCREEN.

height

the initial height of the window. Can be JSWindow.DEFAULT, JSWindow.FULL_SCREEN.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

setLocation

name

setLocation(x, y)

des

sIndent

Set the window location.
If the coordinates are not valid they might be corrected. (for example out of screen locations)

prs

Parameters

sIndent

x

x coordinate.

y

y coordinate.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

setSize

name

setSize(width, height)

des

sIndent

Set the window size.

prs

Parameters

sIndent

width

the width.

height

the height.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

show

name

show(form)

des

sIndent

Shows the given form(form name, form object or JSForm) in this window.

prs

Parameters

sIndent

form

the form that will be shown inside this window. It can be a form name or a form object (actual form or JSForm).

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

showTextToolbar

name

showTextToolbar(showTextToolbar)

des

sIndent

Sets whether or not this window should have a text tool bar. Has no effect on web client or smart client main application frame.

prs

Parameters

sIndent

showTextToolbar

true if you want a text tool bar to be added to this window, false otherwise.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

toBack

name

toBack()

des

sIndent

Shows this window behind other windows, if possible.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

toFront

name

toFront()

des

sIndent

Bring this window in front of other windows, if possible.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

Child pages

Page History

Versions Compared

Old Version 11

New Version Current

Key

MODAL_DIALOG

WINDOW

controller

resizable

storeBounds

title

undecorated

destroy

getHeight

getName

getParent

getType

getWidth

getX

getY

hide

isVisible

resetBounds

setInitialBounds

setLocation

setSize

show

showTextToolbar

toBack

toFront

DEFAULT

DIALOG

FULL_SCREEN

DEFAULT

DIALOG

FULL_SCREEN

MODAL_DIALOG

WINDOW

controller

opacity

resizable

storeBounds

title

transparent

undecorated

destroy()

getHeight()

getName()

getParent()

getType()

getWidth()

getX()

getY()

hide()

isVisible()

resetBounds()

setCSSClass(cssClassName)

setInitialBounds(x, y, width, height)

setLocation(x, y)

setSize(width, height)

show(form)

showTextToolbar(showTextToolbar)

toBack()

toFront()