Page History

...

style	display:none

...

id	description

...

padding	0px
width	80px

...

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Constants Summary

...

Table Cell (td)
Number

...

Cache

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

servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClientsWordListNGClient

servoy sSummary12%30%58%height: 30px;3Constants SummaryConstant for centering menu items/checkbox/radiobuttons at creation.

...

Table Cell (td)
Number

...

Table Cell (td)
Number

...

Constant for left aligning menu items/checkbox/radiobuttons at creation.

...

Constant for right aligning menu items/checkbox/radiobuttons at creation.

...

padding	0px
width	80px

...

servoy sSummary

12%

30%

58%

height: 30px;

...

Table Head (th)

colspan	2

Property Summary

...

Table Cell (td)
Boolean

...

Table Cell (td)
Object[]

...

3

Property Summary

Enable/disable the menu item/checkbox/radiobutton.

...

Set arguments that are sent to the callback method.

...

Table Cell (td)
String

...

Table Cell (td)
Boolean

...

The name of the menu item/checkbox/radiobutton.

...

Select/unselect the checkbox/radiobutton.

...

Table Cell (td)
String

...

padding	0px
width	80px

...

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Method Summary

...

Table Cell (td)
void

...

Get/set the text of the menu item/checkbox/radiobutton.

...

servoy sSummary12%30%58%height: 30px;3Methods SummaryvoidScript the selection (emulate a mouse click) of the item.

...

Table Cell (td)
Object

...

Gets the specified client property for the menu item/checkbox/radiobutton based on a key.

...

void

...

Sets the value for the specified client property key of the menu item/checkbox/radiobutton.

...

Table Cell (td)
MenuItem

...

Set the accelerator key of the menu item/checkbox/radiobutton.

...

void

...

Set the background color of the menu item/checkbox/radiobutton.

...

void

...

Set the foreground color

...

Table Cell (td)
MenuItem

...

of the menu item

...

Table Row (tr)

Table Cell (td)
MenuItem

Table Cell (td)
setMethod(method) Set the method for the menu item/checkbox/radiobutton.

Table Row (tr)

Table Cell (td)
MenuItem

Table Cell (td)
setMethod(method, arguments) Set the method for the menu item/checkbox/radiobutton.

Table Row (tr)

Table Cell (td)
MenuItem

Table Cell (td)
setMnemonic() Set the mnemonic key of the menu item/checkbox/radiobutton.

Table Row (tr)

Table Cell (td)
MenuItem

Table Cell (td)
setVisible(visible) Set the item visible.

...

id	constant
class	servoy sDetail

...

padding	0px
width	100%

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	1

Constants Details

...

id	ALIGN_CENTER

Table Row (tr)

id	name

Table Cell (td)
ALIGN_CENTER

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Constant for centering menu items/checkbox/radiobuttons at creation.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// add a new menu to the menubar
var menubar = plugins.window.getMenuBar();
var menu = menubar.addMenu();
menu.text = "New Menu";
// alternatively create a popup menu
//var menu = plugins.window.createPopupMenu();

// add a left aligned menu item
menu.addMenuItem("significantly long text", feedback, null, null, true, MenuItem.ALIGN_LEFT);
// add a centered checkbox
menu.addCheckBox("a bit shorter", feedback, null, null, true, MenuItem.ALIGN_CENTER);
// add a right aligned radiobutton
menu.addRadioButton("short", feedback, null, null, true, MenuItem.ALIGN_RIGHT);

...

class	lastDetailRow

...

id	ALIGN_LEFT

Table Row (tr)

id	name

Table Cell (td)
ALIGN_LEFT

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Constant for left aligning menu items/checkbox/radiobuttons at creation.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// add a new menu to the menubar
var menubar = plugins.window.getMenuBar();
var menu = menubar.addMenu();
menu.text = "New Menu";
// alternatively create a popup menu
//var menu = plugins.window.createPopupMenu();

// add a left aligned menu item
menu.addMenuItem("significantly long text", feedback, null, null, true, MenuItem.ALIGN_LEFT);
// add a centered checkbox
menu.addCheckBox("a bit shorter", feedback, null, null, true, MenuItem.ALIGN_CENTER);
// add a right aligned radiobutton
menu.addRadioButton("short", feedback, null, null, true, MenuItem.ALIGN_RIGHT);

...

class	lastDetailRow

...

id	ALIGN_RIGHT

Table Row (tr)

id	name

Table Cell (td)
ALIGN_RIGHT

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Constant for right aligning menu items/checkbox/radiobuttons at creation.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// add a new menu to the menubar
var menubar = plugins.window.getMenuBar();
var menu = menubar.addMenu();
menu.text = "New Menu";
// alternatively create a popup menu
//var menu = plugins.window.createPopupMenu();

// add a left aligned menu item
menu.addMenuItem("significantly long text", feedback, null, null, true, MenuItem.ALIGN_LEFT);
// add a centered checkbox
menu.addCheckBox("a bit shorter", feedback, null, null, true, MenuItem.ALIGN_CENTER);
// add a right aligned radiobutton
menu.addRadioButton("short", feedback, null, null, true, MenuItem.ALIGN_RIGHT);

...

class	lastDetailRow

...

id	property
class	servoy sDetail

...

padding	0px
width	100%

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	1

Property Details

...

id	enabled

Table Row (tr)

id	name

Table Cell (td)
enabled

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Enable/disable the menu item/checkbox/radiobutton.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// add a new menu to the menubar
var menubar = plugins.window.getMenuBar();
var menu = menubar.addMenu();
menu.text = "New Menu";
// alternatively create a popup menu
//var menu = plugins.window.createPopupMenu();

// add a menu item at the first position in the menu
var entry = menu.addMenuItem(0);
// alternatively add a checkbox at the first position
//var entry = menu.addCheckBox(0);
// or alternatively add a radiobutton at the first position
//var entry = menu.addRadioButton(0);

// disable the newly added entry
entry.enabled = false;
// give a name to the entry (the name is not visible anywhere)
entry.name = "my_name";
// make the entry selected (affects checkboxes and radiobuttons)
entry.selected = true;
// set the text of the entry
entry.text = "menu entry";
// set the callback method
entry.setMethod(feedback);
// set the arguments to be sent to the callback method
// (an array of elements which will be passed as arguments 5, 6 and so on to the callback method)
// the first 5 arguments are fixed:
//	[0] item index
//	[1] parent item index
//	[2] isSelected boolean
//	[3] parent menu text
//	[4] menu text
entry.methodArguments = [17, "data"];

...

class	lastDetailRow

...

id	methodArguments

Table Row (tr)

id	name

Table Cell (td)
methodArguments

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Set arguments that are sent to the callback method.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Object[]

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// add a new menu to the menubar
var menubar = plugins.window.getMenuBar();
var menu = menubar.addMenu();
menu.text = "New Menu";
// alternatively create a popup menu
//var menu = plugins.window.createPopupMenu();

// add a menu item at the first position in the menu
var entry = menu.addMenuItem(0);
// alternatively add a checkbox at the first position
//var entry = menu.addCheckBox(0);
// or alternatively add a radiobutton at the first position
//var entry = menu.addRadioButton(0);

// disable the newly added entry
entry.enabled = false;
// give a name to the entry (the name is not visible anywhere)
entry.name = "my_name";
// make the entry selected (affects checkboxes and radiobuttons)
entry.selected = true;
// set the text of the entry
entry.text = "menu entry";
// set the callback method
entry.setMethod(feedback);
// set the arguments to be sent to the callback method
// (an array of elements which will be passed as arguments 5, 6 and so on to the callback method)
// the first 5 arguments are fixed:
//	[0] item index
//	[1] parent item index
//	[2] isSelected boolean
//	[3] parent menu text
//	[4] menu text
entry.methodArguments = [17, "data"];

...

class	lastDetailRow

...

id	name

Table Row (tr)

id	name

Table Cell (td)
name

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The name of the menu item/checkbox/radiobutton. The name is used only internally, it is not
visible in the user interface.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// add a new menu to the menubar
var menubar = plugins.window.getMenuBar();
var menu = menubar.addMenu();
menu.text = "New Menu";
// alternatively create a popup menu
//var menu = plugins.window.createPopupMenu();

// add a menu item at the first position in the menu
var entry = menu.addMenuItem(0);
// alternatively add a checkbox at the first position
//var entry = menu.addCheckBox(0);
// or alternatively add a radiobutton at the first position
//var entry = menu.addRadioButton(0);

// disable the newly added entry
entry.enabled = false;
// give a name to the entry (the name is not visible anywhere)
entry.name = "my_name";
// make the entry selected (affects checkboxes and radiobuttons)
entry.selected = true;
// set the text of the entry
entry.text = "menu entry";
// set the callback method
entry.setMethod(feedback);
// set the arguments to be sent to the callback method
// (an array of elements which will be passed as arguments 5, 6 and so on to the callback method)
// the first 5 arguments are fixed:
//	[0] item index
//	[1] parent item index
//	[2] isSelected boolean
//	[3] parent menu text
//	[4] menu text
entry.methodArguments = [17, "data"];

...

class	lastDetailRow

...

id	selected

Table Row (tr)

id	name

Table Cell (td)
selected

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Select/unselect the checkbox/radiobutton.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// add a new menu to the menubar
var menubar = plugins.window.getMenuBar();
var menu = menubar.addMenu();
menu.text = "New Menu";
// alternatively create a popup menu
//var menu = plugins.window.createPopupMenu();

// add a menu item at the first position in the menu
var entry = menu.addMenuItem(0);
// alternatively add a checkbox at the first position
//var entry = menu.addCheckBox(0);
// or alternatively add a radiobutton at the first position
//var entry = menu.addRadioButton(0);

// disable the newly added entry
entry.enabled = false;
// give a name to the entry (the name is not visible anywhere)
entry.name = "my_name";
// make the entry selected (affects checkboxes and radiobuttons)
entry.selected = true;
// set the text of the entry
entry.text = "menu entry";
// set the callback method
entry.setMethod(feedback);
// set the arguments to be sent to the callback method
// (an array of elements which will be passed as arguments 5, 6 and so on to the callback method)
// the first 5 arguments are fixed:
//	[0] item index
//	[1] parent item index
//	[2] isSelected boolean
//	[3] parent menu text
//	[4] menu text
entry.methodArguments = [17, "data"];

...

class	lastDetailRow

...

id	text

Table Row (tr)

id	name

Table Cell (td)
text

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Get/set the text of the menu item/checkbox/radiobutton.; This can be also html if enclosed between html tags

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// add a new menu to the menubar
var menubar = plugins.window.getMenuBar();
var menu = menubar.addMenu();
menu.text = "New Menu";
// alternatively create a popup menu
//var menu = plugins.window.createPopupMenu();

// add a menu item at the first position in the menu
var entry = menu.addMenuItem(0);
// alternatively add a checkbox at the first position
//var entry = menu.addCheckBox(0);
// or alternatively add a radiobutton at the first position
//var entry = menu.addRadioButton(0);

// disable the newly added entry
entry.enabled = false;
// give a name to the entry (the name is not visible anywhere)
entry.name = "my_name";
// make the entry selected (affects checkboxes and radiobuttons)
entry.selected = true;
// set the text of the entry
entry.text = "menu entry";
// set the callback method
entry.setMethod(feedback);
// set the arguments to be sent to the callback method
// (an array of elements which will be passed as arguments 5, 6 and so on to the callback method)
// the first 5 arguments are fixed:
//	[0] item index
//	[1] parent item index
//	[2] isSelected boolean
//	[3] parent menu text
//	[4] menu text
entry.methodArguments = [17, "data"];

...

class	lastDetailRow

...

id	function
class	servoy sDetail

...

padding	0px
width	100%

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	1

Method Details

...

id	doClick

Table Row (tr)

id	name

Table Cell (td)
doClick

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

doClick

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Script the selection (emulate a mouse click) of the item.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// add a new menu to the menubar
var menubar = plugins.window.getMenuBar();
var menu = menubar.addMenu();
menu.text = "New Menu";
// alternatively create a popup menu
//var menu = plugins.window.createPopupMenu();

// add a menu item
var entry = menu.addMenuItem("menu entry", feedback);
// alternatively add a checkbox
//var entry = menu.addCheckBox("menu entry", feedback);
// or alternatively add a radiobutton
//var entry = menu.addRadioButton("menu entry", feedback);

// simulate a click on the entry
entry.doClick();

...

class	lastDetailRow

...

id	getClientProperty-Object

Table Row (tr)

id	name

Table Cell (td)
getClientProperty

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Object

Span

style	font-weight: bold;

getClientProperty

Span
(key)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Gets the specified client property for the menu item/checkbox/radiobutton based on a key.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Object} key

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Object

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// add a new menu to the menubar
var menubar = plugins.window.getMenuBar();
var menu = menubar.addMenu();
menu.text = "New Menu";
// alternatively create a popup menu
//var menu = plugins.window.createPopupMenu();

// add a menu item
var entry = menu.addMenuItem("menu entry", feedback);
// alternatively add a checkbox
//var entry = menu.addCheckBox("menu entry", feedback);
// or alternatively add a radiobutton
//var entry = menu.addRadioButton("menu entry", feedback);

// NOTE: Depending on the operating system, a user interface property name may be available.
// set the tooltip of the menu item/checkbox/radiobutton via client properties
// keep the original tooltip in a form or global variable
originalTooltip = entry.getClientProperty("ToolTipText");
entry.putClientProperty("ToolTipText", "changed tooltip");

// later restore the original tooltip from the variable
//var menubar = plugins.window.getMenuBar();
//var menuIndex = menubar.getMenuIndexByText("New Menu");
//var menu = menubar.getMenu(menuIndex);
//var entry = menu.getItem(0);
//entry.putClientProperty("ToolTipText", originalTooltip);

...

class	lastDetailRow

...

id	putClientProperty-Object_Object

Table Row (tr)

id	name

Table Cell (td)
putClientProperty

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

putClientProperty

Span
(key, value)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Sets the value for the specified client property key of the menu item/checkbox/radiobutton.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Object} key
{Object} value

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// add a new menu to the menubar
var menubar = plugins.window.getMenuBar();
var menu = menubar.addMenu();
menu.text = "New Menu";
// alternatively create a popup menu
//var menu = plugins.window.createPopupMenu();

// add a menu item
var entry = menu.addMenuItem("menu entry", feedback);
// alternatively add a checkbox
//var entry = menu.addCheckBox("menu entry", feedback);
// or alternatively add a radiobutton
//var entry = menu.addRadioButton("menu entry", feedback);

// NOTE: Depending on the operating system, a user interface property name may be available.
// set the tooltip of the menu item/checkbox/radiobutton via client properties
// keep the original tooltip in a form or global variable
originalTooltip = entry.getClientProperty("ToolTipText");
entry.putClientProperty("ToolTipText", "changed tooltip");

// later restore the original tooltip from the variable
//var menubar = plugins.window.getMenuBar();
//var menuIndex = menubar.getMenuIndexByText("New Menu");
//var menu = menubar.getMenu(menuIndex);
//var entry = menu.getItem(0);
//entry.putClientProperty("ToolTipText", originalTooltip);

...

class	lastDetailRow

...

id	setAccelerator

Table Row (tr)

id	name

Table Cell (td)
setAccelerator

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

MenuItem

Span

style	font-weight: bold;

setAccelerator

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Set the accelerator key of the menu item/checkbox/radiobutton.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

MenuItem

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// add a new menu to the menubar
var menubar = plugins.window.getMenuBar();
var menu = menubar.addMenu();
menu.text = "New Menu";
// alternatively create a popup menu
//var menu = plugins.window.createPopupMenu();

// add a menu item
var entry = menu.addMenuItem("menu entry", feedback);
// alternatively add a checkbox
//var entry = menu.addCheckBox("menu entry", feedback);
// or alternatively add a radiobutton
//var entry = menu.addRadioButton("menu entry", feedback);

// define an accelerator for the menu entry
entry.setAccelerator("ctrl alt Y");
// also define a mnemonic
entry.setMnemonic("y");
// set a custom background color
entry.setBackgroundColor("#111111");
// set a custom foreground color
entry.setForegroundColor("#EE5555");
// set an icon
entry.setIcon("media:///yourimage.gif");

...

class	lastDetailRow

...

id	setBackgroundColor

Table Row (tr)

id	name

Table Cell (td)
setBackgroundColor

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

setBackgroundColor

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Set the background color of the menu item/checkbox/radiobutton.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// add a new menu to the menubar
var menubar = plugins.window.getMenuBar();
var menu = menubar.addMenu();
menu.text = "New Menu";
// alternatively create a popup menu
//var menu = plugins.window.createPopupMenu();

// add a menu item
var entry = menu.addMenuItem("menu entry", feedback);
// alternatively add a checkbox
//var entry = menu.addCheckBox("menu entry", feedback);
// or alternatively add a radiobutton
//var entry = menu.addRadioButton("menu entry", feedback);

// define an accelerator for the menu entry
entry.setAccelerator("ctrl alt Y");
// also define a mnemonic
entry.setMnemonic("y");
// set a custom background color
entry.setBackgroundColor("#111111");
// set a custom foreground color
entry.setForegroundColor("#EE5555");
// set an icon
entry.setIcon("media:///yourimage.gif");

...

class	lastDetailRow

...

id	setForegroundColor

Table Row (tr)

id	name

Table Cell (td)
setForegroundColor

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

setForegroundColor

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Set the foreground color of the menu item/checkbox/radiobutton.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// add a new menu to the menubar
var menubar = plugins.window.getMenuBar();
var menu = menubar.addMenu();
menu.text = "New Menu";
// alternatively create a popup menu
//var menu = plugins.window.createPopupMenu();

// add a menu item
var entry = menu.addMenuItem("menu entry", feedback);
// alternatively add a checkbox
//var entry = menu.addCheckBox("menu entry", feedback);
// or alternatively add a radiobutton
//var entry = menu.addRadioButton("menu entry", feedback);

// define an accelerator for the menu entry
entry.setAccelerator("ctrl alt Y");
// also define a mnemonic
entry.setMnemonic("y");
// set a custom background color
entry.setBackgroundColor("#111111");
// set a custom foreground color
entry.setForegroundColor("#EE5555");
// set an icon
entry.setIcon("media:///yourimage.gif");

...

class	lastDetailRow

...

id	setIcon

Table Row (tr)

id	name

Table Cell (td)
setIcon

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

MenuItem

Span

style	font-weight: bold;

setIcon

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Set the icon of the menu item/checkbox/radiobutton.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

MenuItem

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// add a new menu to the menubar
var menubar = plugins.window.getMenuBar();
var menu = menubar.addMenu();
menu.text = "New Menu";
// alternatively create a popup menu
//var menu = plugins.window.createPopupMenu();

// add a menu item
var entry = menu.addMenuItem("menu entry", feedback);
// alternatively add a checkbox
//var entry = menu.addCheckBox("menu entry", feedback);
// or alternatively add a radiobutton
//var entry = menu.addRadioButton("menu entry", feedback);

// define an accelerator for the menu entry
entry.setAccelerator("ctrl alt Y");
// also define a mnemonic
entry.setMnemonic("y");
// set a custom background color
entry.setBackgroundColor("#111111");
// set a custom foreground color
entry.setForegroundColor("#EE5555");
// set an icon
entry.setIcon("media:///yourimage.gif");

...

class	lastDetailRow

...

id	setMethod-Function

Table Row (tr)

id	name

Table Cell (td)
setMethod

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

MenuItem

Span

style	font-weight: bold;

setMethod

Span
(method)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Set the method for the menu item/checkbox/radiobutton.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Function} method

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

MenuItem

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// add a new menu to the menubar
var menubar = plugins.window.getMenuBar();
var menu = menubar.addMenu();
menu.text = "New Menu";
// alternatively create a popup menu
//var menu = plugins.window.createPopupMenu();

// add a menu item at the first position in the menu
var entry = menu.addMenuItem(0);
// alternatively add a checkbox at the first position
//var entry = menu.addCheckBox(0);
// or alternatively add a radiobutton at the first position
//var entry = menu.addRadioButton(0);

// disable the newly added entry
entry.enabled = false;
// give a name to the entry (the name is not visible anywhere)
entry.name = "my_name";
// make the entry selected (affects checkboxes and radiobuttons)
entry.selected = true;
// set the text of the entry
entry.text = "menu entry";
// set the callback method
entry.setMethod(feedback);
// set the arguments to be sent to the callback method
// (an array of elements which will be passed as arguments 5, 6 and so on to the callback method)
// the first 5 arguments are fixed:
//	[0] item index
//	[1] parent item index
//	[2] isSelected boolean
//	[3] parent menu text
//	[4] menu text
entry.methodArguments = [17, "data"];

...

class	lastDetailRow

...

id	setMethod-Function_ObjectArray

Table Row (tr)

id	name

Table Cell (td)
setMethod

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

MenuItem

Span

style	font-weight: bold;

setMethod

Span
(method, arguments)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Set the method for the menu item/checkbox/radiobutton.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Function} method
{Object[]} arguments

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

MenuItem

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// add a new menu to the menubar
var menubar = plugins.window.getMenuBar();
var menu = menubar.addMenu();
menu.text = "New Menu";
// alternatively create a popup menu
//var menu = plugins.window.createPopupMenu();

// add a menu item at the first position in the menu
var entry = menu.addMenuItem(0);
// alternatively add a checkbox at the first position
//var entry = menu.addCheckBox(0);
// or alternatively add a radiobutton at the first position
//var entry = menu.addRadioButton(0);

// disable the newly added entry
entry.enabled = false;
// give a name to the entry (the name is not visible anywhere)
entry.name = "my_name";
// make the entry selected (affects checkboxes and radiobuttons)
entry.selected = true;
// set the text of the entry
entry.text = "menu entry";
// set the callback method
entry.setMethod(feedback);
// set the arguments to be sent to the callback method
// (an array of elements which will be passed as arguments 5, 6 and so on to the callback method)
// the first 5 arguments are fixed:
//	[0] item index
//	[1] parent item index
//	[2] isSelected boolean
//	[3] parent menu text
//	[4] menu text
entry.methodArguments = [17, "data"];

...

class	lastDetailRow

...

id	setMnemonic

Table Row (tr)

id	name

Table Cell (td)
setMnemonic

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

MenuItem

Span

style	font-weight: bold;

setMnemonic

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Set the mnemonic key of the menu item/checkbox/radiobutton.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

MenuItem

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// add a new menu to the menubar
var menubar = plugins.window.getMenuBar();
var menu = menubar.addMenu();
menu.text = "New Menu";
// alternatively create a popup menu
//var menu = plugins.window.createPopupMenu();

// add a menu item
var entry = menu.addMenuItem("menu entry", feedback);
// alternatively add a checkbox
//var entry = menu.addCheckBox("menu entry", feedback);
// or alternatively add a radiobutton
//var entry = menu.addRadioButton("menu entry", feedback);

// define an accelerator for the menu entry
entry.setAccelerator("ctrl alt Y");
// also define a mnemonic
entry.setMnemonic("y");
// set a custom background color
entry.setBackgroundColor("#111111");
// set a custom foreground color
entry.setForegroundColor("#EE5555");
// set an icon
entry.setIcon("media:///yourimage.gif");

...

class	lastDetailRow

...

id	setVisible-Boolean

Table Row (tr)

id	name

Table Cell (td)
setVisible

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

MenuItem

Span

style	font-weight: bold;

setVisible

Span
(visible)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Set the item visible.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Boolean} visible

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

MenuItem

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// add a new menu to the menubar
var menubar = plugins.window.getMenuBar();
var menu = menubar.addMenu();
menu.text = "New Menu";
// alternatively create a popup menu
//var menu = plugins.window.createPopupMenu();

// add a menu item
var entry_one = menu.addMenuItem("an entry", feedback);
// add a checkbox
var entry_two = menu.addCheckBox("another entry", feedback);
// add a radiobutton
var entry_three = menu.addRadioButton("yet another entry", feedback);

// hide the menu item
entry_one.setVisible(false);
// make sure the checkbox is visible
entry_two.setVisible(true);
// hide the radiobutton
entry_three.setVisible(false);

...

class	lastDetailRow

...

/checkbox/radiobutton.

Set the icon of the menu item/checkbox/radiobutton.

Set the method for the menu item/checkbox/radiobutton.

Set the mnemonic key of the menu item/checkbox/radiobutton.

Set the item visible.

constantservoy sDetail2100%height:30px2Constants DetailsALIGN_CENTERname

ALIGN_CENTER

des

sIndent

Constant for centering menu items/checkbox/radiobuttons at creation.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

ALIGN_LEFT

name

ALIGN_LEFT

des

sIndent

Constant for left aligning menu items/checkbox/radiobuttons at creation.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

ALIGN_RIGHT

name

ALIGN_RIGHT

des

sIndent

Constant for right aligning menu items/checkbox/radiobuttons at creation.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

propertyservoy sDetail2100%height:30px2Property Detailsenabledname

enabled

des

sIndent

Enable/disable the menu item/checkbox/radiobutton.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

methodArguments

name

methodArguments

des

sIndent

Set arguments that are sent to the callback method.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

name

des

sIndent

The name of the menu item/checkbox/radiobutton. The name is used only internally, it is not
visible in the user interface.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

selected

name

selected

des

sIndent

Select/unselect the checkbox/radiobutton.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

text

name

text

des

sIndent

Get/set the text of the menu item/checkbox/radiobutton.; This can be also html if enclosed between html tags

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

functionservoy sDetail2100%height:30px2Methods DetailsdoClickname

doClick()

des

sIndent

Script the selection (emulate a mouse click) of the item.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getClientProperty

name

getClientProperty(key)

des

sIndent

Gets the specified client property for the menu item/checkbox/radiobutton based on a key.

prs

Parameters

sIndent

key

;

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

putClientProperty

name

putClientProperty(key, value)

des

sIndent

Sets the value for the specified client property key of the menu item/checkbox/radiobutton.

prs

Parameters

sIndent

key

;

value

;

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

setAccelerator

name

setAccelerator(String)

des

sIndent

Set the accelerator key of the menu item/checkbox/radiobutton.

prs

Parameters

sIndent

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

setBackgroundColor

name

setBackgroundColor(String)

des

sIndent

Set the background color of the menu item/checkbox/radiobutton.

prs

Parameters

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

setForegroundColor

name

setForegroundColor(String)

des

sIndent

Set the foreground color of the menu item/checkbox/radiobutton.

prs

Parameters

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

setIcon

name

setIcon(Object)

des

sIndent

Set the icon of the menu item/checkbox/radiobutton.

prs

Parameters

sIndent

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

setMethod

name

setMethod(method)

des

sIndent

Set the method for the menu item/checkbox/radiobutton.

prs

Parameters

sIndent

method

;

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

setMethod

name

setMethod(method, arguments)

des

sIndent

Set the method for the menu item/checkbox/radiobutton.

prs

Parameters

sIndent

method

;

arguments

;

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

setMnemonic

name

setMnemonic(String)

des

sIndent

Set the mnemonic key of the menu item/checkbox/radiobutton.

prs

Parameters

sIndent

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

setVisible

name

setVisible(visible)

des

sIndent

Set the item visible.

prs

Parameters

sIndent

visible

;

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

Child pages

Page History

Versions Compared

Old Version 22

New Version Current

Key

ALIGN_CENTER

ALIGN_LEFT

ALIGN_RIGHT

enabled

methodArguments

name

selected

text

doClick

getClientProperty

putClientProperty

setAccelerator

setBackgroundColor

setForegroundColor

setIcon

setMethod

setMethod

setMnemonic

setVisible

ALIGN_CENTER

ALIGN_LEFT

ALIGN_RIGHT

enabled

methodArguments

name

selected

text

doClick()

getClientProperty(key)

putClientProperty(key, value)

setAccelerator(String)

setBackgroundColor(String)

setForegroundColor(String)

setIcon(Object)

setMethod(method)

setMethod(method, arguments)

setMnemonic(String)

setVisible(visible)