Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

<!--
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 SOURC-->

Unknown macro: {table}
Unknown macro: {tr}
Unknown macro: {th}

Return Types

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

CheckBox

Unknown macro: {span}

Menu

Unknown macro: {span}

MenuBar

Unknown macro: {span}

MenuItem

Unknown macro: {span}

Popup

Unknown macro: {span}

RadioButton

Unknown macro: {span}

ToolBar


Unknown macro: {table}

{column:padding=0px|width=80px}{column}{column}{column}

Unknown macro: {tr}
Unknown macro: {th}

Method Summery

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

ToolBar

Unknown macro: {td}

addToolBar(name, [displayname], [row])
Add a toolbar by name and optional displayname and row.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Popup

Unknown macro: {td}

createPopupMenu()

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

createShortcut(shortcut, method, [form_name])
Create a shortcut.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

MenuBar

Unknown macro: {td}

getMenuBar([windowName])
Get the menubar of a window.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

ToolBar

Unknown macro: {td}

getToolBar(name)
Get the toolbar from the toolbar panel by name.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String[]

Unknown macro: {td}

getToolbarNames()
Get all toolbar names from the toolbar panel.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

removeShortcut(shortcut, [form_name])
Remove a shortcut.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

void

Unknown macro: {td}

removeToolBar(name)
Remove the toolbar from the toolbar panel.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

void

Unknown macro: {td}

setFullScreen()

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

void

Unknown macro: {td}

setStatusBarVisible()

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

void

Unknown macro: {td}

setToolBarVisible()


Unknown macro: {table}

{column:padding=0px|width=100%}{column}

Unknown macro: {tr}
Unknown macro: {th}

Method Details

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
addToolBar
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

ToolBar

Unknown macro: {span}

addToolBar

Unknown macro: {span}

(name, [displayname], [row])

Unknown macro: {tr}
Unknown macro: {td}

Add a toolbar by name and optional displayname and row.

Unknown macro: {tr}
Unknown macro: {td}

Since
Replace with version info

Unknown macro: {tr}
Unknown macro: {td}

Parameters
name
[displayname]
[row]

Unknown macro: {tr}
Unknown macro: {td}

Returns
[ToolBar]

Unknown macro: {tr}
Unknown macro: {td}

Also see

Unknown macro: {div}
Unknown macro: {tr}
Unknown macro: {td}

External links

Unknown macro: {div}
Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// Note: method addToolBar only works in the smart client.

// Add a toolbar by name and optional displayname and row.
// add a toolbar with only a name
var toolbar = plugins.window.addToolBar("toolbar_0");

// add a toolbar with a name and internal name
// var toolbar = plugins.window.addToolBar("toolbar_1", "toolbar_1");

// add a toolbar with a name, internal name and the row you want the
// toolbar to show at. rownumber starts at 0 
// var toolbar = plugins.window.addToolBar("toolbar_2", "toolbar_2", 3);

// REMARK: normally you would add buttons, checkboxes etc in the same method
// this example will show no buttons for now!
// we will add them via the other methods on this form.
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
createPopupMenu
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Popup

Unknown macro: {span}

createPopupMenu

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}

Replace with description

Unknown macro: {tr}
Unknown macro: {td}

Since
Replace with version info

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {tr}
Unknown macro: {td}

Returns
[Popup]

Unknown macro: {tr}
Unknown macro: {td}

Also see

Unknown macro: {div}
Unknown macro: {tr}
Unknown macro: {td}

External links

Unknown macro: {div}
Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var popupmenu = plugins.window.createPopupMenu()

var menuitem1 = popupmenu.addMenuItem('A',myMethod)
var menuitem2 = popupmenu.addRadioButton('B',myMethod)
var menuitem3 = popupmenu.addRadioButton('C',myMethod)
var menuitem4 = popupmenu.addSeparator()
var menuitem5 = popupmenu.addMenuItem('<html><b>Hello</b></html>',myMethod)
var menuitem6 = popupmenu.addMenuItem('G', globals.myGlobalMethod)

var submenu = popupmenu.addMenu('SubMenu')
var subitem1 = submenu.addCheckBox('i18n:bla_bla',myMethod)
var subitem2 = submenu.addCheckBox('he' , globals.myOtherGlobalMethod , 'media:///day_obj.gif')
var subitem3 = submenu.addCheckBox('more' , globals.myOtherGlobalMethod ,null, 'm') //last parameter is mnemonic-key

menuitem2.setSelected(true);
menuitem6.setEnabled(false)
subitem2.setSelected(true);

var source = event.getSource()
if (source != null)
{
	popupmenu.show(source);
	//or you can set the coordinates popupmenu.show(10, 10);
}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
createShortcut
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

createShortcut

Unknown macro: {span}

(shortcut, method, [form_name])

Unknown macro: {tr}
Unknown macro: {td}

Create a shortcut.

Unknown macro: {tr}
Unknown macro: {td}

Since
Replace with version info

Unknown macro: {tr}
Unknown macro: {td}

Parameters
shortcut
method
[form_name]

Unknown macro: {tr}
Unknown macro: {td}

Returns
[Boolean]

Unknown macro: {tr}
Unknown macro: {td}

Also see

Unknown macro: {div}
Unknown macro: {tr}
Unknown macro: {td}

External links

Unknown macro: {div}
Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// Create a shortcut.
// 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 shortcut (on all forms) on  'apple 1' on a mac client and 'control 1' on other client platforms
plugins.window.createShortcut('menu 1', 'globals.handleShortcut');
// global handler, only triggered when on form frm_orders
plugins.window.createShortcut('control shift I', globals.handleOrdersShortcut, 'frm_orders');
// form method called when shortcut is used
plugins.window.createShortcut('control LEFT', 'frm_products.handleShortcut', 'frm_products');
// same, but use method in stead of string
plugins.window.createShortcut('control RIGHT', forms.frm_contacts.handleMyShortcut, 'frm_contacts');

// remove global shortcut and form-level shortcut
plugins.window.createShortcut('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.
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getMenuBar
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

MenuBar

Unknown macro: {span}

getMenuBar

Unknown macro: {span}

([windowName])

Unknown macro: {tr}
Unknown macro: {td}

Get the menubar of a window.

Unknown macro: {tr}
Unknown macro: {td}

Since
Replace with version info

Unknown macro: {tr}
Unknown macro: {td}

Parameters\\\[windowName]

Unknown macro: {tr}
Unknown macro: {td}

Returns
[MenuBar]

Unknown macro: {tr}
Unknown macro: {td}

Also see

Unknown macro: {div}
Unknown macro: {tr}
Unknown macro: {td}

External links

Unknown macro: {div}
Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// Get the menubar of a window.
// get the menubar of the main window
var mainMenubar = plugins.window.getMenuBar();

// get the menubar of a named window
application.showFormInWindow(forms.contacts,100,80,500,300,'my own window title',false,true,'mywindow');
var myWindowMenubar = plugins.window.getMenuBar('mywindow');
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getToolBar
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

ToolBar

Unknown macro: {span}

getToolBar

Unknown macro: {span}

(name)

Unknown macro: {tr}
Unknown macro: {td}

Get the toolbar from the toolbar panel by name.

Unknown macro: {tr}
Unknown macro: {td}

Since
Replace with version info

Unknown macro: {tr}
Unknown macro: {td}

Parameters
name

Unknown macro: {tr}
Unknown macro: {td}

Returns
[ToolBar]

Unknown macro: {tr}
Unknown macro: {td}

Also see

Unknown macro: {div}
Unknown macro: {tr}
Unknown macro: {td}

External links

Unknown macro: {div}
Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// Note: method getToolBar only works in the smart client.

// Get the toolbar from the toolbar panel by name.
// get the toolbar at the panel by name
var toolbar = plugins.window.getToolBar("toolbar_0");

// add a button with a text and a method
toolbar.addButton("button", feedback_button);

// add an input array to the button for feedback in the selected method
toolbar.addButton("button", feedback_button, [1, "2", "three"]);

// add an icon to the button
toolbar.addButton("button", feedback_button, [1, "2", "three"], "media:///yourimage.gif");

// add a tooltip to the button
toolbar.addButton("button", feedback_button, [1, "2", "three"], "media:///yourimage.gif", "tooltip.");

// show only an icon on the button and disable the button
toolbar.addButton(null, feedback_button, [1, "2", "three"], "media:///yourimage.gif", "tooltip.", false);

// add a separator
toolbar.addSeparator();

// make the button non visible
toolbar.addButton(null, feedback_button, [1, "2", "three"], "media:///yourimage.gif", "tooltip.",true, false);

// and validate the changes
// to make them know to the user interface)
toolbar.validate();
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getToolbarNames
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

String[]

Unknown macro: {span}

getToolbarNames

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}

Get all toolbar names from the toolbar panel.

Unknown macro: {tr}
Unknown macro: {td}

Since
Replace with version info

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {tr}
Unknown macro: {td}

Returns
[String][]

Unknown macro: {tr}
Unknown macro: {td}

Also see

Unknown macro: {div}
Unknown macro: {tr}
Unknown macro: {td}

External links

Unknown macro: {div}
Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// Note: method getToolbarNames only works in the smart client.

// Get all toolbar names from the toolbar panel.
// 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);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
removeShortcut
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

removeShortcut

Unknown macro: {span}

(shortcut, [form_name])

Unknown macro: {tr}
Unknown macro: {td}

Remove a shortcut.

Unknown macro: {tr}
Unknown macro: {td}

Since
Replace with version info

Unknown macro: {tr}
Unknown macro: {td}

Parameters
shortcut
[form_name]

Unknown macro: {tr}
Unknown macro: {td}

Returns
[Boolean]

Unknown macro: {tr}
Unknown macro: {td}

Also see

Unknown macro: {div}
Unknown macro: {tr}
Unknown macro: {td}

External links

Unknown macro: {div}
Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// Remove a shortcut.
// 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 shortcut (on all forms) on  'apple 1' on a mac client and 'control 1' on other client platforms
plugins.window.createShortcut('menu 1', 'globals.handleShortcut');
// global handler, only triggered when on form frm_orders
plugins.window.createShortcut('control shift I', globals.handleOrdersShortcut, 'frm_orders');
// form method called when shortcut is used
plugins.window.createShortcut('control LEFT', 'frm_products.handleShortcut', 'frm_products');
// same, but use method in stead of string
plugins.window.createShortcut('control RIGHT', forms.frm_contacts.handleMyShortcut, 'frm_contacts');

// remove global shortcut and form-level shortcut
plugins.window.createShortcut('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.
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
removeToolBar
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

void

Unknown macro: {span}

removeToolBar

Unknown macro: {span}

(name)

Unknown macro: {tr}
Unknown macro: {td}

Remove the toolbar from the toolbar panel.

Unknown macro: {tr}
Unknown macro: {td}

Since
Replace with version info

Unknown macro: {tr}
Unknown macro: {td}

Parameters
name

Unknown macro: {tr}
Unknown macro: {td}

Returns
void

Unknown macro: {tr}
Unknown macro: {td}

Also see

Unknown macro: {div}
Unknown macro: {tr}
Unknown macro: {td}

External links

Unknown macro: {div}
Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// Note: method removeToolBar only works in the smart client.

// Remove the toolbar from the toolbar panel.
// 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");
plugins.window.removeToolBar("toolbar_1");
plugins.window.removeToolBar("toolbar_2");
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
setFullScreen
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

void

Unknown macro: {span}

setFullScreen

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}

Replace with description

Unknown macro: {tr}
Unknown macro: {td}

Since
Replace with version info

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {tr}
Unknown macro: {td}

Returns
void

Unknown macro: {tr}
Unknown macro: {td}

Also see

Unknown macro: {div}
Unknown macro: {tr}
Unknown macro: {td}

External links

Unknown macro: {div}
Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
plugins.window.setFullScreen(true)
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
setStatusBarVisible
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

void

Unknown macro: {span}

setStatusBarVisible

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}

Replace with description

Unknown macro: {tr}
Unknown macro: {td}

Since
Replace with version info

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {tr}
Unknown macro: {td}

Returns
void

Unknown macro: {tr}
Unknown macro: {td}

Also see

Unknown macro: {div}
Unknown macro: {tr}
Unknown macro: {td}

External links

Unknown macro: {div}
Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
plugins.window.setStatusBarVisible()
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
setToolBarVisible
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

void

Unknown macro: {span}

setToolBarVisible

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}

Replace with description

Unknown macro: {tr}
Unknown macro: {td}

Since
Replace with version info

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {tr}
Unknown macro: {td}

Returns
void

Unknown macro: {tr}
Unknown macro: {td}

Also see

Unknown macro: {div}
Unknown macro: {tr}
Unknown macro: {td}

External links

Unknown macro: {div}
Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
plugins.window.setToolBarVisible(false)
Unknown macro: {tr}
Unknown macro: {td}
  • No labels