Page History

Hidden

DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY, UNLESS YOU KNOW WHAT YOU'RE DOING.
		THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO EXTRACT CHANGES FROM THE PAGE AND MERGE THEM BACK INTO SERVOY SOURCE

HTML Table

class	servoy sReturnTypes

Table Row (tr)

style	height: 30px;

Table Head (th)
Return Types

Table Row (tr)

Table Cell (td)

Span

class	sWordList

CheckBox

Span

class	sWordList

Menu

Span

class	sWordList

MenuBar

Span

class	sWordList

MenuItem

Span

class	sWordList

Popup

Span

class	sWordList

RadioButton

Span

class	sWordList

ToolBar

HTML Table

class	servoy sSummary

Colgroup Tag

Column

padding	0px
width	80px

Column

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Method Summary

Table Body (tbody)

Table Row (tr)

Table Cell (td)
ToolBar

Table Cell (td)
#addToolBar(name) Add a toolbar.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
ToolBar

Table Cell (td)
#addToolBar(name, row) Add a toolbar.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
ToolBar

Table Cell (td)
#addToolBar(name, displayname) Add a toolbar.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
ToolBar

Table Cell (td)
#addToolBar(name, displayname, row) Add a toolbar.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
#cancelFormPopup() Close the current form popup panel without assigning a value to the configured data provider.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
#closeFormPopup(retval) Close the current form popup panel and assign the value to the configured data provider.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Popup

Table Cell (td)
#createPopupMenu() Creates a new popup menu that can be populated with items and displayed.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#createShortcut(shortcut, methodName) Create a shortcut.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#createShortcut(shortcut, methodName, arguments) Create a shortcut.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#createShortcut(shortcut, methodName, contextFilter) Create a shortcut.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#createShortcut(shortcut, methodName, contextFilter, arguments) Create a shortcut.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#createShortcut(shortcut, method) Create a shortcut.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#createShortcut(shortcut, method, arguments) Create a shortcut.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#createShortcut(shortcut, method, contextFilter) Create a shortcut.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#createShortcut(shortcut, method, contextFilter, arguments) Create a shortcut.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
MenuBar

Table Cell (td)
#getMenuBar() Get the menubar of the main window, or of a named window.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
MenuBar

Table Cell (td)
#getMenuBar(windowName) Get the menubar of the main window, or of a named window.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
ToolBar

Table Cell (td)
#getToolBar(name) Get the toolbar from the toolbar panel by name.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String[]

Table Cell (td)
#getToolbarNames() Get all toolbar names from the toolbar panel.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
#maximize() Maximize the current window or the window with the specified name (Smart client only).

Table Body (tbody)

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
#maximize(windowName) Maximize the current window or the window with the specified name (Smart client only).

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#removeShortcut(shortcut) Remove a shortcut.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#removeShortcut(shortcut, contextFilter) Remove a shortcut.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
#removeToolBar(name) Remove the toolbar from the toolbar panel.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
#setFullScreen(full) Bring the window into/out of fullsceen mode.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
#setStatusBarVisible(visible) Show or hide the statusbar.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
#setToolBarAreaVisible(visible) Show or hide the toolbar area.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
#showFormPopup(elementToShowRelatedTo, form, scope, dataproviderID) Show a form as popup panel, where the closeFormPopup can pass return a value to a dataprovider in the specified scope.

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	addToolBar-String
class	node

Table Row (tr)

id	name

Table Cell (td)
addToolBar

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

ToolBar

Span

style	float: left; font-weight: bold;
id	iets

addToolBar

Span

style	float: left;
id	iets

(name)

Table Row (tr)

id	des

Table Cell (td)
Add a toolbar.

Table Row (tr)

id	prs

Table Cell (td)
Parameters {String} name

Table Row (tr)

id	ret

Table Cell (td)
Returns ToolBar

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// Note: method addToolBar only works in the smart client.

// add a toolbar with only a name
var toolbar0 = plugins.window.addToolBar("toolbar_0");
toolbar0.addButton("click me 0", feedback_button);

// add a toolbar with a name and the row you want it to show at
// row number starts at 0
var toolbar1 = plugins.window.addToolBar("toolbar_1", 2);
toolbar1.addButton("click me 1", feedback_button);

// add a toolbar with a name and display name
var toolbar2 = plugins.window.addToolBar("toolbar_2", "toolbar_2_internal_name");
toolbar2.addButton("click me 2", feedback_button);

// add a toolbar with a name, display name and the row you want the
// toolbar to show at. row number starts at 0 
var toolbar3 = plugins.window.addToolBar("toolbar_3", "toolbar_3_internal_name", 3);
toolbar3.addButton("click me 3", feedback_button);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	addToolBar-String_Number
class	node

Table Row (tr)

id	name

Table Cell (td)
addToolBar

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

ToolBar

Span

style	float: left; font-weight: bold;
id	iets

addToolBar

Span

style	float: left;
id	iets

(name, row)

Table Row (tr)

id	des

Table Cell (td)
Add a toolbar.

Table Row (tr)

id	prs

Table Cell (td)
Parameters {String} name {Number} row

Table Row (tr)

id	ret

Table Cell (td)
Returns ToolBar

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// Note: method addToolBar only works in the smart client.

// add a toolbar with only a name
var toolbar0 = plugins.window.addToolBar("toolbar_0");
toolbar0.addButton("click me 0", feedback_button);

// add a toolbar with a name and the row you want it to show at
// row number starts at 0
var toolbar1 = plugins.window.addToolBar("toolbar_1", 2);
toolbar1.addButton("click me 1", feedback_button);

// add a toolbar with a name and display name
var toolbar2 = plugins.window.addToolBar("toolbar_2", "toolbar_2_internal_name");
toolbar2.addButton("click me 2", feedback_button);

// add a toolbar with a name, display name and the row you want the
// toolbar to show at. row number starts at 0 
var toolbar3 = plugins.window.addToolBar("toolbar_3", "toolbar_3_internal_name", 3);
toolbar3.addButton("click me 3", feedback_button);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	addToolBar-String_String
class	node

Table Row (tr)

id	name

Table Cell (td)
addToolBar

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

ToolBar

Span

style	float: left; font-weight: bold;
id	iets

addToolBar

Span

style	float: left;
id	iets

(name, displayname)

Table Row (tr)

id	des

Table Cell (td)
Add a toolbar.

Table Row (tr)

id	prs

Table Cell (td)
Parameters {String} name {String} displayname

Table Row (tr)

id	ret

Table Cell (td)
Returns ToolBar

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// Note: method addToolBar only works in the smart client.

// add a toolbar with only a name
var toolbar0 = plugins.window.addToolBar("toolbar_0");
toolbar0.addButton("click me 0", feedback_button);

// add a toolbar with a name and the row you want it to show at
// row number starts at 0
var toolbar1 = plugins.window.addToolBar("toolbar_1", 2);
toolbar1.addButton("click me 1", feedback_button);

// add a toolbar with a name and display name
var toolbar2 = plugins.window.addToolBar("toolbar_2", "toolbar_2_internal_name");
toolbar2.addButton("click me 2", feedback_button);

// add a toolbar with a name, display name and the row you want the
// toolbar to show at. row number starts at 0 
var toolbar3 = plugins.window.addToolBar("toolbar_3", "toolbar_3_internal_name", 3);
toolbar3.addButton("click me 3", feedback_button);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	addToolBar-String_String_Number
class	node

Table Row (tr)

id	name

Table Cell (td)
addToolBar

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

ToolBar

Span

style	float: left; font-weight: bold;
id	iets

addToolBar

Span

style	float: left;
id	iets

(name, displayname, row)

Table Row (tr)

id	des

Table Cell (td)
Add a toolbar.

Table Row (tr)

id	prs

Table Cell (td)
Parameters {String} name {String} displayname {Number} row

Table Row (tr)

id	ret

Table Cell (td)
Returns ToolBar

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// Note: method addToolBar only works in the smart client.

// add a toolbar with only a name
var toolbar0 = plugins.window.addToolBar("toolbar_0");
toolbar0.addButton("click me 0", feedback_button);

// add a toolbar with a name and the row you want it to show at
// row number starts at 0
var toolbar1 = plugins.window.addToolBar("toolbar_1", 2);
toolbar1.addButton("click me 1", feedback_button);

// add a toolbar with a name and display name
var toolbar2 = plugins.window.addToolBar("toolbar_2", "toolbar_2_internal_name");
toolbar2.addButton("click me 2", feedback_button);

// add a toolbar with a name, display name and the row you want the
// toolbar to show at. row number starts at 0 
var toolbar3 = plugins.window.addToolBar("toolbar_3", "toolbar_3_internal_name", 3);
toolbar3.addButton("click me 3", feedback_button);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	cancelFormPopup
class	node

Table Row (tr)

id	name

Table Cell (td)
cancelFormPopup

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

void

Span

style	float: left; font-weight: bold;
id	iets

cancelFormPopup

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
Close the current form popup panel without assigning a value to the configured data provider.

Table Row (tr)

id	ret

Table Cell (td)
Returns void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//Show a form as popup panel, where the closeFormPopup can pass return a value to a dataprovider in the specified scope.
plugins.window.showFormPopup(null,forms.orderPicker,foundset.getSelectedRecord(),"order_id");
//do call closeFormPopup(ordervalue) from the orderPicker form

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	closeFormPopup
class	node

Table Row (tr)

id	name

Table Cell (td)
closeFormPopup

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

void

Span

style	float: left; font-weight: bold;
id	iets

closeFormPopup

Span

style	float: left;
id	iets

(retval)

Table Row (tr)

id	des

Table Cell (td)
Close the current form popup panel and assign the value to the configured data provider.

Table Row (tr)

id	prs

Table Cell (td)
Parameters {Object} retval – return value for data provider

Table Row (tr)

id	ret

Table Cell (td)
Returns void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//Show a form as popup panel, where the closeFormPopup can pass return a value to a dataprovider in the specified scope.
plugins.window.showFormPopup(null,forms.orderPicker,foundset.getSelectedRecord(),"order_id");
//do call closeFormPopup(ordervalue) from the orderPicker form

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	createPopupMenu
class	node

Table Row (tr)

id	name

Table Cell (td)
createPopupMenu

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Popup

Span

style	float: left; font-weight: bold;
id	iets

createPopupMenu

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
Creates a new popup menu that can be populated with items and displayed.

Table Row (tr)

id	ret

Table Cell (td)
Returns Popup

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// create a popup menu
var menu = plugins.window.createPopupMenu();
// add a menu item
menu.addMenuItem("an entry", feedback);

if (event.getSource()) {
	// display the popup over the component which is the source of the event
	menu.show(event.getSource());
	// display the popup over the components, at specified coordinates relative to the component
	//menu.show(event.getSource(), 10, 10);
	// display the popup at specified coordinates relative to the main window
	//menu.show(100, 100);
}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	createShortcut-String_String
class	node

Table Row (tr)

id	name

Table Cell (td)
createShortcut

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Boolean

Span

style	float: left; font-weight: bold;
id	iets

createShortcut

Span

style	float: left;
id	iets

(shortcut, methodName)

Table Row (tr)

id	des

Table Cell (td)
Create a shortcut.

Table Row (tr)

id	prs

Table Cell (td)
Parameters {String} shortcut {String} methodName – scopes.scopename.methodname or formname.methodname String to target the method to execute

Table Row (tr)

id	ret

Table Cell (td)
Returns Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// this plugin uses the java keystroke parser
// see http://java.sun.com/j2se/1.5.0/docs/api/javax/swing/KeyStroke.html#getKeyStroke(java.lang.String)
// global handler
plugins.window.createShortcut('control shift I', scopes.globals.handleOrdersShortcut);
// global handler with a form context filter
plugins.window.createShortcut('control shift I', scopes.globals.handleOrdersShortcut, 'frm_contacts');
// form method called when shortcut is used
plugins.window.createShortcut('control RIGHT', forms.frm_contacts.handleMyShortcut);
// form method called when shortcut is used and arguments are passed to the method
plugins.window.createShortcut('control RIGHT', forms.frm_contacts.handleMyShortcut, new Array(argument1, argument2));
// Passing the method argument as a string prevents unnecessary form loading
//plugins.window.createShortcut('control RIGHT', 'frm_contacts.handleMyShortcut', new Array(argument1, argument2));
// Passing the method as a name and the contextFilter set so that this shortcut only trigger on the form 'frm_contacts'.
plugins.window.createShortcut('control RIGHT', 'frm_contacts.handleMyShortcut', 'frm_contacts', new Array(argument1, argument2));
// remove global shortcut and form-level shortcut
plugins.window.removeShortcut('menu 1');
plugins.window.removeShortcut('control RIGHT', 'frm_contacts');
// shortcut handlers are called with an JSEvent argument
///* 
// * Handle keyboard shortcut.
// * 
// * @param {JSEvent} event the event that triggered the action
// */
//function handleShortcut(event)
//{
//  application.output(event.getType()) // returns 'menu 1'
//  application.output(event.getFormName()) // returns 'frm_contacts'
//  application.output(event.getElementName()) // returns 'contact_name_field' or null when no element is selected
//}
// NOTE: shortcuts will not override existing operating system or browser shortcuts,
// choose your shortcuts careful to make sure they work in all clients.

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	createShortcut-String_String_ObjectArray
class	node

Table Row (tr)

id	name

Table Cell (td)
createShortcut

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Boolean

Span

style	float: left; font-weight: bold;
id	iets

createShortcut

Span

style	float: left;
id	iets

(shortcut, methodName, arguments)

Table Row (tr)

id	des

Table Cell (td)
Create a shortcut.

Table Row (tr)

id	prs

Table Cell (td)
Parameters {String} shortcut {String} methodName – scopes.scopename.methodname or formname.methodname String to target the method to execute {Object[]} arguments

Table Row (tr)

id	ret

Table Cell (td)
Returns Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// this plugin uses the java keystroke parser
// see http://java.sun.com/j2se/1.5.0/docs/api/javax/swing/KeyStroke.html#getKeyStroke(java.lang.String)
// global handler
plugins.window.createShortcut('control shift I', scopes.globals.handleOrdersShortcut);
// global handler with a form context filter
plugins.window.createShortcut('control shift I', scopes.globals.handleOrdersShortcut, 'frm_contacts');
// form method called when shortcut is used
plugins.window.createShortcut('control RIGHT', forms.frm_contacts.handleMyShortcut);
// form method called when shortcut is used and arguments are passed to the method
plugins.window.createShortcut('control RIGHT', forms.frm_contacts.handleMyShortcut, new Array(argument1, argument2));
// Passing the method argument as a string prevents unnecessary form loading
//plugins.window.createShortcut('control RIGHT', 'frm_contacts.handleMyShortcut', new Array(argument1, argument2));
// Passing the method as a name and the contextFilter set so that this shortcut only trigger on the form 'frm_contacts'.
plugins.window.createShortcut('control RIGHT', 'frm_contacts.handleMyShortcut', 'frm_contacts', new Array(argument1, argument2));
// remove global shortcut and form-level shortcut
plugins.window.removeShortcut('menu 1');
plugins.window.removeShortcut('control RIGHT', 'frm_contacts');
// shortcut handlers are called with an JSEvent argument
///* 
// * Handle keyboard shortcut.
// * 
// * @param {JSEvent} event the event that triggered the action
// */
//function handleShortcut(event)
//{
//  application.output(event.getType()) // returns 'menu 1'
//  application.output(event.getFormName()) // returns 'frm_contacts'
//  application.output(event.getElementName()) // returns 'contact_name_field' or null when no element is selected
//}
// NOTE: shortcuts will not override existing operating system or browser shortcuts,
// choose your shortcuts careful to make sure they work in all clients.

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	createShortcut-String_String_String
class	node

Table Row (tr)

id	name

Table Cell (td)
createShortcut

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Boolean

Span

style	float: left; font-weight: bold;
id	iets

createShortcut

Span

style	float: left;
id	iets

(shortcut, methodName, contextFilter)

Table Row (tr)

id	des

Table Cell (td)
Create a shortcut.

Table Row (tr)

id	prs

Table Cell (td)
Parameters {String} shortcut {String} methodName – scopes.scopename.methodname or formname.methodname String to target the method to execute {String} contextFilter – only triggers the shortcut when on this form

Table Row (tr)

id	ret

Table Cell (td)
Returns Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// this plugin uses the java keystroke parser
// see http://java.sun.com/j2se/1.5.0/docs/api/javax/swing/KeyStroke.html#getKeyStroke(java.lang.String)
// global handler
plugins.window.createShortcut('control shift I', scopes.globals.handleOrdersShortcut);
// global handler with a form context filter
plugins.window.createShortcut('control shift I', scopes.globals.handleOrdersShortcut, 'frm_contacts');
// form method called when shortcut is used
plugins.window.createShortcut('control RIGHT', forms.frm_contacts.handleMyShortcut);
// form method called when shortcut is used and arguments are passed to the method
plugins.window.createShortcut('control RIGHT', forms.frm_contacts.handleMyShortcut, new Array(argument1, argument2));
// Passing the method argument as a string prevents unnecessary form loading
//plugins.window.createShortcut('control RIGHT', 'frm_contacts.handleMyShortcut', new Array(argument1, argument2));
// Passing the method as a name and the contextFilter set so that this shortcut only trigger on the form 'frm_contacts'.
plugins.window.createShortcut('control RIGHT', 'frm_contacts.handleMyShortcut', 'frm_contacts', new Array(argument1, argument2));
// remove global shortcut and form-level shortcut
plugins.window.removeShortcut('menu 1');
plugins.window.removeShortcut('control RIGHT', 'frm_contacts');
// shortcut handlers are called with an JSEvent argument
///* 
// * Handle keyboard shortcut.
// * 
// * @param {JSEvent} event the event that triggered the action
// */
//function handleShortcut(event)
//{
//  application.output(event.getType()) // returns 'menu 1'
//  application.output(event.getFormName()) // returns 'frm_contacts'
//  application.output(event.getElementName()) // returns 'contact_name_field' or null when no element is selected
//}
// NOTE: shortcuts will not override existing operating system or browser shortcuts,
// choose your shortcuts careful to make sure they work in all clients.

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	createShortcut-String_String_String_ObjectArray
class	node

Table Row (tr)

id	name

Table Cell (td)
createShortcut

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Boolean

Span

style	float: left; font-weight: bold;
id	iets

createShortcut

Span

style	float: left;
id	iets

(shortcut, methodName, contextFilter, arguments)

Table Row (tr)

id	des

Table Cell (td)
Create a shortcut.

Table Row (tr)

id	prs

Table Cell (td)
Parameters {String} shortcut {String} methodName – scopes.scopename.methodname or formname.methodname String to target the method to execute {String} contextFilter – only triggers the shortcut when on this form {Object[]} arguments

Table Row (tr)

id	ret

Table Cell (td)
Returns Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// this plugin uses the java keystroke parser
// see http://java.sun.com/j2se/1.5.0/docs/api/javax/swing/KeyStroke.html#getKeyStroke(java.lang.String)
// global handler
plugins.window.createShortcut('control shift I', scopes.globals.handleOrdersShortcut);
// global handler with a form context filter
plugins.window.createShortcut('control shift I', scopes.globals.handleOrdersShortcut, 'frm_contacts');
// form method called when shortcut is used
plugins.window.createShortcut('control RIGHT', forms.frm_contacts.handleMyShortcut);
// form method called when shortcut is used and arguments are passed to the method
plugins.window.createShortcut('control RIGHT', forms.frm_contacts.handleMyShortcut, new Array(argument1, argument2));
// Passing the method argument as a string prevents unnecessary form loading
//plugins.window.createShortcut('control RIGHT', 'frm_contacts.handleMyShortcut', new Array(argument1, argument2));
// Passing the method as a name and the contextFilter set so that this shortcut only trigger on the form 'frm_contacts'.
plugins.window.createShortcut('control RIGHT', 'frm_contacts.handleMyShortcut', 'frm_contacts', new Array(argument1, argument2));
// remove global shortcut and form-level shortcut
plugins.window.removeShortcut('menu 1');
plugins.window.removeShortcut('control RIGHT', 'frm_contacts');
// shortcut handlers are called with an JSEvent argument
///* 
// * Handle keyboard shortcut.
// * 
// * @param {JSEvent} event the event that triggered the action
// */
//function handleShortcut(event)
//{
//  application.output(event.getType()) // returns 'menu 1'
//  application.output(event.getFormName()) // returns 'frm_contacts'
//  application.output(event.getElementName()) // returns 'contact_name_field' or null when no element is selected
//}
// NOTE: shortcuts will not override existing operating system or browser shortcuts,
// choose your shortcuts careful to make sure they work in all clients.

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	createShortcut-String_Function
class	node

Table Row (tr)

id	name

Table Cell (td)
createShortcut

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Boolean

Span

style	float: left; font-weight: bold;
id	iets

createShortcut

Span

style	float: left;
id	iets

(shortcut, method)

Table Row (tr)

id	des

Table Cell (td)
Create a shortcut.

Table Row (tr)

id	prs

Table Cell (td)
Parameters {String} shortcut {Function} method – the method/function that needs to be called when the shortcut is hit

Table Row (tr)

id	ret

Table Cell (td)
Returns Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// this plugin uses the java keystroke parser
// see http://java.sun.com/j2se/1.5.0/docs/api/javax/swing/KeyStroke.html#getKeyStroke(java.lang.String)
// global handler
plugins.window.createShortcut('control shift I', scopes.globals.handleOrdersShortcut);
// global handler with a form context filter
plugins.window.createShortcut('control shift I', scopes.globals.handleOrdersShortcut, 'frm_contacts');
// form method called when shortcut is used
plugins.window.createShortcut('control RIGHT', forms.frm_contacts.handleMyShortcut);
// form method called when shortcut is used and arguments are passed to the method
plugins.window.createShortcut('control RIGHT', forms.frm_contacts.handleMyShortcut, new Array(argument1, argument2));
// Passing the method argument as a string prevents unnecessary form loading
//plugins.window.createShortcut('control RIGHT', 'frm_contacts.handleMyShortcut', new Array(argument1, argument2));
// Passing the method as a name and the contextFilter set so that this shortcut only trigger on the form 'frm_contacts'.
plugins.window.createShortcut('control RIGHT', 'frm_contacts.handleMyShortcut', 'frm_contacts', new Array(argument1, argument2));
// remove global shortcut and form-level shortcut
plugins.window.removeShortcut('menu 1');
plugins.window.removeShortcut('control RIGHT', 'frm_contacts');
// shortcut handlers are called with an JSEvent argument
///* 
// * Handle keyboard shortcut.
// * 
// * @param {JSEvent} event the event that triggered the action
// */
//function handleShortcut(event)
//{
//  application.output(event.getType()) // returns 'menu 1'
//  application.output(event.getFormName()) // returns 'frm_contacts'
//  application.output(event.getElementName()) // returns 'contact_name_field' or null when no element is selected
//}
// NOTE: shortcuts will not override existing operating system or browser shortcuts,
// choose your shortcuts careful to make sure they work in all clients.

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	createShortcut-String_Function_ObjectArray
class	node

Table Row (tr)

id	name

Table Cell (td)
createShortcut

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Boolean

Span

style	float: left; font-weight: bold;
id	iets

createShortcut

Span

style	float: left;
id	iets

(shortcut, method, arguments)

Table Row (tr)

id	des

Table Cell (td)
Create a shortcut.

Table Row (tr)

id	prs

Table Cell (td)
Parameters {String} shortcut {Function} method – the method/function that needs to be called when the shortcut is hit {Object[]} arguments

Table Row (tr)

id	ret

Table Cell (td)
Returns Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// this plugin uses the java keystroke parser
// see http://java.sun.com/j2se/1.5.0/docs/api/javax/swing/KeyStroke.html#getKeyStroke(java.lang.String)
// global handler
plugins.window.createShortcut('control shift I', scopes.globals.handleOrdersShortcut);
// global handler with a form context filter
plugins.window.createShortcut('control shift I', scopes.globals.handleOrdersShortcut, 'frm_contacts');
// form method called when shortcut is used
plugins.window.createShortcut('control RIGHT', forms.frm_contacts.handleMyShortcut);
// form method called when shortcut is used and arguments are passed to the method
plugins.window.createShortcut('control RIGHT', forms.frm_contacts.handleMyShortcut, new Array(argument1, argument2));
// Passing the method argument as a string prevents unnecessary form loading
//plugins.window.createShortcut('control RIGHT', 'frm_contacts.handleMyShortcut', new Array(argument1, argument2));
// Passing the method as a name and the contextFilter set so that this shortcut only trigger on the form 'frm_contacts'.
plugins.window.createShortcut('control RIGHT', 'frm_contacts.handleMyShortcut', 'frm_contacts', new Array(argument1, argument2));
// remove global shortcut and form-level shortcut
plugins.window.removeShortcut('menu 1');
plugins.window.removeShortcut('control RIGHT', 'frm_contacts');
// shortcut handlers are called with an JSEvent argument
///* 
// * Handle keyboard shortcut.
// * 
// * @param {JSEvent} event the event that triggered the action
// */
//function handleShortcut(event)
//{
//  application.output(event.getType()) // returns 'menu 1'
//  application.output(event.getFormName()) // returns 'frm_contacts'
//  application.output(event.getElementName()) // returns 'contact_name_field' or null when no element is selected
//}
// NOTE: shortcuts will not override existing operating system or browser shortcuts,
// choose your shortcuts careful to make sure they work in all clients.

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	createShortcut-String_Function_String
class	node

Table Row (tr)

id	name

Table Cell (td)
createShortcut

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Boolean

Span

style	float: left; font-weight: bold;
id	iets

createShortcut

Span

style	float: left;
id	iets

(shortcut, method, contextFilter)

Table Row (tr)

id	des

Table Cell (td)
Create a shortcut.

Table Row (tr)

id	prs

Table Cell (td)
Parameters {String} shortcut {Function} method – the method/function that needs to be called when the shortcut is hit {String} contextFilter – only triggers the shortcut when on this form

Table Row (tr)

id	ret

Table Cell (td)
Returns Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// this plugin uses the java keystroke parser
// see http://java.sun.com/j2se/1.5.0/docs/api/javax/swing/KeyStroke.html#getKeyStroke(java.lang.String)
// global handler
plugins.window.createShortcut('control shift I', scopes.globals.handleOrdersShortcut);
// global handler with a form context filter
plugins.window.createShortcut('control shift I', scopes.globals.handleOrdersShortcut, 'frm_contacts');
// form method called when shortcut is used
plugins.window.createShortcut('control RIGHT', forms.frm_contacts.handleMyShortcut);
// form method called when shortcut is used and arguments are passed to the method
plugins.window.createShortcut('control RIGHT', forms.frm_contacts.handleMyShortcut, new Array(argument1, argument2));
// Passing the method argument as a string prevents unnecessary form loading
//plugins.window.createShortcut('control RIGHT', 'frm_contacts.handleMyShortcut', new Array(argument1, argument2));
// Passing the method as a name and the contextFilter set so that this shortcut only trigger on the form 'frm_contacts'.
plugins.window.createShortcut('control RIGHT', 'frm_contacts.handleMyShortcut', 'frm_contacts', new Array(argument1, argument2));
// remove global shortcut and form-level shortcut
plugins.window.removeShortcut('menu 1');
plugins.window.removeShortcut('control RIGHT', 'frm_contacts');
// shortcut handlers are called with an JSEvent argument
///* 
// * Handle keyboard shortcut.
// * 
// * @param {JSEvent} event the event that triggered the action
// */
//function handleShortcut(event)
//{
//  application.output(event.getType()) // returns 'menu 1'
//  application.output(event.getFormName()) // returns 'frm_contacts'
//  application.output(event.getElementName()) // returns 'contact_name_field' or null when no element is selected
//}
// NOTE: shortcuts will not override existing operating system or browser shortcuts,
// choose your shortcuts careful to make sure they work in all clients.

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	createShortcut-String_Function_String_ObjectArray
class	node

Table Row (tr)

id	name

Table Cell (td)
createShortcut

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Boolean

Span

style	float: left; font-weight: bold;
id	iets

createShortcut

Span

style	float: left;
id	iets

(shortcut, method, contextFilter, arguments)

Table Row (tr)

id	des

Table Cell (td)
Create a shortcut.

Table Row (tr)

id	prs

Table Cell (td)
Parameters {String} shortcut {Function} method – the method/function that needs to be called when the shortcut is hit {String} contextFilter – only triggers the shortcut when on this form {Object[]} arguments

Table Row (tr)

id	ret

Table Cell (td)
Returns Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// this plugin uses the java keystroke parser
// see http://java.sun.com/j2se/1.5.0/docs/api/javax/swing/KeyStroke.html#getKeyStroke(java.lang.String)
// global handler
plugins.window.createShortcut('control shift I', scopes.globals.handleOrdersShortcut);
// global handler with a form context filter
plugins.window.createShortcut('control shift I', scopes.globals.handleOrdersShortcut, 'frm_contacts');
// form method called when shortcut is used
plugins.window.createShortcut('control RIGHT', forms.frm_contacts.handleMyShortcut);
// form method called when shortcut is used and arguments are passed to the method
plugins.window.createShortcut('control RIGHT', forms.frm_contacts.handleMyShortcut, new Array(argument1, argument2));
// Passing the method argument as a string prevents unnecessary form loading
//plugins.window.createShortcut('control RIGHT', 'frm_contacts.handleMyShortcut', new Array(argument1, argument2));
// Passing the method as a name and the contextFilter set so that this shortcut only trigger on the form 'frm_contacts'.
plugins.window.createShortcut('control RIGHT', 'frm_contacts.handleMyShortcut', 'frm_contacts', new Array(argument1, argument2));
// remove global shortcut and form-level shortcut
plugins.window.removeShortcut('menu 1');
plugins.window.removeShortcut('control RIGHT', 'frm_contacts');
// shortcut handlers are called with an JSEvent argument
///* 
// * Handle keyboard shortcut.
// * 
// * @param {JSEvent} event the event that triggered the action
// */
//function handleShortcut(event)
//{
//  application.output(event.getType()) // returns 'menu 1'
//  application.output(event.getFormName()) // returns 'frm_contacts'
//  application.output(event.getElementName()) // returns 'contact_name_field' or null when no element is selected
//}
// NOTE: shortcuts will not override existing operating system or browser shortcuts,
// choose your shortcuts careful to make sure they work in all clients.

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getMenuBar
class	node

Table Row (tr)

id	name

Table Cell (td)
getMenuBar

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

MenuBar

Span

style	float: left; font-weight: bold;
id	iets

getMenuBar

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
Get the menubar of the main window, or of a named window.

Table Row (tr)

id	ret

Table Cell (td)
Returns MenuBar

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// create a new window
var win = application.createWindow("windowName", JSWindow.WINDOW);
// show a form in the new window
forms.my_form.controller.show(win);
// retrieve the menubar of the new window
var menubar = plugins.window.getMenuBar("windowName");
// add a new menu to the menubar, with an item in it
var menu = menubar.addMenu();
menu.text = "New Menu";
menu.addMenuItem("an entry", feedback);
// retrieve the menubar of the main window
var mainMenubar = plugins.window.getMenuBar();
// add a new menu to the menubar of the main window
var menuMain = mainMenubar.addMenu();
menuMain.text = "New Menu in Main Menubar";
menuMain.addMenuItem("another entry", feedback);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getMenuBar-String
class	node

Table Row (tr)

id	name

Table Cell (td)
getMenuBar

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

MenuBar

Span

style	float: left; font-weight: bold;
id	iets

getMenuBar

Span

style	float: left;
id	iets

(windowName)

Table Row (tr)

id	des

Table Cell (td)
Get the menubar of the main window, or of a named window.

Table Row (tr)

id	prs

Table Cell (td)
Parameters {String} windowName – the name of the window

Table Row (tr)

id	ret

Table Cell (td)
Returns MenuBar

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// create a new window
var win = application.createWindow("windowName", JSWindow.WINDOW);
// show a form in the new window
forms.my_form.controller.show(win);
// retrieve the menubar of the new window
var menubar = plugins.window.getMenuBar("windowName");
// add a new menu to the menubar, with an item in it
var menu = menubar.addMenu();
menu.text = "New Menu";
menu.addMenuItem("an entry", feedback);
// retrieve the menubar of the main window
var mainMenubar = plugins.window.getMenuBar();
// add a new menu to the menubar of the main window
var menuMain = mainMenubar.addMenu();
menuMain.text = "New Menu in Main Menubar";
menuMain.addMenuItem("another entry", feedback);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getToolBar
class	node

Table Row (tr)

id	name

Table Cell (td)
getToolBar

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

ToolBar

Span

style	float: left; font-weight: bold;
id	iets

getToolBar

Span

style	float: left;
id	iets

(name)

Table Row (tr)

id	des

Table Cell (td)
Get the toolbar from the toolbar panel by name.

Table Row (tr)

id	prs

Table Cell (td)
Parameters {String} name

Table Row (tr)

id	ret

Table Cell (td)
Returns ToolBar

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// Note: method getToolBar only works in the smart client.

// the toolbar must first be create with a call to addToolbar
plugins.window.addToolBar("toolbar_0");

// get the toolbar at the panel by name
var toolbar = plugins.window.getToolBar("toolbar_0");
// add a button to the toolbar
toolbar.addButton("button", feedback_button);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getToolbarNames
class	node

Table Row (tr)

id	name

Table Cell (td)
getToolbarNames

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

String[]

Span

style	float: left; font-weight: bold;
id	iets

getToolbarNames

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
Get all toolbar names from the toolbar panel.

Table Row (tr)

id	ret

Table Cell (td)
Returns String[]

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// Note: method getToolbarNames only works in the smart client.

// create an array of toolbar names
var names = plugins.window.getToolbarNames();

// create an empty message variable
var message = "";

// loop through the array
for (var i = 0 ; i < names.length ; i++) {
	//add the name(s) to the message
	message += names[i] + "\n";
}

// show the message
plugins.dialogs.showInfoDialog("toolbar names", message);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	maximize
class	node

Table Row (tr)

id	name

Table Cell (td)
maximize

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

void

Span

style	float: left; font-weight: bold;
id	iets

maximize

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
Maximize the current window or the window with the specified name (Smart client only).

Table Row (tr)

id	ret

Table Cell (td)
Returns void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// maximize the main window:
plugins.window.maximize();

// create a new window
var win = application.createWindow("windowName", JSWindow.WINDOW);
// show a form in the new window
forms.my_form.controller.show(win);
// maximize the window
plugins.window.maximize("windowName");

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	maximize-String
class	node

Table Row (tr)

id	name

Table Cell (td)
maximize

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

void

Span

style	float: left; font-weight: bold;
id	iets

maximize

Span

style	float: left;
id	iets

(windowName)

Table Row (tr)

id	des

Table Cell (td)
Maximize the current window or the window with the specified name (Smart client only).

Table Row (tr)

id	prs

Table Cell (td)
Parameters {String} windowName

Table Row (tr)

id	ret

Table Cell (td)
Returns void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// maximize the main window:
plugins.window.maximize();

// create a new window
var win = application.createWindow("windowName", JSWindow.WINDOW);
// show a form in the new window
forms.my_form.controller.show(win);
// maximize the window
plugins.window.maximize("windowName");

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	removeShortcut-String
class	node

Table Row (tr)

id	name

Table Cell (td)
removeShortcut

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Boolean

Span

style	float: left; font-weight: bold;
id	iets

removeShortcut

Span

style	float: left;
id	iets

(shortcut)

Table Row (tr)

id	des

Table Cell (td)
Remove a shortcut.

Table Row (tr)

id	prs

Table Cell (td)
Parameters {String} shortcut

Table Row (tr)

id	ret

Table Cell (td)
Returns Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// this plugin uses the java keystroke parser
// see http://java.sun.com/j2se/1.5.0/docs/api/javax/swing/KeyStroke.html#getKeyStroke(java.lang.String)
// global handler
plugins.window.createShortcut('control shift I', scopes.globals.handleOrdersShortcut);
// global handler with a form context filter
plugins.window.createShortcut('control shift I', scopes.globals.handleOrdersShortcut, 'frm_contacts');
// form method called when shortcut is used
plugins.window.createShortcut('control RIGHT', forms.frm_contacts.handleMyShortcut);
// form method called when shortcut is used and arguments are passed to the method
plugins.window.createShortcut('control RIGHT', forms.frm_contacts.handleMyShortcut, new Array(argument1, argument2));
// Passing the method argument as a string prevents unnecessary form loading
//plugins.window.createShortcut('control RIGHT', 'frm_contacts.handleMyShortcut', new Array(argument1, argument2));
// Passing the method as a name and the contextFilter set so that this shortcut only trigger on the form 'frm_contacts'.
plugins.window.createShortcut('control RIGHT', 'frm_contacts.handleMyShortcut', 'frm_contacts', new Array(argument1, argument2));
// remove global shortcut and form-level shortcut
plugins.window.removeShortcut('menu 1');
plugins.window.removeShortcut('control RIGHT', 'frm_contacts');
// shortcut handlers are called with an JSEvent argument
///* 
// * Handle keyboard shortcut.
// * 
// * @param {JSEvent} event the event that triggered the action
// */
//function handleShortcut(event)
//{
//  application.output(event.getType()) // returns 'menu 1'
//  application.output(event.getFormName()) // returns 'frm_contacts'
//  application.output(event.getElementName()) // returns 'contact_name_field' or null when no element is selected
//}
// NOTE: shortcuts will not override existing operating system or browser shortcuts,
// choose your shortcuts careful to make sure they work in all clients.

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	removeShortcut-String_String
class	node

Table Row (tr)

id	name

Table Cell (td)
removeShortcut

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Boolean

Span

style	float: left; font-weight: bold;
id	iets

removeShortcut

Span

style	float: left;
id	iets

(shortcut, contextFilter)

Table Row (tr)

id	des

Table Cell (td)
Remove a shortcut.

Table Row (tr)

id	prs

Table Cell (td)
Parameters {String} shortcut {String} contextFilter – only triggers the shortcut when on this form

Table Row (tr)

id	ret

Table Cell (td)
Returns Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// this plugin uses the java keystroke parser
// see http://java.sun.com/j2se/1.5.0/docs/api/javax/swing/KeyStroke.html#getKeyStroke(java.lang.String)
// global handler
plugins.window.createShortcut('control shift I', scopes.globals.handleOrdersShortcut);
// global handler with a form context filter
plugins.window.createShortcut('control shift I', scopes.globals.handleOrdersShortcut, 'frm_contacts');
// form method called when shortcut is used
plugins.window.createShortcut('control RIGHT', forms.frm_contacts.handleMyShortcut);
// form method called when shortcut is used and arguments are passed to the method
plugins.window.createShortcut('control RIGHT', forms.frm_contacts.handleMyShortcut, new Array(argument1, argument2));
// Passing the method argument as a string prevents unnecessary form loading
//plugins.window.createShortcut('control RIGHT', 'frm_contacts.handleMyShortcut', new Array(argument1, argument2));
// Passing the method as a name and the contextFilter set so that this shortcut only trigger on the form 'frm_contacts'.
plugins.window.createShortcut('control RIGHT', 'frm_contacts.handleMyShortcut', 'frm_contacts', new Array(argument1, argument2));
// remove global shortcut and form-level shortcut
plugins.window.removeShortcut('menu 1');
plugins.window.removeShortcut('control RIGHT', 'frm_contacts');
// shortcut handlers are called with an JSEvent argument
///* 
// * Handle keyboard shortcut.
// * 
// * @param {JSEvent} event the event that triggered the action
// */
//function handleShortcut(event)
//{
//  application.output(event.getType()) // returns 'menu 1'
//  application.output(event.getFormName()) // returns 'frm_contacts'
//  application.output(event.getElementName()) // returns 'contact_name_field' or null when no element is selected
//}
// NOTE: shortcuts will not override existing operating system or browser shortcuts,
// choose your shortcuts careful to make sure they work in all clients.

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	removeToolBar
class	node

Table Row (tr)

id	name

Table Cell (td)
removeToolBar

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

void

Span

style	float: left; font-weight: bold;
id	iets

removeToolBar

Span

style	float: left;
id	iets

(name)

Table Row (tr)

id	des

Table Cell (td)
Remove the toolbar from the toolbar panel.

Table Row (tr)

id	prs

Table Cell (td)
Parameters {String} name

Table Row (tr)

id	ret

Table Cell (td)
Returns void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// Note: method removeToolBar only works in the smart client.

// the toolbar must first be create with a call to addToolbar
var toolbar = plugins.window.addToolBar("toolbar_0");

// add a button to the toolbar
toolbar.addButton("button", feedback_button);

// removing a toolbar from the toolbar panel is done by name
// the plugin checks the existence of the toolbar
// when the toolbar does not exist it will not throw an error though.
plugins.window.removeToolBar("toolbar_0");

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	setFullScreen
class	node

Table Row (tr)

id	name

Table Cell (td)
setFullScreen

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

void

Span

style	float: left; font-weight: bold;
id	iets

setFullScreen

Span

style	float: left;
id	iets

(full)

Table Row (tr)

id	des

Table Cell (td)
Bring the window into/out of fullsceen mode.

Table Row (tr)

id	prs

Table Cell (td)
Parameters {Boolean} full

Table Row (tr)

id	ret

Table Cell (td)
Returns void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// active fullscreen mode 
plugins.window.setFullScreen(true);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	setStatusBarVisible
class	node

Table Row (tr)

id	name

Table Cell (td)
setStatusBarVisible

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

void

Span

style	float: left; font-weight: bold;
id	iets

setStatusBarVisible

Span

style	float: left;
id	iets

(visible)

Table Row (tr)

id	des

Table Cell (td)
Show or hide the statusbar.

Table Row (tr)

id	prs

Table Cell (td)
Parameters {Boolean} visible

Table Row (tr)

id	ret

Table Cell (td)
Returns void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// hide the statusbar
plugins.window.setStatusBarVisible(false);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	setToolBarAreaVisible
class	node

Table Row (tr)

id	name

Table Cell (td)
setToolBarAreaVisible

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

void

Span

style	float: left; font-weight: bold;
id	iets

setToolBarAreaVisible

Span

style	float: left;
id	iets

(visible)

Table Row (tr)

id	des

Table Cell (td)
Show or hide the toolbar area.

Table Row (tr)

id	prs

Table Cell (td)
Parameters {Boolean} visible

Table Row (tr)

id	ret

Table Cell (td)
Returns void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// hide the toolbar area
plugins.window.setToolBarAreaVisible(false);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	showFormPopup
class	node

Table Row (tr)

id	name

Table Cell (td)
showFormPopup

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

void

Span

style	float: left; font-weight: bold;
id	iets

showFormPopup

Span

style	float: left;
id	iets

(elementToShowRelatedTo, form, scope, dataproviderID)

Table Row (tr)

id	des

Table Cell (td)
Show a form as popup panel, where the closeFormPopup can pass return a value to a dataprovider in the specified scope.

Table Row (tr)

id	prs

Table Cell (td)
Parameters {RuntimeComponent} elementToShowRelatedTo – element to show related to or null to center in screen {controller} form – the form to show {Object} scope – the scope to put retval into {String} dataproviderID – the dataprovider of scope to fill

Table Row (tr)

id	ret

Table Cell (td)
Returns void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//Show a form as popup panel, where the closeFormPopup can pass return a value to a dataprovider in the specified scope.
plugins.window.showFormPopup(null,forms.orderPicker,foundset.getSelectedRecord(),"order_id");
//do call closeFormPopup(ordervalue) from the orderPicker form

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Child pages

Versions Compared

Old Version 15

New Version Current

Key

addToolBar

addToolBar

addToolBar

addToolBar

cancelFormPopup

closeFormPopup

createPopupMenu

createShortcut

createShortcut

createShortcut

createShortcut

createShortcut

createShortcut

createShortcut

createShortcut

getMenuBar

getMenuBar

getToolBar

getToolbarNames

maximize

maximize

removeShortcut

removeShortcut

removeToolBar

setFullScreen

setStatusBarVisible

setToolBarAreaVisible

showFormPopup