Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Divcache
Div
iddescription
HTML Table
id
classservoy sReturnTypes
Colgroup Tag
Col
colspan2
width100%
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Return Types
Table Row (tr)
Table Cell (td)
Span
classsWordList
CheckBox
Span
classsWordList
Menu
Span
classsWordList
MenuBar
Span
classsWordList
MenuItem
Span
classsWordList
Popup
Span
classsWordList
RadioButton
Span
classsWordList
ToolBar
HTML Table
id
classservoy sSummary
Colgroup Tag
Col
width80px
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Method Summary
Table Row (tr)
Table Cell (td)
ToolBar
Table Cell (td)addToolBar(window, name)
styleindexdisplay:none

DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY (EXCEPT INSIDE THE DIV BELOW WITH ID=DESCRIPTION), UNLESS YOU KNOW WHAT YOU'RE DOING.
THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO AUTO UPDATE THE CONTENT THROUGH THE DOC GENERATOR.

true
refresh100d
showRefreshtrue
iddoc
titleRefresh page
showDatetrue
retryEnable
id

servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClientsWordListNGClient

servoy sSummary12%30%58%height: 30px;3Methods SummaryCreates and returns a toolbar for a specific window. Table Row (tr)

Table Cell (td)
ToolBar
Table Cell (td)addToolBar(window, name, row)
addToolBar(window, name, displayname)
Creates and returns a toolbar for a specific window. Table Row (tr)
Table Cell (td)
ToolBar
Table Cell (td)Creates and returns a toolbar for a specific window. Table Row (tr)
Table Cell (td)
ToolBar
Table Cell (td)addToolBar(window, name, displayname, row)
Creates and returns a toolbar for a specific window. Table Row (tr)
Table Cell (td)
ToolBar
Table Cell (td)addToolBar(name)
Add a toolbar. Table Row (tr)
Table Cell (td)
ToolBar
Table Cell (td)addToolBar(name, row)
addToolBar(name, displayname)
Add a toolbar. Table Row (tr)
Table Cell (td)
ToolBar
Table Cell (td)Add a toolbar. Table Row (tr)
Table Cell (td)
ToolBar
Table Cell (td)addToolBar(name, displayname, row)
Table Row (tr) Table Cell (td)Add a toolbar.void Table Cell (td)cancelFormPopup()
Table Row (tr) Table Cell (td)Close the current form popup panel without assigning a value to the configured data provider.void Table Cell (td)closeFormPopup(retval)
Table Row (tr)
Table Cell (td)
Popup
Table Cell (td)createPopupMenu()
Close the current form popup panel and assign the value to the configured data provider.createShortcut(shortcut, methodName)
Create a form popup that can be filled with data and shown.Creates a new popup menu that can be populated with items and displayed. Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)Create a shortcut.Create a shortcut. Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)createShortcut(shortcut, methodName, arguments)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)createShortcut(shortcut, methodName, contextFilter)
Create a shortcut.Create a shortcut.Create a shortcut. Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)createShortcut(shortcut, methodName, contextFilter, arguments)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)createShortcut(shortcut, method)
Create a shortcut.Create a shortcut. Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)createShortcut(shortcut, method, arguments)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)createShortcut(shortcut, method, contextFilter)
Create a shortcut.Create a shortcut. Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)createShortcut(shortcut, method, contextFilter, arguments)
Table Row (tr)
Table Cell (td)
MenuBar
Table Cell (td)getMenuBar()
Create a shortcut. Table Row (tr)
Table Cell (td)
MenuBar
Table Cell (td)getMenuBar(windowName)
Get the menubar of the main window, or of a named window.getToolBar(window, name)
Get the menubar of the main window, or of a named window. Table Row (tr)
Table Cell (td)
ToolBar
Table Cell (td)Get the toolbar of a specific window from the toolbar panel by name. Table Row (tr)
Table Cell (td)
ToolBar
Table Cell (td)getToolBar(name)
Table Row (tr)
Table Cell (td)
String[]
Table Cell (td)getToolbarNames()
Get the toolbar from the toolbar panel by name. Table Row (tr)
Table Cell (td)
String[]
Table Cell (td)getToolbarNames(window)
Get all toolbar names from the toolbar panel. Table Row (tr) Table Cell (td)Get all toolbar names from the toolbar panel of a specific window.void Table Cell (td)maximize()
Table Row (tr) Table Cell (td)Maximize the current window or the window with the specified name (Smart client only).void Table Cell (td)maximize(windowName)
removeShortcut(shortcut)
Maximize the current window or the window with the specified name (Smart client only). Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)Remove a shortcut. Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)removeShortcut(shortcut, contextFilter)
Table Row (tr) Table Cell (td)Remove a shortcut.void Table Cell (td)removeToolBar(window, name)
Table Row (tr) Table Cell (td)Remove the toolbar from the toolbar panel of a specific window.void Table Cell (td)removeToolBar(name)
Table Row (tr) Table Cell (td)Remove the toolbar from the toolbar panel.void Table Cell (td)setFullScreen(full)
Table Row (tr) Table Cell (td)Bring the window into/out of fullsceen mode.void Table Cell (td)setStatusBarVisible(visible)
Table Row (tr) Table Cell (td)Show or hide the statusbar.void Table Cell (td)setToolBarAreaVisible(visible)
Show or hide the toolbar area. Table Row (tr)
Table Cell (td)
void
Table Cell (td)showFormPopup(elementToShowRelatedTo, form, scope, dataproviderID)
Table Row (tr)
Table Cell (td)
void
Table Cell (td)showFormPopup(elementToShowRelatedTo, form, scope, dataproviderID, width, height)
voidShow a form as popup panel, where the closeFormPopup can pass return a value to a dataprovider in the specified scope.voidShow a form as popup panel, where the closeFormPopup can pass return a value to a dataprovider in the specified scope.voidShow a form as popup panel, where the closeFormPopup can pass return a value to a dataprovider in the specified scope.voidShow a form as popup panel, where the closeFormPopup can pass return a value to a dataprovider in the specified scope.

HTML Table

functionclass Colgroup Tag Colcolspanservoy sDetail2width100%

Col
Table Head (thead) Table Row (tr)styleheight:30px;
Table Head (th)
colspan2
Method Details
Table Body (tbody)
idaddToolBar-JSWindow_String
Table Row (tr)
idname
Table Cell (td)

addToolBar

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
ToolBar
Span
stylefont-weight: bold;
addToolBar
Spanid2Methods DetailsaddToolBarname

addToolBar(window, name)

Table Row (tr)des Table Cell (td) DivclassidsIndent
Creates and returns a toolbar for a specific window.
Table Row (tr)prs

Table Cell (td)class

Parameters

DivsIndent{JSWindow} window
{String} name - Table Row (tr)idwindow ;namethe name by which this toolbar is identified in code. If display name is missing, name will be used as displayName as well.ret

Table Cell (td)

Returns

divsIndentclients

classid

Supported Clients

sIndent
ToolBar Table Row (tr)SmartClientsam

Table Cell (td)

Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idaddToolBar-JSWindow_String_Number
Table Row (tr)
idname
Table Cell (td)

addToolBar

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
ToolBar
Span
stylefont-weight: bold;
addToolBar
Span

Sample

Div
classsIndent
Code Block
languagejavascript
// Note: method addToolBar only works in the smart client.

// create a window
var win = application.createWindow("myWindow", JSWindow.WINDOW);

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

// 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(win,"toolbar_1", 2);
toolbar1.addButton("click me 1", callback_function);

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

// 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(win,"toolbar_3", "toolbar_3_internal_name", 3);
toolbar3.addButton("click me 3", callback_function);

win.show(forms.Myform)
idsIdentjavascriptlastDetailRowaddToolBarname

addToolBar(window, name, row)

Table Row (tr)classdes Table Cell (td) DividsIndent
Creates and returns a toolbar for a specific window.
Table Row (tr)prs

Table Cell (td)class

Parameters

DivsIndent{JSWindow} window
{String} name - window ;namethe name by which this toolbar is identified in code. If display name is missing, name will be used as displayName as well.
{Number} row - Table Row (tr)idthe row inside the toolbar panel where this toolbar is to be added.ret

Table Cell (td)

Returns

divsIndentclients

classid

Supported Clients

sIndent
ToolBar Table Row (tr)SmartClientsam

Table Cell (td)

Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idaddToolBar-JSWindow_String_String
Table Row (tr)
idname
Table Cell (td)

addToolBar

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
ToolBar
Span
stylefont-weight: bold;
addToolBar
Span

Sample

Div
classsIndent
Code Block
languagejavascript
// Note: method addToolBar only works in the smart client.

// create a window
var win = application.createWindow("myWindow", JSWindow.WINDOW);

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

// 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(win,"toolbar_1", 2);
toolbar1.addButton("click me 1", callback_function);

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

// 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(win,"toolbar_3", "toolbar_3_internal_name", 3);
toolbar3.addButton("click me 3", callback_function);

win.show(forms.Myform)
idsIdentjavascriptlastDetailRowaddToolBarname

addToolBar(window, name, displayname)

Table Row (tr)classdes Table Cell (td) DividsIndent
Creates and returns a toolbar for a specific window.
Table Row (tr)prs

Table Cell (td)class

Parameters

DivsIndent{JSWindow} window
{String} name - window ;namethe name by which this toolbar is identified in code
{String} displayname - Table Row (tr)idthe name by which this toolbar will be identified in the UI. (for example in the toolbar panel's context menu)ret

Table Cell (td)

Returns

divsIndentclients

classid

Supported Clients

sIndent
ToolBar Table Row (tr)SmartClientsam

Table Cell (td)

Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idaddToolBar-JSWindow_String_String_Number
Table Row (tr)
idname
Table Cell (td)

addToolBar

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
ToolBar
Span
stylefont-weight: bold;
addToolBar
Span

Sample

Div
classsIndent
Code Block
languagejavascript
// Note: method addToolBar only works in the smart client.

// create a window
var win = application.createWindow("myWindow", JSWindow.WINDOW);

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

// 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(win,"toolbar_1", 2);
toolbar1.addButton("click me 1", callback_function);

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

// 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(win,"toolbar_3", "toolbar_3_internal_name", 3);
toolbar3.addButton("click me 3", callback_function);

win.show(forms.Myform)
idsIdentjavascriptlastDetailRowaddToolBarname

addToolBar(window, name, displayname, row)

Table Row (tr)classdes Table Cell (td) DividsIndent
Creates and returns a toolbar for a specific window.
Table Row (tr)prs

Table Cell (td)class

Parameters

DivsIndent{JSWindow} window
{String} name - window ;namethe name by which this toolbar is identified in code.
{String} displayname - the name by which this toolbar will be identified in the UI. (for example in the toolbar panel's context menu)
{Number} row - Table Row (tr)idthe row inside the toolbar panel where this toolbar is to be added.ret

Table Cell (td)

Returns

divsIndentclients

classid

Supported Clients

sIndent
ToolBar Table Row (tr)SmartClientsam

Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
// Note: method addToolBar only works in the smart client.

// create a window
var win = application.createWindow("myWindow", JSWindow.WINDOW);

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

// 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(win,"toolbar_1", 2);
toolbar1.addButton("click me 1", callback_function);

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

// 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(win,"toolbar_3", "toolbar_3_internal_name", 3);
toolbar3.addButton("click me 3", callback_function);

win.show(forms.Myform)
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idaddToolBar-String
Table Row (tr)
idname
Table Cell (td)

addToolBar

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
ToolBar
Span
stylefont-weight: bold;
addToolBar
Span
(name)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Add a toolbar.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} name - Table Row (tr)idsIdentjavascriptlastDetailRowaddToolBarname

addToolBar(name)

dessIndent
Add a toolbar.
prs

Parameters

sIndentnamethe name by which this toolbar is identified in code. If display name is missing, name will be used as displayName as well.
ret

Table Cell (td)

Returns

divsIndentclients

classid

Supported Clients

sIndent
ToolBar Table Row (tr)SmartClientsam

Table Cell (td)

Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idaddToolBar-String_Number
Table Row (tr)
idname
Table Cell (td)

addToolBar

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
ToolBar
Span
stylefont-weight: bold;
addToolBar
Span

Sample

Div
classsIndent
Code Block
languagejavascript
// 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);
idsIdentjavascriptlastDetailRowaddToolBarname

addToolBar(name, row)

Table Row (tr)des Table Cell (td) DivclassidsIndent
Add a toolbar.
Table Row (tr)prs

Table Cell (td)class

Parameters

DivsIndent{String} name - the name by which this toolbar is identified in code. If display name is missing, name will be used as displayName as well.
{Number} row - Table Row (tr)idthe row inside the toolbar panel where this toolbar is to be added.ret

Table Cell (td)

Returns

divsIndentclients

classid

Supported Clients

sIndent
ToolBar Table Row (tr)SmartClientsam

Table Cell (td)

Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idaddToolBar-String_String
Table Row (tr)
idname
Table Cell (td)

addToolBar

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
ToolBar
Span
stylefont-weight: bold;
addToolBar
Span

Sample

Div
classsIndent
Code Block
languagejavascript
// 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);
idsIdentjavascriptlastDetailRowaddToolBarname

addToolBar(name, displayname)

Table Row (tr)des Table Cell (td) DivclassidsIndent
Add a toolbar.
Table Row (tr)prs

Table Cell (td)class

Parameters

DivsIndent{String} name - the name by which this toolbar is identified in code. If display name is missing, name will be used as displayName as well.
{String} displayname - Table Row (tr)idthe name by which this toolbar will be identified in the UI. (for example in the toolbar panel's context menu)ret

Table Cell (td)

Returns

divsIndentclients

classid

Supported Clients

sIndent
ToolBar Table Row (tr)SmartClientsam

Table Cell (td)

Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idaddToolBar-String_String_Number
Table Row (tr)
idname
Table Cell (td)

addToolBar

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
ToolBar
Span
stylefont-weight: bold;
addToolBar
Span

Sample

Div
classsIndent
Code Block
languagejavascript
// 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);
idsIdentjavascriptlastDetailRowaddToolBarname

addToolBar(name, displayname, row)

Table Row (tr)des Table Cell (td) DivclassidsIndent
Add a toolbar.
Table Row (tr)prs

Table Cell (td)class

Parameters

DivsIndent{String} name - the name by which this toolbar is identified in code. If display name is missing, name will be used as displayName as well.
{String} displayname - the name by which this toolbar will be identified in the UI. (for example in the toolbar panel's context menu)
{Number} row - Table Row (tr)idthe row inside the toolbar panel where this toolbar is to be added.ret

Table Cell (td)

Returns

divsIndentclients

classid

Supported Clients

sIndent
ToolBar Table Row (tr)SmartClientsam

Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
// 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)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idcancelFormPopup
Table Row (tr)
idname
Table Cell (td)

cancelFormPopup

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
cancelFormPopup
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Close the current form popup panel without assigning a value to the configured data provider.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
// 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)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idcloseFormPopup-Object
Table Row (tr)
idname
Table Cell (td)

closeFormPopup

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
closeFormPopup
Span
(retval)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Close the current form popup panel and assign the value to the configured data provider.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Object} retval - return value for data provider
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
// 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)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idcreatePopupMenu
Table Row (tr)
idname
Table Cell (td)

createPopupMenu

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Popup
Span
stylefont-weight: bold;
createPopupMenu
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Creates a new popup menu that can be populated with items and displayed.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Popup
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
// 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)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idcreateShortcut-String_String
Table Row (tr)
idname
Table Cell (td)

createShortcut

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
createShortcut
Span
(shortcut, methodName)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Create a shortcut.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} shortcut
{String} methodName - Table Row (tr)idsIdentjavascriptlastDetailRowcancelFormPopupname

cancelFormPopup()

dessIndent
Close the current form popup panel without assigning a value to the configured data provider.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
closeFormPopupname

closeFormPopup(retval)

dessIndent
Close the current form popup panel and assign the value to the configured data provider.
prs

Parameters

sIndentretvalreturn value for data provider
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
createFormPopupname

createFormPopup(form)

dessIndent
Create a form popup that can be filled with data and shown.
prs

Parameters

sIndentformthe form to show
ret

Returns

sIndent
clients

Supported Clients

sIndentNGClient
sam

Sample

sIdentjavascript
lastDetailRow
createPopupMenuname

createPopupMenu()

dessIndent
Creates a new popup menu that can be populated with items and displayed.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
createShortcutname

createShortcut(shortcut, methodName)

dessIndent
Create a shortcut.
prs

Parameters

sIndentshortcut ;methodNamescopes.scopename.methodname or formname.methodname String to target the method to execute
ret

Table Cell (td)

Returns

divsIndentclients

classid

Supported Clients

sIndent
Boolean Table Row (tr)SmartClient,WebClient,NGClientsam

Table Cell (td)

Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idcreateShortcut-String_String_ObjectArray
Table Row (tr)
idname
Table Cell (td)

createShortcut

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
createShortcut
Span

Sample

Div
classsIndent
Code Block
languagejavascript
// 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.
idsIdentjavascriptlastDetailRowcreateShortcutname

createShortcut(shortcut, methodName, arguments)

Table Row (tr)des Table Cell (td) DivclassidsIndent
Create a shortcut.
Table Row (tr)prs

Table Cell (td)class

Parameters

DivsIndent{String} shortcut
{String} methodName - Table Row (tr)idshortcut ;methodNamescopes.scopename.methodname or formname.methodname String to target the method to execute
{Object[]} argumentsarguments ;ret

Table Cell (td)

Returns

divsIndentclients

classid

Supported Clients

sIndent
Boolean Table Row (tr)SmartClient,WebClient,NGClientsam

Table Cell (td)

Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idcreateShortcut-String_String_String
Table Row (tr)
idname
Table Cell (td)

createShortcut

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
createShortcut
Span

Sample

Div
classsIndent
Code Block
languagejavascript
// 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.
idsIdentjavascriptlastDetailRowcreateShortcutname

createShortcut(shortcut, methodName, contextFilter)

Table Row (tr)des Table Cell (td) DivclassidsIndent
Create a shortcut.
Table Row (tr)prs

Table Cell (td)class

Parameters

DivsIndent{String} shortcut
{String} methodName - shortcut ;methodNamescopes.scopename.methodname or formname.methodname String to target the method to execute
{String} contextFilter - contextFilterform or element name ( ng only - specified by formName.elementName); only triggers the shortcut when on this form Table Row (tr)id/elementret

Table Cell (td)

Returns

divsIndentclients

classid

Supported Clients

sIndent
Boolean Table Row (tr)SmartClient,WebClient,NGClientsam

Table Cell (td)

Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idcreateShortcut-String_String_String_ObjectArray
Table Row (tr)
idname
Table Cell (td)

createShortcut

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
createShortcut
Span

Sample

Div
classsIndent
Code Block
languagejavascript
// 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.
idsIdentjavascriptlastDetailRowcreateShortcutname

createShortcut(shortcut, method, contextFilter, arguments)

dessIndent
Create a shortcut.
prs

Parameters

sIndentshortcut ;methodthe method/function that needs to be called when the shortcut is hitcontextFilterform or element name ( ng only - specified by formName.elementName); only triggers the shortcut when on this form/elementarguments ;
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
createShortcutname

createShortcut(shortcut, methodName, contextFilter, arguments, consumeEvent)

Table Row (tr)des Table Cell (td) DivclassidsIndent
Create a shortcut.
Table Row (tr)prs

Table Cell (td)class

Parameters

DivsIndent{String} shortcut
{String} methodName - shortcut ;methodNamescopes.scopename.methodname or formname.methodname String to target the method to execute
{String} contextFilter - contextFilterform or element name ( ng only - specified by formName.elementName); only triggers the shortcut when on this form
{Object[]} arguments
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
// 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)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idcreateShortcut-String_Function
Table Row (tr)
idname
Table Cell (td)

createShortcut

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
createShortcut
Span
(shortcut, method)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Create a shortcut.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} shortcut
{Function} method - Table Row (tr)id/elementarguments ;consumeEventif true then the shotcut will consume the event and the default browser behavior will not be executed (default false)ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
createShortcutname

createShortcut(shortcut, method)

dessIndent
Create a shortcut.
prs

Parameters

sIndentshortcut ;methodthe method/function that needs to be called when the shortcut is hit
ret

Table Cell (td)

Returns

divsIndentclients

classid

Supported Clients

sIndent
Boolean Table Row (tr)SmartClient,WebClient,NGClientsam

Table Cell (td)

Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idcreateShortcut-String_Function_ObjectArray
Table Row (tr)
idname
Table Cell (td)

createShortcut

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
createShortcut
Span

Sample

Div
classsIndent
Code Block
languagejavascript
// 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.
idsIdentjavascriptlastDetailRowcreateShortcutname

createShortcut(shortcut, method, arguments)

Table Row (tr)des Table Cell (td) DivclassidsIndent
Create a shortcut.
Table Row (tr)prs

Table Cell (td)class

Parameters

DivsIndent{String} shortcut
{Function} method - Table Row (tr)idshortcut ;methodthe method/function that needs to be called when the shortcut is hit
{Object[]} argumentsarguments ;ret

Table Cell (td)

Returns

divsIndentclients

classid

Supported Clients

sIndent
Boolean Table Row (tr)SmartClient,WebClient,NGClientsam

Table Cell (td)

Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idcreateShortcut-String_Function_String
Table Row (tr)
idname
Table Cell (td)

createShortcut

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
createShortcut
Span

Sample

Div
classsIndent
Code Block
languagejavascript
// 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.
idsIdentjavascriptlastDetailRowcreateShortcutname

createShortcut(shortcut, method, contextFilter)

Table Row (tr)des Table Cell (td) DivclassidsIndent
Create a shortcut.
Table Row (tr)prs

Table Cell (td)class

Parameters

DivsIndent{String} shortcut
{Function} method - shortcut ;methodthe method/function that needs to be called when the shortcut is hit
{String} contextFilter - contextFilterform or element name ( ng only - specified by formName.elementName); only triggers the shortcut when on this form Table Row (tr)id/elementret

Table Cell (td)

Returns

divsIndentclients

classid

Supported Clients

sIndent
Boolean Table Row (tr)SmartClient,WebClient,NGClientsam

Table Cell (td)

Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idcreateShortcut-String_Function_String_ObjectArray
Table Row (tr)
idname
Table Cell (td)

createShortcut

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
createShortcut
Span

Sample

Div
classsIndent
Code Block
languagejavascript
// 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.
idsIdentjavascriptlastDetailRowcreateShortcutname

createShortcut(shortcut, method, contextFilter, arguments)

Table Row (tr)des Table Cell (td) DivclassidsIndent
Create a shortcut.
Table Row (tr)prs

Table Cell (td)class

Parameters

DivsIndent{String} shortcut
{Function} method - shortcut ;methodthe method/function that needs to be called when the shortcut is hit
{String} contextFilter - contextFilterform or element name ( ng only - specified by formName.elementName); only triggers the shortcut when on this form
{Object[]} arguments
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
// 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)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetMenuBar
Table Row (tr)
idname
Table Cell (td)

getMenuBar

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
MenuBar
Span
stylefont-weight: bold;
getMenuBar
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Get the menubar of the main window, or of a named window.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
MenuBar
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
// 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)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetMenuBar-String
Table Row (tr)
idname
Table Cell (td)

getMenuBar

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
MenuBar
Span
stylefont-weight: bold;
getMenuBar
Span
(windowName)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Get the menubar of the main window, or of a named window.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} windowName - the name of the window
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
MenuBar
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
// 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)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetToolBar-JSWindow_String
Table Row (tr)
idname
Table Cell (td)

getToolBar

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
ToolBar
Span
stylefont-weight: bold;
getToolBar
Span
(window, name)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Get the toolbar of a specific window from the toolbar panel by name.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{JSWindow} window
{String} name
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
ToolBar
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
// Note: method getToolBar only works in the smart client.

// create a window
	var win = application.createWindow("myWindow", JSWindow.WINDOW);
// the toolbar must first be created with a call to addToolbar
plugins.window.addToolBar(win,"toolbar_0");

// show the empty toolbar and wait 4 seconds
win.show(forms.MyForm)
application.updateUI(4000)

// get the toolbar at the panel by name
var toolbar = plugins.window.getToolBar(win,"toolbar_0");
// add a button to the toolbar
toolbar.addButton("button", callback_function);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetToolBar-String
Table Row (tr)
idname
Table Cell (td)

getToolBar

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
ToolBar
Span
stylefont-weight: bold;
getToolBar
Span
(name)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Get the toolbar from the toolbar panel by name.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} name
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
ToolBar
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
// Note: method getToolBar only works in the smart client.

// the toolbar must first be created 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)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetToolbarNames
Table Row (tr)
idname
Table Cell (td)

getToolbarNames

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String[]
Span
stylefont-weight: bold;
getToolbarNames
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Get all toolbar names from the toolbar panel.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String[]
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
// 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)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetToolbarNames-JSWindow
Table Row (tr)
idname
Table Cell (td)

getToolbarNames

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String[]
Span
stylefont-weight: bold;
getToolbarNames
Span
(window)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Get all toolbar names from the toolbar panel of a specific window.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{JSWindow} window
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String[]
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
// Note: method getToolbarNames only works in the smart client.
// create a window
	var win = application.createWindow("myWindow", JSWindow.WINDOW);
// the toolbar must first be created with a call to addToolbar
	 plugins.window.addToolBar(win,"toolbar_0");
  plugins.window.addToolBar(win,"toolbar_1");
// create an array of toolbar names
var names = plugins.window.getToolbarNames(win);

// 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)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idmaximize
Table Row (tr)
idname
Table Cell (td)

maximize

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
maximize
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Maximize the current window or the window with the specified name (Smart client only).
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
// 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)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idmaximize-String
Table Row (tr)
idname
Table Cell (td)

maximize

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
maximize
Span
(windowName)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Maximize the current window or the window with the specified name (Smart client only).
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} windowName
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
// 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)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idremoveShortcut-String
Table Row (tr)
idname
Table Cell (td)

removeShortcut

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
removeShortcut
Span
(shortcut)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Remove a shortcut.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} shortcut
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
// 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)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idremoveShortcut-String_String
Table Row (tr)
idname
Table Cell (td)

removeShortcut

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
removeShortcut
Span
(shortcut, contextFilter)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Remove a shortcut.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} shortcut
{String} contextFilter - only triggers the shortcut when on this form
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
// 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)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idremoveToolBar-JSWindow_String
Table Row (tr)
idname
Table Cell (td)

removeToolBar

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
removeToolBar
Span
(window, name)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Remove the toolbar from the toolbar panel of a specific window.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{JSWindow} window
{String} name
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
// Note: method removeToolBar only works in the smart client.
// create a window
	var win = application.createWindow("myWindow", JSWindow.WINDOW);
// the toolbar must first be created with a call to addToolbar
var toolbar = plugins.window.addToolBar(win,"toolbar_0");

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

// show the toolbar with the button and wait 4 seconds, then remove it
win.show(forms.MyForm)
application.updateUI(4000)

// 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(win,"toolbar_0");
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idremoveToolBar-String
Table Row (tr)
idname
Table Cell (td)

removeToolBar

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
removeToolBar
Span
(name)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Remove the toolbar from the toolbar panel.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} name
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
// Note: method removeToolBar only works in the smart client.

// the toolbar must first be created 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)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idsetFullScreen-Boolean
Table Row (tr)
idname
Table Cell (td)

setFullScreen

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
setFullScreen
Span
(full)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Bring the window into/out of fullsceen mode.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Boolean} full
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
// active fullscreen mode
plugins.window.setFullScreen(true);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idsetStatusBarVisible-Boolean
Table Row (tr)
idname
Table Cell (td)

setStatusBarVisible

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
setStatusBarVisible
Span
(visible)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Show or hide the statusbar.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Boolean} visible
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
// hide the statusbar
plugins.window.setStatusBarVisible(false);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idsetToolBarAreaVisible-Boolean
Table Row (tr)
idname
Table Cell (td)

setToolBarAreaVisible

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
setToolBarAreaVisible
Span
(visible)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Show or hide the toolbar area.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Boolean} visible
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
// hide the toolbar area
plugins.window.setToolBarAreaVisible(false);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idshowFormPopup-RuntimeComponent_RuntimeForm_Object_String
Table Row (tr)
idname
Table Cell (td)

showFormPopup

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
showFormPopup
Span
(elementToShowRelatedTo, form, scope, dataproviderID)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Show a form as popup panel, where the closeFormPopup can pass return a value to a dataprovider in the specified scope.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{RuntimeComponent} elementToShowRelatedTo - /elementarguments ;ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
createShortcutname

createShortcut(shortcut, method, contextFilter, arguments, consumeEvent)

dessIndent
Create a shortcut.
prs

Parameters

sIndentshortcut ;methodthe method/function that needs to be called when the shortcut is hitcontextFilterform or element name ( ng only - specified by formName.elementName); only triggers the shortcut when on this form/elementarguments ;consumeEventif true then the shotcut will consume the event and the default browser behavior will not be executed (default false)
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getMenuBarname

getMenuBar()

dessIndent
Get the menubar of the main window, or of a named window.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient
sam

Sample

sIdentjavascript
lastDetailRow
getMenuBarname

getMenuBar(windowName)

dessIndent
Get the menubar of the main window, or of a named window.
prs

Parameters

sIndentwindowNamethe name of the window
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient
sam

Sample

sIdentjavascript
lastDetailRow
getToolBarname

getToolBar(window, name)

dessIndent
Get the toolbar of a specific window from the toolbar panel by name.
prs

Parameters

sIndentwindow ;name ;
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient
sam

Sample

sIdentjavascript
lastDetailRow
getToolBarname

getToolBar(name)

dessIndent
Get the toolbar from the toolbar panel by name.
prs

Parameters

sIndentname ;
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient
sam

Sample

sIdentjavascript
lastDetailRow
getToolbarNamesname

getToolbarNames()

dessIndent
Get all toolbar names from the toolbar panel.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient
sam

Sample

sIdentjavascript
lastDetailRow
getToolbarNamesname

getToolbarNames(window)

dessIndent
Get all toolbar names from the toolbar panel of a specific window.
prs

Parameters

sIndentwindow ;
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient
sam

Sample

sIdentjavascript
lastDetailRow
maximizename

maximize()

dessIndent
Maximize the current window or the window with the specified name (Smart client only).
clients

Supported Clients

sIndentSmartClient
sam

Sample

sIdentjavascript
lastDetailRow
maximizename

maximize(windowName)

dessIndent
Maximize the current window or the window with the specified name (Smart client only).
prs

Parameters

sIndentwindowName ;
clients

Supported Clients

sIndentSmartClient
sam

Sample

sIdentjavascript
lastDetailRow
removeShortcutname

removeShortcut(shortcut)

dessIndent
Remove a shortcut.
prs

Parameters

sIndentshortcut ;
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
removeShortcutname

removeShortcut(shortcut, contextFilter)

dessIndent
Remove a shortcut.
prs

Parameters

sIndentshortcut ;contextFilterform or element name ( ng only - specified by formName.elementName); only triggers the shortcut when on this form/element
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
removeToolBarname

removeToolBar(window, name)

dessIndent
Remove the toolbar from the toolbar panel of a specific window.
prs

Parameters

sIndentwindow ;name ;
clients

Supported Clients

sIndentSmartClient
sam

Sample

sIdentjavascript
lastDetailRow
removeToolBarname

removeToolBar(name)

dessIndent
Remove the toolbar from the toolbar panel.
prs

Parameters

sIndentname ;
clients

Supported Clients

sIndentSmartClient
sam

Sample

sIdentjavascript
lastDetailRow
setFullScreenname

setFullScreen(full)

dessIndent
Bring the window into/out of fullsceen mode.
prs

Parameters

sIndentfull ;
clients

Supported Clients

sIndentSmartClient
sam

Sample

sIdentjavascript
lastDetailRow
setStatusBarVisiblename

setStatusBarVisible(visible)

dessIndent
Show or hide the statusbar.
prs

Parameters

sIndentvisible ;
clients

Supported Clients

sIndentSmartClient
sam

Sample

sIdentjavascript
lastDetailRow
setToolBarAreaVisiblename

setToolBarAreaVisible(visible)

dessIndent
Show or hide the toolbar area.
prs

Parameters

sIndentvisible ;
clients

Supported Clients

sIndentSmartClient
sam

Sample

sIdentjavascript
lastDetailRow
showFormPopupname

showFormPopup(elementToShowRelatedTo, form, scope, dataproviderID)

dessIndent
Show a form as popup panel, where the closeFormPopup can pass return a value to a dataprovider in the specified scope.
prs

Parameters

sIndentelementToShowRelatedToelement to show related to or null to center in screen

{RuntimeForm} form - the form to show
{Object} scope - the scope to put retval into
{String} dataproviderID -

Sample

Div
classsIndent
Code Block
languagejavascript
// the dataprovider of scope to fillclients

Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
showFormPopupname

showFormPopup(elementToShowRelatedTo, form, scope, dataproviderID, width, height)

dessIndent
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)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idshowFormPopup-RuntimeComponent_RuntimeForm_Object_String_Number_Number
Table Row (tr)
idname
Table Cell (td)

showFormPopup

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
showFormPopup
Spanid
prs

Parameters

sIndentelementToShowRelatedToelement to show related to or null to center in screenformthe form to showscopethe scope to put retval intodataproviderIDthe dataprovider of scope to fillwidthpopup widthheightpopup height
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRowshowFormPopupname

showFormPopup(elementToShowRelatedTo, form, scope, dataproviderID, width, height, x, y)

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

Parameters

Div
classsIndent
{RuntimeComponent} elementToShowRelatedTo -
 Can show relative to a component or at specified coordinates.
Show on specified location is only supported in NGClient.
prs

Parameters

sIndentelementToShowRelatedToelement to show related to or null to center in screen

{RuntimeForm} form - the form to show
{Object} scope - the scope to put retval into
{String} dataproviderID - the dataprovider of scope to fill
{Number} width - popup width
{Number} height -

Sample

Div
classsIndent
Code Block
languagejavascript
// popup height
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)xpopup x locationypopup y locationclients

Supported Clients

sIndentNGClient
sam

Sample

sIdentjavascript
lastDetailRow
showFormPopupname

showFormPopup(elementToShowRelatedTo, form, scope, dataproviderID, width, height, x, y, showBackdrop)

dessIndent
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)
classlastDetailRow
Table Cell (td)
 
Can show relative to a component or at specified coordinates.
Show on specified location and backdrop is only supported in NGClient.
prs

Parameters

sIndentelementToShowRelatedToelement to show related to or null to center in screenformthe form to showscopethe scope to put retval intodataproviderIDthe dataprovider of scope to fillwidthpopup width