Page History

{hidden} DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY, UNLESS YOU KNOW WHAT YOU'RE DOING. THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO EXTRACT CHANGES FROM THE PAGE AND MERGE THEM BACK INTO SERVOY SOURCE{hidden} {sub-section:description|text=}{sub-section}\\ {table:id=|class=servoy sSummery}{colgroup}{column:padding=0px|width=80px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Method Summery{th}{tr}{tbody}{tr}{td}void{td}{td}[#addButton]\(text, method, \[arguments\], \[icon\], \[tooltip\], \[enabled\], \[visible\]) Add a Button to the toolbar.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#addCheckBox]\(text, method, \[selected\], \[tooltip\], \[enabled\], \[visible\]) Add a CheckBox to the toolbar.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#addComboBox]\(method, index, input, \[tooltip\], \[enabled\], \[visible\]) Add a ComboBox to the toolbar.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#addField]\(method, text, \[tooltip\], \[enabled\], \[visible\]) Add a Field to the toolbar.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#addSeparator]\() Add a Separator to the toolbar.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#enableItem]\() {td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#removeAllItems]\() Remove all Buttons, Checkboxes etc.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#removeItem]\(index) Remove a Button, CheckBox, ComboBox from the toolbar.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#selectCheckBox]\(index, boolean) Set the CheckBox selection.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#selectComboBox]\(index, rowindex) Select a row of the ComboBox via the index.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#setFieldText]\(index, text) Set a (default) text of the field at the given index.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#validate]\() You need to call this method after adding or removing items to/from the toolbar.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#visibleItem]\() {td}{tr}{tbody}{table}\\ {table:id=function|class=servoy sDetail}{colgroup}{column:padding=0px|width=100%}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Method Details{th}{tr}{tbody:id=addButton|class=node}{tr:id=name}{td}h6.addButton{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}addButton{span}{span:id=iets|style=float: left;}\(text, method, \[arguments\], \[icon\], \[tooltip\], \[enabled\], \[visible\]){span}{td}{tr}{tr:id=des}{td}{sub-section:addButton_des|text=|trigger=button}{sub-section}{sub-section:addButton_des|trigger=none|class=sIndent}Add a Button to the toolbar.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:addButton_snc|text=|trigger=button}{sub-section}{sub-section:addButton_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:addButton_prs|text=|trigger=button}{sub-section}{sub-section:addButton_prs|trigger=none|class=sIndent}text method \[arguments\] \[icon\] \[tooltip\] \[enabled\] \[visible\] {sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:addButton_ret|text=|trigger=button}{sub-section}{sub-section:addButton_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:addButton_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:addButton_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:addButton_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:addButton_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:addButton_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:addButton_sam|trigger=none}{code:language=javascript} // get the toolbar at the panel by name

Wiki Markup

Div

style	display: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.

Div

id	description

HTML Table

id
class	servoy sSummary

Colgroup Tag

Col

width	80px

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Method Summary

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
addButton(text, method) Add a Button to the toolbar.

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
addButton(text, method, arguments) Add a Button to the toolbar.

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
addButton(text, method, arguments, icon) Add a Button to the toolbar.

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
addButton(text, method, arguments, icon, tooltip) Add a Button to the toolbar.

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
addButton(text, method, arguments, icon, tooltip, enabled) Add a Button to the toolbar.

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
addButton(text, method, arguments, icon, tooltip, enabled, visible) Add a Button to the toolbar.

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
addCheckBox(text, method) Add a CheckBox to the toolbar.

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
addCheckBox(text, method, selected) Add a CheckBox to the toolbar.

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
addCheckBox(text, method, selected, tooltip) Add a CheckBox to the toolbar.

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
addCheckBox(text, method, selected, tooltip, enabled) Add a CheckBox to the toolbar.

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
addCheckBox(text, method, selected, tooltip, enabled, visible) Add a CheckBox to the toolbar.

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
addComboBox(method, index, values) Add a ComboBox to the toolbar.

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
addComboBox(method, index, values, tooltip) Add a ComboBox to the toolbar.

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
addComboBox(method, index, values, tooltip, enabled) Add a ComboBox to the toolbar.

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
addComboBox(method, index, values, tooltip, enabled, visible) Add a ComboBox to the toolbar.

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
addField(method, text) Add a Field to the toolbar.

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
addField(method, text, length) Add a Field to the toolbar.

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
addField(method, text, length, tooltip) Add a Field to the toolbar.

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
addField(method, text, length, tooltip, enabled) Add a Field to the toolbar.

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
addField(method, text, length, tooltip, enabled, visible) Add a Field to the toolbar.

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
addSeparator() Add a Separator to the toolbar.

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
enableItem(index, enabled) Enable/disable the item at the specified index.

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
removeAllItems() Remove all Buttons, Checkboxes etc.

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
removeItem(index) Remove a Button, CheckBox, ComboBox from the toolbar.

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
selectCheckBox(index, selected) Set the CheckBox selection.

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
selectComboBox(index, selection) Select a row of the ComboBox via the index.

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
setFieldText(index, text) Set a (default) text of the field at the given index.

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
visibleItem(index, visible) Make the item at the specified index visible/invisible.

HTML Table

id	function
class	servoy sDetail

Colgroup Tag

Col

colspan	2
width	100%

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Method Details

Table Body (tbody)

id	addButton-String_Function

Table Row (tr)

id	name

Table Cell (td)
addButton

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

addButton

Span
(text, method)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Add a Button to the toolbar.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} text
{Function} method

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

// create a new toolbar
var toolbar = plugins.window.

getToolBar

addToolBar(

"

'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(); {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=addCheckBox|class=node}{tr:id=name}{td}h6.addCheckBox{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}addCheckBox{span}{span:id=iets|style=float: left;}\(text, method, \[selected\], \[tooltip\], \[enabled\], \[visible\]){span}{td}{tr}{tr:id=des}{td}{sub-section:addCheckBox_des|text=|trigger=button}{sub-section}{sub-section:addCheckBox_des|trigger=none|class=sIndent}Add a CheckBox to the toolbar.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:addCheckBox_snc|text=|trigger=button}{sub-section}{sub-section:addCheckBox_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:addCheckBox_prs|text=|trigger=button}{sub-section}{sub-section:addCheckBox_prs|trigger=none|class=sIndent}text method \[selected\] \[tooltip\] \[enabled\] \[visible\] {sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:addCheckBox_ret|text=|trigger=button}{sub-section}{sub-section:addCheckBox_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:addCheckBox_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:addCheckBox_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:addCheckBox_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:addCheckBox_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:addCheckBox_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:addCheckBox_sam|trigger=none}{code:language=javascript} // add a toolbar with a name and internal name var toolbar = plugins.window.addToolBar("toolbar_1", "toolbar_1"); // add a checkbox with a text and a method toolbar.addCheckBox("checkbox", feedback_button); // add an checkbox and set it's state to selected (not selected by default) toolbar.addCheckBox("checkbox", feedback_button, true); // add a tooltip to the checkbox toolbar.addCheckBox("checkbox", feedback_button, false, "tooltip"); // add a separator toolbar.addSeparator(); // disable the checkbox and select it toolbar.addCheckBox("checkbox", feedback_button, true, "tooltip",false); // make the button non visible toolbar.addCheckBox("checkbox", feedback_button, false, "tooltip",false, false); // and validate the changes // to make them know to the user interface) toolbar.validate(); {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=addComboBox|class=node}{tr:id=name}{td}h6.addComboBox{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}addComboBox{span}{span:id=iets|style=float: left;}\(method, index, input, \[tooltip\], \[enabled\], \[visible\]){span}{td}{tr}{tr:id=des}{td}{sub-section:addComboBox_des|text=|trigger=button}{sub-section}{sub-section:addComboBox_des|trigger=none|class=sIndent}Add a ComboBox to the toolbar.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:addComboBox_snc|text=|trigger=button}{sub-section}{sub-section:addComboBox_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:addComboBox_prs|text=|trigger=button}{sub-section}{sub-section:addComboBox_prs|trigger=none|class=sIndent}method index input \[tooltip\] \[enabled\] \[visible\] {sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:addComboBox_ret|text=|trigger=button}{sub-section}{sub-section:addComboBox_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:addComboBox_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:addComboBox_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:addComboBox_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:addComboBox_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:addComboBox_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:addComboBox_sam|trigger=none}{code:language=javascript} // add a toolbar with a name and internal name at the given row index var toolbar = plugins.window.addToolBar("toolbar_2", "toolbar_2", 3); // add a combobox with the attached method, selected index and input (list) array toolbar.addComboBox(feedback_button, 0, ["input","array","combobox",1]);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	addButton-String_Function_ObjectArray

Table Row (tr)

id	name

Table Cell (td)
addButton

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

addButton

Span
(text, method, arguments)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Add a Button to the toolbar.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} text
{Function} method
{Object[]} arguments

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

// create a new toolbar
var toolbar = plugins.window.addToolBar('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);
// make the button non visible
toolbar.addButton(null, feedback_button, [1, "2", "three"], "media:///yourimage.gif", "tooltip", true, false);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	addButton-String_Function_ObjectArray_Object

Table Row (tr)

id	name

Table Cell (td)
addButton

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

addButton

Span
(text, method, arguments, icon)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Add a Button to the toolbar.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} text
{Function} method
{Object[]} arguments
{Object} icon

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

// create a new toolbar
var toolbar = plugins.window.addToolBar('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);
// make the button non visible
toolbar.addButton(null, feedback_button, [1, "2", "three"], "media:///yourimage.gif", "tooltip", true, false);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	addButton-String_Function_ObjectArray_Object_String

Table Row (tr)

id	name

Table Cell (td)
addButton

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

addButton

Span
(text, method, arguments, icon, tooltip)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Add a Button to the toolbar.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} text
{Function} method
{Object[]} arguments
{Object} icon
{String} tooltip

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

// create a new toolbar
var toolbar = plugins.window.addToolBar('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

combobox

button
toolbar.

addComboBox

addButton("button", feedback_button, [1,

[

input

2", "

array

three"],

"combobox",2]

 "media:///yourimage.gif", "tooltip");

//

add

show

a

only

separator toolbar.addSeparator(); //

an icon on the button and disable the

combobox

button
toolbar.

addComboBox

addButton(null, feedback_button,

2

[1,

[

input

2", "

array

three"],

"combobox",3]

 "media:///yourimage.gif", "tooltip", false);

// make the

combobox

button non visible
toolbar.

addComboBox

addButton(null, feedback_button,

3

[1,

[

input

2", "

array

three"],

"combobox

 "media:///yourimage.gif",

4],

 "tooltip",

false

 true, false);

// and validate the changes // to make them know to the user interface) toolbar.validate(); {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=addField|class=node}{tr:id=name}{td}h6.addField{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}addField{span}{span:id=iets|style=float: left;}\(method, text, \[tooltip\], \[enabled\], \[visible\]){span}{td}{tr}{tr:id=des}{td}{sub-section:addField_des|text=|trigger=button}{sub-section}{sub-section:addField_des|trigger=none|class=sIndent}Add a Field to the toolbar.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:addField_snc|text=|trigger=button}{sub-section}{sub-section:addField_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:addField_prs|text=|trigger=button}{sub-section}{sub-section:addField_prs|trigger=none|class=sIndent}method text \[tooltip\] \[enabled\] \[visible\] {sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:addField_ret|text=|trigger=button}{sub-section}{sub-section:addField_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:addField_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:addField_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:addField_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:addField_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:addField_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:addField_sam|trigger=none}{code:language=javascript} // add a toolbar with a name and internal name at the given row index

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	addButton-String_Function_ObjectArray_Object_String_Boolean

Table Row (tr)

id	name

Table Cell (td)
addButton

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

addButton

Span
(text, method, arguments, icon, tooltip, enabled)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Add a Button to the toolbar.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} text
{Function} method
{Object[]} arguments
{Object} icon
{String} tooltip
{Boolean} enabled

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

// create a new toolbar
var toolbar = plugins.window.addToolBar('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);
// make the button non visible
toolbar.addButton(null, feedback_button, [1, "2", "three"], "media:///yourimage.gif", "tooltip", true, false);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	addButton-String_Function_ObjectArray_Object_String_Boolean_Boolean

Table Row (tr)

id	name

Table Cell (td)
addButton

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

addButton

Span
(text, method, arguments, icon, tooltip, enabled, visible)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Add a Button to the toolbar.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} text
{Function} method
{Object[]} arguments
{Object} icon
{String} tooltip
{Boolean} enabled
{Boolean} visible

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

// create a new toolbar
var toolbar = plugins.window.addToolBar(

"

'toolbar_

3", "toolbar_3", 4

0');


// add a

field

button with

the

attached method

text and a

default text

method
toolbar.

addField

addButton("button", feedback_button

, null

);

// add

a

an

separator toolbar.addSeparator(); // set the length of the field. // default length = 8 when length is not set or set to 0 toolbar.addField(feedback_button, "field", 0, "tooltip"); // add a separator toolbar.addSeparator(); //

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

field

button
toolbar.

addField

addButton("button", feedback_button, [1, "2", "

field

three"],

10

"media:///yourimage.gif", "tooltip");


// show

add

only an

a

icon

separator toolbar.addSeparator(); //

on the button and disable the

field

button
toolbar.

addField

addButton(null, feedback_button,

null

[1,

5

"2", "

tooltip

three"],

false); // add a separator toolbar.addSeparator();

 "media:///yourimage.gif", "tooltip", false);
// make the

field

button non visible
toolbar.

addField

addButton(null, feedback_button, [1, "

field

2",

0,

tooltip

three"

,false

],

false); // and validate the changes // to make them know to the user interface) toolbar.validate(); {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=addSeparator|class=node}{tr:id=name}{td}h6.addSeparator{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}addSeparator{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:addSeparator_des|text=|trigger=button}{sub-section}{sub-section:addSeparator_des|trigger=none|class=sIndent}Add a Separator to the toolbar.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:addSeparator_snc|text=|trigger=button}{sub-section}{sub-section:addSeparator_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:addSeparator_prs|text=|trigger=button}{sub-section}{sub-section:addSeparator_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:addSeparator_ret|text=|trigger=button}{sub-section}{sub-section:addSeparator_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:addSeparator_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:addSeparator_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:addSeparator_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:addSeparator_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:addSeparator_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:addSeparator_sam|trigger=none}{code:language=javascript} // get the toolbar at the panel by name

"media:///yourimage.gif", "tooltip", true, false);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	addCheckBox-String_Function

Table Row (tr)

id	name

Table Cell (td)
addCheckBox

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

addCheckBox

Span
(text, method)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Add a CheckBox to the toolbar.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} text
{Function} method

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 toolbar
var toolbar = plugins.window.addToolBar("toolbar_1");
// add a checkbox with a text and a method
toolbar.addCheckBox("checkbox", feedback_checkbox);
// add an checkbox and set it's state to selected (not selected by default)
toolbar.addCheckBox("checkbox", feedback_checkbox, true);
// add a tooltip to the checkbox
toolbar.addCheckBox("checkbox", feedback_checkbox, false, "tooltip");
// disable the checkbox and select it
toolbar.addCheckBox("checkbox", feedback_checkbox, true, "tooltip", false);
// make the checkbox non visible
toolbar.addCheckBox("checkbox", feedback_checkbox, false, "tooltip", false, false);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	addCheckBox-String_Function_Boolean

Table Row (tr)

id	name

Table Cell (td)
addCheckBox

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

addCheckBox

Span
(text, method, selected)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Add a CheckBox to the toolbar.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} text
{Function} method
{Boolean} selected

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 toolbar
var toolbar = plugins.window.

getToolBar

addToolBar("toolbar_

0

1");


// add a

button

checkbox with a text and a method
toolbar.

addButton

addCheckBox("

button

checkbox", feedback_

button

checkbox);


// add an

input

checkbox

array

and

to

set

the

it's

button

state

for

to

feedback

selected

in

(not

the

selected

selected

by

method

default)
toolbar.

addButton

addCheckBox("

button

checkbox", feedback_

button

checkbox,

[1, "2", "three"]

true);


// add

an

icon

tooltip to the

button

checkbox
toolbar.

addButton

addCheckBox("

button

checkbox", feedback_

button

checkbox,

[1

false, "

2", "three"], "media:///yourimage.gif"

tooltip");

//

add

disable

a

the

tooltip

checkbox

to

and

the

select

button

it
toolbar.

addButton

addCheckBox("

button

checkbox", feedback_

button

checkbox,

[1

true, "

2

tooltip",

"three"], "media:///yourimage.gif", "tooltip."

false);

//

show only an icon on

make the

button

checkbox

and

non

disable the

visible

button

toolbar.

addButton

addCheckBox(

null

"checkbox", feedback_

button

checkbox,

[1

false, "

2

tooltip",

"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(); {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=enableItem|class=node}{tr:id=name}{td}h6.enableItem{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}enableItem{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:enableItem_des|text=|trigger=button}{sub-section}{sub-section:enableItem_des|trigger=none|class=sIndent}Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:enableItem_snc|text=|trigger=button}{sub-section}{sub-section:enableItem_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:enableItem_prs|text=|trigger=button}{sub-section}{sub-section:enableItem_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:enableItem_ret|text=|trigger=button}{sub-section}{sub-section:enableItem_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:enableItem_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:enableItem_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:enableItem_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:enableItem_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:enableItem_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:enableItem_sam|trigger=none}{code:language=javascript} // get the toolbar at the panel by name

false, false);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	addCheckBox-String_Function_Boolean_String

Table Row (tr)

id	name

Table Cell (td)
addCheckBox

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

addCheckBox

Span
(text, method, selected, tooltip)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Add a CheckBox to the toolbar.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} text
{Function} method
{Boolean} selected
{String} tooltip

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 toolbar
var toolbar = plugins.window.addToolBar("toolbar_1");
// add a checkbox with a text and a method
toolbar.addCheckBox("checkbox", feedback_checkbox);
// add an checkbox and set it's state to selected (not selected by default)
toolbar.addCheckBox("checkbox", feedback_checkbox, true);
// add a tooltip to the checkbox
toolbar.addCheckBox("checkbox", feedback_checkbox, false, "tooltip");
// disable the checkbox and select it
toolbar.addCheckBox("checkbox", feedback_checkbox, true, "tooltip", false);
// make the checkbox non visible
toolbar.addCheckBox("checkbox", feedback_checkbox, false, "tooltip", false, false);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	addCheckBox-String_Function_Boolean_String_Boolean

Table Row (tr)

id	name

Table Cell (td)
addCheckBox

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

addCheckBox

Span
(text, method, selected, tooltip, enabled)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Add a CheckBox to the toolbar.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} text
{Function} method
{Boolean} selected
{String} tooltip
{Boolean} enabled

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 toolbar
var toolbar = plugins.window.addToolBar("toolbar_1");
// add a checkbox with a text and a method
toolbar.addCheckBox("checkbox", feedback_checkbox);
// add an checkbox and set it's state to selected (not selected by default)
toolbar.addCheckBox("checkbox", feedback_checkbox, true);
// add a tooltip to the checkbox
toolbar.addCheckBox("checkbox", feedback_checkbox, false, "tooltip");
// disable the checkbox and select it
toolbar.addCheckBox("checkbox", feedback_checkbox, true, "tooltip", false);
// make the checkbox non visible
toolbar.addCheckBox("checkbox", feedback_checkbox, false, "tooltip", false, false);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	addCheckBox-String_Function_Boolean_String_Boolean_Boolean

Table Row (tr)

id	name

Table Cell (td)
addCheckBox

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

addCheckBox

Span
(text, method, selected, tooltip, enabled, visible)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Add a CheckBox to the toolbar.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} text
{Function} method
{Boolean} selected
{String} tooltip
{Boolean} enabled
{Boolean} visible

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 toolbar
var toolbar = plugins.window.

getToolBar

addToolBar("toolbar_1");

//

enable/disable

add

the

selected

checkbox

item

with

at

the

text

index

and

//

REMARK: the pitfall here is that the indexes start at position 1 here // position 0 is reserved for the toolbar handle! toolbar.enableItem(1, false); {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=removeAllItems|class=node}{tr:id=name}{td}h6.removeAllItems{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}removeAllItems{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:removeAllItems_des|text=|trigger=button}{sub-section}{sub-section:removeAllItems_des|trigger=none|class=sIndent}Remove all Buttons, Checkboxes etc. from the toolbar.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:removeAllItems_snc|text=|trigger=button}{sub-section}{sub-section:removeAllItems_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:removeAllItems_prs|text=|trigger=button}{sub-section}{sub-section:removeAllItems_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:removeAllItems_ret|text=|trigger=button}{sub-section}{sub-section:removeAllItems_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:removeAllItems_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:removeAllItems_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:removeAllItems_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:removeAllItems_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:removeAllItems_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:removeAllItems_sam|trigger=none}{code:language=javascript} // get the toolbar at the panel by name

method
toolbar.addCheckBox("checkbox", feedback_checkbox);
// add an checkbox and set it's state to selected (not selected by default)
toolbar.addCheckBox("checkbox", feedback_checkbox, true);
// add a tooltip to the checkbox
toolbar.addCheckBox("checkbox", feedback_checkbox, false, "tooltip");
// disable the checkbox and select it
toolbar.addCheckBox("checkbox", feedback_checkbox, true, "tooltip", false);
// make the checkbox non visible
toolbar.addCheckBox("checkbox", feedback_checkbox, false, "tooltip", false, false);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	addComboBox-Function_Number_StringArray

Table Row (tr)

id	name

Table Cell (td)
addComboBox

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

addComboBox

Span
(method, index, values)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Add a ComboBox to the toolbar.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Function} method
{Number} index
{String[]} values

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 toolbar
var toolbar = plugins.window.addToolBar("toolbar_2");
// add a combobox with the attached method, selected index and input (list) array
toolbar.addComboBox(feedback_combobox, 0, ["input","array","combobox",1]);
// add a tooltip to the combobox
toolbar.addComboBox(feedback_combobox, 1, ["input","array","combobox",2], "tooltip");
// disable the combobox
toolbar.addComboBox(feedback_combobox, 2, ["input","array","combobox",3], "tooltip", false);
// make the combobox non visible
toolbar.addComboBox(feedback_combobox, 3, ["input","array","combobox",4], "tooltip", false, false);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	addComboBox-Function_Number_StringArray_String

Table Row (tr)

id	name

Table Cell (td)
addComboBox

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

addComboBox

Span
(method, index, values, tooltip)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Add a ComboBox to the toolbar.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Function} method
{Number} index
{String[]} values
{String} tooltip

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 toolbar
var toolbar = plugins.window.

getToolBar

addToolBar("toolbar_2");
// add a combobox with the attached method, selected index and input (list) array
toolbar.addComboBox(feedback_combobox, 0, ["input","array","combobox",1]);

//

remove

add

all

buttons

tooltip

from

to the

toolbar

combobox
toolbar.

removeAllItems(); {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=removeItem|class=node}{tr:id=name}{td}h6.removeItem{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}removeItem{span}{span:id=iets|style=float: left;}\(index){span}{td}{tr}{tr:id=des}{td}{sub-section:removeItem_des|text=|trigger=button}{sub-section}{sub-section:removeItem_des|trigger=none|class=sIndent}Remove a Button, CheckBox, ComboBox from the toolbar.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:removeItem_snc|text=|trigger=button}{sub-section}{sub-section:removeItem_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:removeItem_prs|text=|trigger=button}{sub-section}{sub-section:removeItem_prs|trigger=none|class=sIndent}index {sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:removeItem_ret|text=|trigger=button}{sub-section}{sub-section:removeItem_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:removeItem_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:removeItem_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:removeItem_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:removeItem_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:removeItem_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:removeItem_sam|trigger=none}{code:language=javascript} // get the toolbar at the panel by name var toolbar = plugins.window.getToolBar("toolbar_0"); // remove the button, checkbox, combobox, separator or field from the toolbar // REMARK: the pitfall here is that the indexes start at position 1 here // position 0 is reserved for the toolbar handle! toolbar.removeItem(1); // and validate the changes // to make them know to the user interface) toolbar.validate(); {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=selectCheckBox|class=node}{tr:id=name}{td}h6.selectCheckBox{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}selectCheckBox{span}{span:id=iets|style=float: left;}\(index, boolean){span}{td}{tr}{tr:id=des}{td}{sub-section:selectCheckBox_des|text=|trigger=button}{sub-section}{sub-section:selectCheckBox_des|trigger=none|class=sIndent}Set the CheckBox selection.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:selectCheckBox_snc|text=|trigger=button}{sub-section}{sub-section:selectCheckBox_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:selectCheckBox_prs|text=|trigger=button}{sub-section}{sub-section:selectCheckBox_prs|trigger=none|class=sIndent}index boolean {sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:selectCheckBox_ret|text=|trigger=button}{sub-section}{sub-section:selectCheckBox_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:selectCheckBox_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:selectCheckBox_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:selectCheckBox_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:selectCheckBox_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:selectCheckBox_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:selectCheckBox_sam|trigger=none}{code:language=javascript} // get the toolbar at the panel by name

addComboBox(feedback_combobox, 1, ["input","array","combobox",2], "tooltip");
// disable the combobox
toolbar.addComboBox(feedback_combobox, 2, ["input","array","combobox",3], "tooltip", false);
// make the combobox non visible
toolbar.addComboBox(feedback_combobox, 3, ["input","array","combobox",4], "tooltip", false, false);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	addComboBox-Function_Number_StringArray_String_Boolean

Table Row (tr)

id	name

Table Cell (td)
addComboBox

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

addComboBox

Span
(method, index, values, tooltip, enabled)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Add a ComboBox to the toolbar.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Function} method
{Number} index
{String[]} values
{String} tooltip
{Boolean} enabled

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 toolbar
var toolbar = plugins.window.addToolBar("toolbar_2");
// add a combobox with the attached method, selected index and input (list) array
toolbar.addComboBox(feedback_combobox, 0, ["input","array","combobox",1]);
// add a tooltip to the combobox
toolbar.addComboBox(feedback_combobox, 1, ["input","array","combobox",2], "tooltip");
// disable the combobox
toolbar.addComboBox(feedback_combobox, 2, ["input","array","combobox",3], "tooltip", false);
// make the combobox non visible
toolbar.addComboBox(feedback_combobox, 3, ["input","array","combobox",4], "tooltip", false, false);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	addComboBox-Function_Number_StringArray_String_Boolean_Boolean

Table Row (tr)

id	name

Table Cell (td)
addComboBox

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

addComboBox

Span
(method, index, values, tooltip, enabled, visible)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Add a ComboBox to the toolbar.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Function} method
{Number} index
{String[]} values
{String} tooltip
{Boolean} enabled
{Boolean} visible

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 toolbar
var toolbar = plugins.window.addToolBar("toolbar_2");
// add a combobox with the attached method, selected index and input (list) array
toolbar.addComboBox(feedback_combobox, 0, ["input","array","combobox",1]);
// add a tooltip to the combobox
toolbar.addComboBox(feedback_combobox, 1, ["input","array","combobox",2], "tooltip");
// disable the combobox
toolbar.addComboBox(feedback_combobox, 2, ["input","array","combobox",3], "tooltip", false);
// make the combobox non visible
toolbar.addComboBox(feedback_combobox, 3, ["input","array","combobox",4], "tooltip", false, false);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	addField-Function_String

Table Row (tr)

id	name

Table Cell (td)
addField

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

addField

Span
(method, text)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Add a Field to the toolbar.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Function} method
{String} text

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 toolbar
var toolbar = plugins.window.addToolBar("toolbar_3");
// add a field with the attached method and a default text
toolbar.addField(feedback_field, null);
// set the length of the field.
// default length = 8 when length is not set or set to 0
toolbar.addField(feedback_field, "field", 0, "tooltip");
// add a tooltip to the field
toolbar.addField(feedback_field, null, 10, "tooltip");
// disable the field
toolbar.addField(feedback_field, "field", 5, "tooltip", false);
// make the field non visible
toolbar.addField(feedback_field, "field", 0, "tooltip", false, false);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	addField-Function_String_Number

Table Row (tr)

id	name

Table Cell (td)
addField

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

addField

Span
(method, text, length)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Add a Field to the toolbar.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Function} method
{String} text
{Number} length

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 toolbar
var toolbar = plugins.window.

getToolBar

addToolBar("toolbar_

1

3");

//

set

add

the

selection

field

of

with the

checkbox at the index

attached method and a default text
toolbar.addField(feedback_field, null);
//

REMARK:

set the

pitfall here is that

length of the

indexes

field.

start

//

at

default

position

length

1

here

//

when

position

length

0

is

is

not

reserved

set

for

or

the

set

toolbar

to

handle!

0
toolbar.

selectCheckBox(1, false); toolbar.selectCheckBox(2, true); {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=selectComboBox|class=node}{tr:id=name}{td}h6.selectComboBox{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}selectComboBox{span}{span:id=iets|style=float: left;}\(index, rowindex){span}{td}{tr}{tr:id=des}{td}{sub-section:selectComboBox_des|text=|trigger=button}{sub-section}{sub-section:selectComboBox_des|trigger=none|class=sIndent}Select a row of the ComboBox via the index.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:selectComboBox_snc|text=|trigger=button}{sub-section}{sub-section:selectComboBox_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:selectComboBox_prs|text=|trigger=button}{sub-section}{sub-section:selectComboBox_prs|trigger=none|class=sIndent}index rowindex {sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:selectComboBox_ret|text=|trigger=button}{sub-section}{sub-section:selectComboBox_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:selectComboBox_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:selectComboBox_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:selectComboBox_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:selectComboBox_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:selectComboBox_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:selectComboBox_sam|trigger=none}{code:language=javascript} // get the toolbar at the panel by name

addField(feedback_field, "field", 0, "tooltip");
// add a tooltip to the field
toolbar.addField(feedback_field, null, 10, "tooltip");
// disable the field
toolbar.addField(feedback_field, "field", 5, "tooltip", false);
// make the field non visible
toolbar.addField(feedback_field, "field", 0, "tooltip", false, false);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	addField-Function_String_Number_String

Table Row (tr)

id	name

Table Cell (td)
addField

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

addField

Span
(method, text, length, tooltip)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Add a Field to the toolbar.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Function} method
{String} text
{Number} length
{String} tooltip

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 toolbar
var toolbar = plugins.window.addToolBar("toolbar_3");
// add a field with the attached method and a default text
toolbar.addField(feedback_field, null);
// set the length of the field.
// default length = 8 when length is not set or set to 0
toolbar.addField(feedback_field, "field", 0, "tooltip");
// add a tooltip to the field
toolbar.addField(feedback_field, null, 10, "tooltip");
// disable the field
toolbar.addField(feedback_field, "field", 5, "tooltip", false);
// make the field non visible
toolbar.addField(feedback_field, "field", 0, "tooltip", false, false);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	addField-Function_String_Number_String_Boolean

Table Row (tr)

id	name

Table Cell (td)
addField

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

addField

Span
(method, text, length, tooltip, enabled)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Add a Field to the toolbar.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Function} method
{String} text
{Number} length
{String} tooltip
{Boolean} enabled

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 toolbar
var toolbar = plugins.window.

getToolBar

addToolBar("toolbar_

2

3");

//

set

 add a field with the attached

selection

method

of

and

the

combobox

default

at the index

text
toolbar.addField(feedback_field, null);
//

REMARK:

set the

pitfall

length

here is

of

that

the

indexes

field.

start

//

at

default

position

length

1

here

//

when

position

length

0

is

is

not

reserved

set

for

or

the

set

toolbar

to

handle!

0
toolbar.

selectComboBox(1

addField(feedback_field, "field", 0, "tooltip");
// add a tooltip to the field
toolbar.

selectComboBox(2, 0); {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=setFieldText|class=node}{tr:id=name}{td}h6.setFieldText{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}setFieldText{span}{span:id=iets|style=float: left;}\(index, text){span}{td}{tr}{tr:id=des}{td}{sub-section:setFieldText_des|text=|trigger=button}{sub-section}{sub-section:setFieldText_des|trigger=none|class=sIndent}Set a (default) text of the field at the given index.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:setFieldText_snc|text=|trigger=button}{sub-section}{sub-section:setFieldText_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:setFieldText_prs|text=|trigger=button}{sub-section}{sub-section:setFieldText_prs|trigger=none|class=sIndent}index text {sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:setFieldText_ret|text=|trigger=button}{sub-section}{sub-section:setFieldText_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:setFieldText_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:setFieldText_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:setFieldText_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:setFieldText_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:setFieldText_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:setFieldText_sam|trigger=none}{code:language=javascript} // get the toolbar at the panel by name

addField(feedback_field, null, 10, "tooltip");
// disable the field
toolbar.addField(feedback_field, "field", 5, "tooltip", false);
// make the field non visible
toolbar.addField(feedback_field, "field", 0, "tooltip", false, false);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	addField-Function_String_Number_String_Boolean_Boolean

Table Row (tr)

id	name

Table Cell (td)
addField

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

addField

Span
(method, text, length, tooltip, enabled, visible)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Add a Field to the toolbar.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Function} method
{String} text
{Number} length
{String} tooltip
{Boolean} enabled
{Boolean} visible

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 toolbar
var toolbar = plugins.window.addToolBar("toolbar_3");
// add a field with the attached method and a default text
toolbar.addField(feedback_field, null);
// set the length of the field.
// default length = 8 when length is not set or set to 0
toolbar.addField(feedback_field, "field", 0, "tooltip");
// add a tooltip to the field
toolbar.addField(feedback_field, null, 10, "tooltip");
// disable the field
toolbar.addField(feedback_field, "field", 5, "tooltip", false);
// make the field non visible
toolbar.addField(feedback_field, "field", 0, "tooltip", false, false);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	addSeparator

Table Row (tr)

id	name

Table Cell (td)
addSeparator

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

addSeparator

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Add a Separator to the toolbar.

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 toolbar
var toolbar = plugins.window.

getToolBar

addToolBar("toolbar_

3

0");

//

set

add

the

text of the field at the index

button
toolbar.addButton("button", feedback_button);
//

REMARK:

add

the

pitfall here is that the indexes start at position 1 here

separator
toolbar.addSeparator();
//

position

add

0 is reserved for the toolbar handle!

a checkbox
toolbar.

setFieldText

addCheckBox(

1

"checkbox",

"new text 1"); toolbar.setFieldText(2, "new text 2"); {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=validate|class=node}{tr:id=name}{td}h6.validate{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}validate{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:validate_des|text=|trigger=button}{sub-section}{sub-section:validate_des|trigger=none|class=sIndent}You need to call this method after adding or removing items to/from the toolbar.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:validate_snc|text=|trigger=button}{sub-section}{sub-section:validate_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:validate_prs|text=|trigger=button}{sub-section}{sub-section:validate_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:validate_ret|text=|trigger=button}{sub-section}{sub-section:validate_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:validate_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:validate_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:validate_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:validate_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:validate_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:validate_sam|trigger=none}{code:language=javascript} // get the toolbar at the panel by name var toolbar = plugins.window.getToolBar("toolbar_0"); // remove the button, checkbox, combobox, separator or field from the toolbar // REMARK: the pitfall here is that the indexes start at position 1 here // position 0 is reserved for the toolbar handle! toolbar.removeItem(1); // and validate the changes // to make them know to the user interface) toolbar.validate(); {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=visibleItem|class=node}{tr:id=name}{td}h6.visibleItem{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}visibleItem{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:visibleItem_des|text=|trigger=button}{sub-section}{sub-section:visibleItem_des|trigger=none|class=sIndent}Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:visibleItem_snc|text=|trigger=button}{sub-section}{sub-section:visibleItem_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:visibleItem_prs|text=|trigger=button}{sub-section}{sub-section:visibleItem_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:visibleItem_ret|text=|trigger=button}{sub-section}{sub-section:visibleItem_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:visibleItem_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:visibleItem_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:visibleItem_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:visibleItem_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:visibleItem_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:visibleItem_sam|trigger=none}{code:language=javascript} // get the toolbar at the panel by name

feedback_checkbox);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	enableItem-Number_Boolean

Table Row (tr)

id	name

Table Cell (td)
enableItem

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

enableItem

Span
(index, enabled)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Enable/disable the item at the specified index.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} index
{Boolean} enabled

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 toolbar
var toolbar = plugins.window.addToolBar("toolbar_1");
// add a checkbox
toolbar.addCheckBox("checkbox", feedback_checkbox);
// disable the button
// REMARK: the pitfall here is that the indexes start at position 1 here
// position 0 is reserved for the toolbar handle!
toolbar.enableItem(1, false);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	removeAllItems

Table Row (tr)

id	name

Table Cell (td)
removeAllItems

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

removeAllItems

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Remove all Buttons, Checkboxes etc. from the toolbar.

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 toolbar
var toolbar = plugins.window.addToolBar("toolbar_1");
// add a button
toolbar.addButton("button", feedback_button);
// add a checkbox
toolbar.addCheckBox("checkbox", feedback_checkbox);
// remove all items from the toolbar
toolbar.removeAllItems();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	removeItem-Number

Table Row (tr)

id	name

Table Cell (td)
removeItem

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

removeItem

Span
(index)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Remove a Button, CheckBox, ComboBox from the toolbar.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} index

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 toolbar
var toolbar = plugins.window.addToolBar("toolbar_1");
// add a button
toolbar.addButton("button", feedback_button);
// add a checkbox
toolbar.addCheckBox("checkbox", feedback_checkbox);
// remove the first item (the button in this case) from the toolbar
// REMARK: the pitfall here is that the indexes start at position 1 here
// position 0 is reserved for the toolbar handle!
toolbar.removeItem(1);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	selectCheckBox-Number_Boolean

Table Row (tr)

id	name

Table Cell (td)
selectCheckBox

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

selectCheckBox

Span
(index, selected)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Set the CheckBox selection.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} index
{Boolean} selected

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 toolbar
var toolbar = plugins.window.addToolBar("toolbar_1");
// add a checkbox
toolbar.addCheckBox("checkbox 1", feedback_checkbox);
// add another checkbox
toolbar.addCheckBox("checkbox 2", feedback_checkbox);
// set the selection of the checkboxes
// REMARK: the pitfall here is that the indexes start at position 1 here
// position 0 is reserved for the toolbar handle!
toolbar.selectCheckBox(1, false);
toolbar.selectCheckBox(2, true);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	selectComboBox-Number_Number

Table Row (tr)

id	name

Table Cell (td)
selectComboBox

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

selectComboBox

Span
(index, selection)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Select a row of the ComboBox via the index.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} index
{Number} selection

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 toolbar
var toolbar = plugins.window.addToolBar("toolbar_1");
// add a combobox
toolbar.addComboBox(feedback_combobox, 1, ["one", "two", "three"]);
// add another combobox
toolbar.addComboBox(feedback_combobox, 2, [1, 2, 3, 4, 5]);
// set the selection of the comboboxes
// REMARK: the pitfall here is that the indexes start at position 1 here
// position 0 is reserved for the toolbar handle!
toolbar.selectComboBox(1, 0); // entry "one" will be selected in the first combobox
toolbar.selectComboBox(2, 3); // entry 4 will be selected in the second combobox

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	setFieldText-Number_String

Table Row (tr)

id	name

Table Cell (td)
setFieldText

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

setFieldText

Span
(index, text)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Set a (default) text of the field at the given index.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} index
{String} text

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 toolbar
var toolbar = plugins.window.addToolBar("toolbar_1");
// add a field
toolbar.addField(feedback_field, "field one");
// add another field
toolbar.addField(feedback_field , "field_two");
// set the text of the fields
// REMARK: the pitfall here is that the indexes start at position 1 here
// position 0 is reserved for the toolbar handle!
toolbar.setFieldText(1, "new text 1");
toolbar.setFieldText(2, "new text 2");

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	visibleItem-Number_Boolean

Table Row (tr)

id	name

Table Cell (td)
visibleItem

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

visibleItem

Span
(index, visible)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Make the item at the specified index visible/invisible.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} index
{Boolean} visible

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 toolbar
var toolbar = plugins.window.

getToolBar

addToolBar("toolbar_

2

1");
// add a button
toolbar.addButton("button", feedback_button);
// add a checkbox
toolbar.addCheckBox("checkbox", feedback_checkbox);
// make the

selected

first item

at

(the

index

button)

visible/

invisible
// REMARK: the pitfall here is that the indexes start at position 1 here
// position 0 is reserved for the toolbar handle!
toolbar.visibleItem(1, false);

{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Child pages

Versions Compared

Old Version 11

New Version Current

Key