Child pages
  • ToolBar

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3
{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:class=servoy sSummery}{colgroup}{column:width=80px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Method Summary{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:class=servoy sDetail}{colgroup}{column:width=100%}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Method Details{th}{tr}{tbody:id=1CC7AD4C-D69E-4E9C-9544-8DD39C2E3690}{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:1CC7AD4C-D69E-4E9C-9544-8DD39C2E3690_des|text=|trigger=button}{sub-section}{sub-section:1CC7AD4C-D69E-4E9C-9544-8DD39C2E3690_des|trigger=none|class=sIndent}Add a Button to the toolbar.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:1CC7AD4C-D69E-4E9C-9544-8DD39C2E3690_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:1CC7AD4C-D69E-4E9C-9544-8DD39C2E3690_prs|trigger=none}text method \[arguments\] \[icon\] \[tooltip\] \[enabled\] \[visible\] {sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:1CC7AD4C-D69E-4E9C-9544-8DD39C2E3690_ret|text=|trigger=button}{sub-section}{sub-section:1CC7AD4C-D69E-4E9C-9544-8DD39C2E3690_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:1CC7AD4C-D69E-4E9C-9544-8DD39C2E3690_see|text=|trigger=button}{sub-section}{sub-section:1CC7AD4C-D69E-4E9C-9544-8DD39C2E3690_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:1CC7AD4C-D69E-4E9C-9544-8DD39C2E3690_see|text=|trigger=button}{sub-section}{sub-section:1CC7AD4C-D69E-4E9C-9544-8DD39C2E3690_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:1CC7AD4C-D69E-4E9C-9544-8DD39C2E3690_sam|text=|trigger=button}{sub-section}{sub-section:1CC7AD4C-D69E-4E9C-9544-8DD39C2E3690_sam|class=sIndent|trigger=none}{code:language=javascript} // get the toolbar at the panel by name
Wiki Markup
Div
styledisplay: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
iddescription



HTML Table
id
classservoy sSummary
Colgroup Tag
Col
width80px
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Method Summary
Table Row (tr)
Table Cell (td)
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
idfunction
classservoy sDetail
Colgroup Tag
Col
colspan2
width100%
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Method Details
Table Body (tbody)
idaddButton-String_Function
Table Row (tr)
idname
Table Cell (td)

addButton

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
addButton
Span
(text, method)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Add a Button to the toolbar.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} text
{Function} method
Table Row (tr)
idret
Table Cell (td)

Returns

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

Sample

Div
classsIndent
Code Block
languagejavascript
// 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}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=D5EFB2EA-D318-488B-B0AB-21361ACFE1DC}{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:D5EFB2EA-D318-488B-B0AB-21361ACFE1DC_des|text=|trigger=button}{sub-section}{sub-section:D5EFB2EA-D318-488B-B0AB-21361ACFE1DC_des|trigger=none|class=sIndent}Add a CheckBox to the toolbar.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:D5EFB2EA-D318-488B-B0AB-21361ACFE1DC_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:D5EFB2EA-D318-488B-B0AB-21361ACFE1DC_prs|trigger=none}text method \[selected\] \[tooltip\] \[enabled\] \[visible\] {sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:D5EFB2EA-D318-488B-B0AB-21361ACFE1DC_ret|text=|trigger=button}{sub-section}{sub-section:D5EFB2EA-D318-488B-B0AB-21361ACFE1DC_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:D5EFB2EA-D318-488B-B0AB-21361ACFE1DC_see|text=|trigger=button}{sub-section}{sub-section:D5EFB2EA-D318-488B-B0AB-21361ACFE1DC_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:D5EFB2EA-D318-488B-B0AB-21361ACFE1DC_see|text=|trigger=button}{sub-section}{sub-section:D5EFB2EA-D318-488B-B0AB-21361ACFE1DC_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:D5EFB2EA-D318-488B-B0AB-21361ACFE1DC_sam|text=|trigger=button}{sub-section}{sub-section:D5EFB2EA-D318-488B-B0AB-21361ACFE1DC_sam|class=sIndent|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}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=6B9E8D17-8806-4B32-9619-25BD233A0957}{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:6B9E8D17-8806-4B32-9619-25BD233A0957_des|text=|trigger=button}{sub-section}{sub-section:6B9E8D17-8806-4B32-9619-25BD233A0957_des|trigger=none|class=sIndent}Add a ComboBox to the toolbar.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:6B9E8D17-8806-4B32-9619-25BD233A0957_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:6B9E8D17-8806-4B32-9619-25BD233A0957_prs|trigger=none}method index input \[tooltip\] \[enabled\] \[visible\] {sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:6B9E8D17-8806-4B32-9619-25BD233A0957_ret|text=|trigger=button}{sub-section}{sub-section:6B9E8D17-8806-4B32-9619-25BD233A0957_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:6B9E8D17-8806-4B32-9619-25BD233A0957_see|text=|trigger=button}{sub-section}{sub-section:6B9E8D17-8806-4B32-9619-25BD233A0957_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:6B9E8D17-8806-4B32-9619-25BD233A0957_see|text=|trigger=button}{sub-section}{sub-section:6B9E8D17-8806-4B32-9619-25BD233A0957_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:6B9E8D17-8806-4B32-9619-25BD233A0957_sam|text=|trigger=button}{sub-section}{sub-section:6B9E8D17-8806-4B32-9619-25BD233A0957_sam|class=sIndent|trigger=none}{code:language=javascript} // add a toolbar with a name and internal name at the given row index
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idaddButton-String_Function_ObjectArray
Table Row (tr)
idname
Table Cell (td)

addButton

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
addButton
Span
(text, method, arguments)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Add a Button to the toolbar.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} text
{Function} method
{Object[]} arguments
Table Row (tr)
idret
Table Cell (td)

Returns

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

Sample

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

addButton

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
addButton
Span
(text, method, arguments, icon)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Add a Button to the toolbar.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} text
{Function} method
{Object[]} arguments
{Object} icon
Table Row (tr)
idret
Table Cell (td)

Returns

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

Sample

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

addButton

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
addButton
Span
(text, method, arguments, icon, tooltip)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Add a Button to the toolbar.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} text
{Function} method
{Object[]} arguments
{Object} icon
{String} tooltip
Table Row (tr)
idret
Table Cell (td)

Returns

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

Sample

Div
classsIndent
Code Block
languagejavascript
// create a new toolbar
var toolbar = plugins.window.addToolBar(
"
'toolbar_
2", "toolbar_2", 3
0');
// add a 
combobox
button with 
the
a 
attached method, selected index and input (list) array toolbar.addComboBox(
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, 
0
[1, 
[
"
input
2", "
array","combobox",1
three"]);
// add 
a
an 
tooltip
icon to the 
combobox
button
toolbar.
addComboBox
addButton("button", feedback_button, [1, 
[
"
input
2", "
array","combobox",2
three"], "
tooltip
media:///yourimage.gif");

// add a tooltip 
separator toolbar.addSeparator(); // disable the combobox toolbar.addComboBox(
to the button
toolbar.addButton("button", feedback_button, 
2
[1, 
[
"
input
2", "
array
three"],
"combobox",3]
 "media:///yourimage.gif", "tooltip"
,false
);
//
make
 show only an icon on the 
combobox non visible
button and disable the button
toolbar.
addComboBox
addButton(null, feedback_button, 
3
[1, 
[
"
input
2", "
array
three"],
"combobox",4]
 "media:///yourimage.gif", "tooltip",
false,
 false);
// 
and validate
make the 
changes
button 
//
non 
to make them know to the user interface) toolbar.validate(); {code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=97B95779-0AB5-47F0-8F6A-F111ACCA3221}{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:97B95779-0AB5-47F0-8F6A-F111ACCA3221_des|text=|trigger=button}{sub-section}{sub-section:97B95779-0AB5-47F0-8F6A-F111ACCA3221_des|trigger=none|class=sIndent}Add a Field to the toolbar.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:97B95779-0AB5-47F0-8F6A-F111ACCA3221_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:97B95779-0AB5-47F0-8F6A-F111ACCA3221_prs|trigger=none}method text \[tooltip\] \[enabled\] \[visible\] {sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:97B95779-0AB5-47F0-8F6A-F111ACCA3221_ret|text=|trigger=button}{sub-section}{sub-section:97B95779-0AB5-47F0-8F6A-F111ACCA3221_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:97B95779-0AB5-47F0-8F6A-F111ACCA3221_see|text=|trigger=button}{sub-section}{sub-section:97B95779-0AB5-47F0-8F6A-F111ACCA3221_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:97B95779-0AB5-47F0-8F6A-F111ACCA3221_see|text=|trigger=button}{sub-section}{sub-section:97B95779-0AB5-47F0-8F6A-F111ACCA3221_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:97B95779-0AB5-47F0-8F6A-F111ACCA3221_sam|text=|trigger=button}{sub-section}{sub-section:97B95779-0AB5-47F0-8F6A-F111ACCA3221_sam|class=sIndent|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_3", "toolbar_3", 4); // add a field with the attached method and a default text toolbar.addField(feedback_button, null); // add a 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(); // add a tooltip to the field toolbar.addField(feedback_button, "field", 10, "tooltip"); // add a separator toolbar.addSeparator(); // disable the field toolbar.addField(feedback_button, null, 5, "tooltip",false); // add a separator toolbar.addSeparator(); // make the field non visible toolbar.addField(feedback_button, "field", 0, "tooltip",false, false); // and validate the changes // to make them know to the user interface) toolbar.validate(); {code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=DC68AAF3-334C-40C7-BA89-7D0EFA85AADA}{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:DC68AAF3-334C-40C7-BA89-7D0EFA85AADA_des|text=|trigger=button}{sub-section}{sub-section:DC68AAF3-334C-40C7-BA89-7D0EFA85AADA_des|trigger=none|class=sIndent}Add a Separator to the toolbar.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:DC68AAF3-334C-40C7-BA89-7D0EFA85AADA_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:DC68AAF3-334C-40C7-BA89-7D0EFA85AADA_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:DC68AAF3-334C-40C7-BA89-7D0EFA85AADA_ret|text=|trigger=button}{sub-section}{sub-section:DC68AAF3-334C-40C7-BA89-7D0EFA85AADA_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:DC68AAF3-334C-40C7-BA89-7D0EFA85AADA_see|text=|trigger=button}{sub-section}{sub-section:DC68AAF3-334C-40C7-BA89-7D0EFA85AADA_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:DC68AAF3-334C-40C7-BA89-7D0EFA85AADA_see|text=|trigger=button}{sub-section}{sub-section:DC68AAF3-334C-40C7-BA89-7D0EFA85AADA_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:DC68AAF3-334C-40C7-BA89-7D0EFA85AADA_sam|text=|trigger=button}{sub-section}{sub-section:DC68AAF3-334C-40C7-BA89-7D0EFA85AADA_sam|class=sIndent|trigger=none}{code:language=javascript} // get the toolbar at the panel by name var toolbar = plugins.window.getToolBar("toolbar_0"); // add a button with a text and a method toolbar.addButton("button", feedback_button); // add an input array to the button for feedback in the selected method toolbar.addButton("button", feedback_button, [1, "2", "three"]); // add an icon to the button toolbar.addButton("button", feedback_button, [1, "2", "three"], "media:///yourimage.gif"); // add a tooltip to the button toolbar.addButton("button", feedback_button, [1, "2", "three"], "media:///yourimage.gif", "tooltip."); // show only an icon on the button and disable the button toolbar.addButton(null, feedback_button, [1, "2", "three"], "media:///yourimage.gif", "tooltip.", false); // add a separator toolbar.addSeparator(); // make the button non visible toolbar.addButton(null, feedback_button, [1, "2", "three"], "media:///yourimage.gif", "tooltip.",true, false); // and validate the changes // to make them know to the user interface) toolbar.validate(); {code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=A1B678C4-B59C-43E1-B0B9-C495023A116D}{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:A1B678C4-B59C-43E1-B0B9-C495023A116D_des|text=|trigger=button}{sub-section}{sub-section:A1B678C4-B59C-43E1-B0B9-C495023A116D_des|trigger=none|class=sIndent}Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:A1B678C4-B59C-43E1-B0B9-C495023A116D_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:A1B678C4-B59C-43E1-B0B9-C495023A116D_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:A1B678C4-B59C-43E1-B0B9-C495023A116D_ret|text=|trigger=button}{sub-section}{sub-section:A1B678C4-B59C-43E1-B0B9-C495023A116D_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:A1B678C4-B59C-43E1-B0B9-C495023A116D_see|text=|trigger=button}{sub-section}{sub-section:A1B678C4-B59C-43E1-B0B9-C495023A116D_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:A1B678C4-B59C-43E1-B0B9-C495023A116D_see|text=|trigger=button}{sub-section}{sub-section:A1B678C4-B59C-43E1-B0B9-C495023A116D_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:A1B678C4-B59C-43E1-B0B9-C495023A116D_sam|text=|trigger=button}{sub-section}{sub-section:A1B678C4-B59C-43E1-B0B9-C495023A116D_sam|class=sIndent|trigger=none}{code:language=javascript} // get the toolbar at the panel by name var toolbar = plugins.window.getToolBar("toolbar_1"); // enable/disable the selected item at the index // 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}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=1D530D93-B5E2-4631-96E4-FAA5F6D49632}{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:1D530D93-B5E2-4631-96E4-FAA5F6D49632_des|text=|trigger=button}{sub-section}{sub-section:1D530D93-B5E2-4631-96E4-FAA5F6D49632_des|trigger=none|class=sIndent}Remove all Buttons, Checkboxes etc. from the toolbar.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:1D530D93-B5E2-4631-96E4-FAA5F6D49632_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:1D530D93-B5E2-4631-96E4-FAA5F6D49632_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:1D530D93-B5E2-4631-96E4-FAA5F6D49632_ret|text=|trigger=button}{sub-section}{sub-section:1D530D93-B5E2-4631-96E4-FAA5F6D49632_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:1D530D93-B5E2-4631-96E4-FAA5F6D49632_see|text=|trigger=button}{sub-section}{sub-section:1D530D93-B5E2-4631-96E4-FAA5F6D49632_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:1D530D93-B5E2-4631-96E4-FAA5F6D49632_see|text=|trigger=button}{sub-section}{sub-section:1D530D93-B5E2-4631-96E4-FAA5F6D49632_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:1D530D93-B5E2-4631-96E4-FAA5F6D49632_sam|text=|trigger=button}{sub-section}{sub-section:1D530D93-B5E2-4631-96E4-FAA5F6D49632_sam|class=sIndent|trigger=none}{code:language=javascript} // get the toolbar at the panel by name var toolbar = plugins.window.getToolBar("toolbar_0"); // remove all buttons from the toolbar toolbar.removeAllItems(); {code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=847365F7-78EC-4DBE-B7DA-4D33A86703D1}{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:847365F7-78EC-4DBE-B7DA-4D33A86703D1_des|text=|trigger=button}{sub-section}{sub-section:847365F7-78EC-4DBE-B7DA-4D33A86703D1_des|trigger=none|class=sIndent}Remove a Button, CheckBox, ComboBox from the toolbar.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:847365F7-78EC-4DBE-B7DA-4D33A86703D1_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:847365F7-78EC-4DBE-B7DA-4D33A86703D1_prs|trigger=none}index {sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:847365F7-78EC-4DBE-B7DA-4D33A86703D1_ret|text=|trigger=button}{sub-section}{sub-section:847365F7-78EC-4DBE-B7DA-4D33A86703D1_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:847365F7-78EC-4DBE-B7DA-4D33A86703D1_see|text=|trigger=button}{sub-section}{sub-section:847365F7-78EC-4DBE-B7DA-4D33A86703D1_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:847365F7-78EC-4DBE-B7DA-4D33A86703D1_see|text=|trigger=button}{sub-section}{sub-section:847365F7-78EC-4DBE-B7DA-4D33A86703D1_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:847365F7-78EC-4DBE-B7DA-4D33A86703D1_sam|text=|trigger=button}{sub-section}{sub-section:847365F7-78EC-4DBE-B7DA-4D33A86703D1_sam|class=sIndent|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}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=C81ED829-FAFF-4FCC-AB08-201809BF6015}{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:C81ED829-FAFF-4FCC-AB08-201809BF6015_des|text=|trigger=button}{sub-section}{sub-section:C81ED829-FAFF-4FCC-AB08-201809BF6015_des|trigger=none|class=sIndent}Set the CheckBox selection.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:C81ED829-FAFF-4FCC-AB08-201809BF6015_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:C81ED829-FAFF-4FCC-AB08-201809BF6015_prs|trigger=none}index boolean {sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:C81ED829-FAFF-4FCC-AB08-201809BF6015_ret|text=|trigger=button}{sub-section}{sub-section:C81ED829-FAFF-4FCC-AB08-201809BF6015_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:C81ED829-FAFF-4FCC-AB08-201809BF6015_see|text=|trigger=button}{sub-section}{sub-section:C81ED829-FAFF-4FCC-AB08-201809BF6015_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:C81ED829-FAFF-4FCC-AB08-201809BF6015_see|text=|trigger=button}{sub-section}{sub-section:C81ED829-FAFF-4FCC-AB08-201809BF6015_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:C81ED829-FAFF-4FCC-AB08-201809BF6015_sam|text=|trigger=button}{sub-section}{sub-section:C81ED829-FAFF-4FCC-AB08-201809BF6015_sam|class=sIndent|trigger=none}{code:language=javascript} // get the toolbar at the panel by name
visible
toolbar.addButton(null, feedback_button, [1, "2", "three"], "media:///yourimage.gif", "tooltip", true, false);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idaddButton-String_Function_ObjectArray_Object_String_Boolean
Table Row (tr)
idname
Table Cell (td)

addButton

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
addButton
Span
(text, method, arguments, icon, tooltip, enabled)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Add a Button to the toolbar.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} text
{Function} method
{Object[]} arguments
{Object} icon
{String} tooltip
{Boolean} enabled
Table Row (tr)
idret
Table Cell (td)

Returns

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

Sample

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

addButton

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
addButton
Span
(text, method, arguments, icon, tooltip, enabled, visible)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Add a Button to the toolbar.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} text
{Function} method
{Object[]} arguments
{Object} icon
{String} tooltip
{Boolean} enabled
{Boolean} visible
Table Row (tr)
idret
Table Cell (td)

Returns

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

Sample

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

addCheckBox

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
addCheckBox
Span
(text, method)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Add a CheckBox to the toolbar.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} text
{Function} method
Table Row (tr)
idret
Table Cell (td)

Returns

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

Sample

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

addCheckBox

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
addCheckBox
Span
(text, method, selected)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Add a CheckBox to the toolbar.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} text
{Function} method
{Boolean} selected
Table Row (tr)
idret
Table Cell (td)

Returns

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

Sample

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

addCheckBox

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
addCheckBox
Span
(text, method, selected, tooltip)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Add a CheckBox to the toolbar.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} text
{Function} method
{Boolean} selected
{String} tooltip
Table Row (tr)
idret
Table Cell (td)

Returns

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

Sample

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

addCheckBox

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
addCheckBox
Span
(text, method, selected, tooltip, enabled)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Add a CheckBox to the toolbar.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} text
{Function} method
{Boolean} selected
{String} tooltip
{Boolean} enabled
Table Row (tr)
idret
Table Cell (td)

Returns

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

Sample

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

addCheckBox

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
addCheckBox
Span
(text, method, selected, tooltip, enabled, visible)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Add a CheckBox to the toolbar.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} text
{Function} method
{Boolean} selected
{String} tooltip
{Boolean} enabled
{Boolean} visible
Table Row (tr)
idret
Table Cell (td)

Returns

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

Sample

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

addComboBox

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
addComboBox
Span
(method, index, values)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Add a ComboBox to the toolbar.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Function} method
{Number} index
{String[]} values
Table Row (tr)
idret
Table Cell (td)

Returns

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

Sample

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

addComboBox

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
addComboBox
Span
(method, index, values, tooltip)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Add a ComboBox to the toolbar.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Function} method
{Number} index
{String[]} values
{String} tooltip
Table Row (tr)
idret
Table Cell (td)

Returns

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

Sample

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

addComboBox

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
addComboBox
Span
(method, index, values, tooltip, enabled)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Add a ComboBox to the toolbar.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Function} method
{Number} index
{String[]} values
{String} tooltip
{Boolean} enabled
Table Row (tr)
idret
Table Cell (td)

Returns

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

Sample

Div
classsIndent
Code Block
languagejavascript
// add a toolbar
var toolbar = plugins.window.
getToolBar
addToolBar("toolbar_
1
2");
// 
set
add 
the
a 
selection
combobox 
of
with the 
checkbox
attached 
at
method, 
the
selected index 
//
and 
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); {code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=496DBC04-96F7-4D7E-A784-AFC23F6D6EBD}{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:496DBC04-96F7-4D7E-A784-AFC23F6D6EBD_des|text=|trigger=button}{sub-section}{sub-section:496DBC04-96F7-4D7E-A784-AFC23F6D6EBD_des|trigger=none|class=sIndent}Select a row of the ComboBox via the index.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:496DBC04-96F7-4D7E-A784-AFC23F6D6EBD_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:496DBC04-96F7-4D7E-A784-AFC23F6D6EBD_prs|trigger=none}index rowindex {sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:496DBC04-96F7-4D7E-A784-AFC23F6D6EBD_ret|text=|trigger=button}{sub-section}{sub-section:496DBC04-96F7-4D7E-A784-AFC23F6D6EBD_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:496DBC04-96F7-4D7E-A784-AFC23F6D6EBD_see|text=|trigger=button}{sub-section}{sub-section:496DBC04-96F7-4D7E-A784-AFC23F6D6EBD_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:496DBC04-96F7-4D7E-A784-AFC23F6D6EBD_see|text=|trigger=button}{sub-section}{sub-section:496DBC04-96F7-4D7E-A784-AFC23F6D6EBD_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:496DBC04-96F7-4D7E-A784-AFC23F6D6EBD_sam|text=|trigger=button}{sub-section}{sub-section:496DBC04-96F7-4D7E-A784-AFC23F6D6EBD_sam|class=sIndent|trigger=none}{code:language=javascript} // get the toolbar at the panel by name var toolbar = plugins.window.getToolBar("toolbar_2"); // set the selection of the combobox at the index // 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); toolbar.selectComboBox(2, 0); {code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=723A6B9D-F411-416A-9D85-9D2DF32B75E8}{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:723A6B9D-F411-416A-9D85-9D2DF32B75E8_des|text=|trigger=button}{sub-section}{sub-section:723A6B9D-F411-416A-9D85-9D2DF32B75E8_des|trigger=none|class=sIndent}Set a (default) text of the field at the given index.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:723A6B9D-F411-416A-9D85-9D2DF32B75E8_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:723A6B9D-F411-416A-9D85-9D2DF32B75E8_prs|trigger=none}index text {sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:723A6B9D-F411-416A-9D85-9D2DF32B75E8_ret|text=|trigger=button}{sub-section}{sub-section:723A6B9D-F411-416A-9D85-9D2DF32B75E8_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:723A6B9D-F411-416A-9D85-9D2DF32B75E8_see|text=|trigger=button}{sub-section}{sub-section:723A6B9D-F411-416A-9D85-9D2DF32B75E8_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:723A6B9D-F411-416A-9D85-9D2DF32B75E8_see|text=|trigger=button}{sub-section}{sub-section:723A6B9D-F411-416A-9D85-9D2DF32B75E8_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:723A6B9D-F411-416A-9D85-9D2DF32B75E8_sam|text=|trigger=button}{sub-section}{sub-section:723A6B9D-F411-416A-9D85-9D2DF32B75E8_sam|class=sIndent|trigger=none}{code:language=javascript} // get the toolbar at the panel by name
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)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idaddComboBox-Function_Number_StringArray_String_Boolean_Boolean
Table Row (tr)
idname
Table Cell (td)

addComboBox

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
addComboBox
Span
(method, index, values, tooltip, enabled, visible)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Add a ComboBox to the toolbar.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Function} method
{Number} index
{String[]} values
{String} tooltip
{Boolean} enabled
{Boolean} visible
Table Row (tr)
idret
Table Cell (td)

Returns

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

Sample

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

addField

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
addField
Span
(method, text)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Add a Field to the toolbar.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Function} method
{String} text
Table Row (tr)
idret
Table Cell (td)

Returns

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

Sample

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

addField

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
addField
Span
(method, text, length)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Add a Field to the toolbar.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Function} method
{String} text
{Number} length
Table Row (tr)
idret
Table Cell (td)

Returns

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

Sample

Div
classsIndent
Code Block
languagejavascript
// add a toolbar
var toolbar = plugins.window.
getToolBar
addToolBar("toolbar_3");

//
set
 add a field with the attached 
text
method 
of
and 
the
a 
field
default 
at the index
text
toolbar.addField(feedback_field, null);
// 
REMARK:
set the 
pitfall
length 
here is that the indexes start at position 1 here
of the field.
// default length = 8 when length is not set or set to 0
toolbar.addField(feedback_field, "field", 0, "tooltip");
// 
position
add 
0
a 
is
tooltip 
reserved for
to the 
toolbar
field
handle!
toolbar.
setFieldText
addField(
1
feedback_field, 
"new text 1
null, 10, "tooltip");
// disable the field
toolbar.
setFieldText
addField(
2
feedback_field, "field"
new
, 
text
5, 
2
"tooltip"
); {code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=681C3832-065C-461F-9457-7CF1C7A5EE1E}{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:681C3832-065C-461F-9457-7CF1C7A5EE1E_des|text=|trigger=button}{sub-section}{sub-section:681C3832-065C-461F-9457-7CF1C7A5EE1E_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=prs}{td}*Parameters*\\{sub-section:681C3832-065C-461F-9457-7CF1C7A5EE1E_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:681C3832-065C-461F-9457-7CF1C7A5EE1E_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:681C3832-065C-461F-9457-7CF1C7A5EE1E_ret|text=|trigger=button}{sub-section}{sub-section:681C3832-065C-461F-9457-7CF1C7A5EE1E_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:681C3832-065C-461F-9457-7CF1C7A5EE1E_see|text=|trigger=button}{sub-section}{sub-section:681C3832-065C-461F-9457-7CF1C7A5EE1E_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:681C3832-065C-461F-9457-7CF1C7A5EE1E_see|text=|trigger=button}{sub-section}{sub-section:681C3832-065C-461F-9457-7CF1C7A5EE1E_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:681C3832-065C-461F-9457-7CF1C7A5EE1E_sam|text=|trigger=button}{sub-section}{sub-section:681C3832-065C-461F-9457-7CF1C7A5EE1E_sam|class=sIndent|trigger=none}{code:language=javascript} // get the toolbar at the panel by name
, false);
// make the field non visible
toolbar.addField(feedback_field, "field", 0, "tooltip", false, false);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idaddField-Function_String_Number_String
Table Row (tr)
idname
Table Cell (td)

addField

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
addField
Span
(method, text, length, tooltip)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Add a Field to the toolbar.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Function} method
{String} text
{Number} length
{String} tooltip
Table Row (tr)
idret
Table Cell (td)

Returns

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

Sample

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

addField

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
addField
Span
(method, text, length, tooltip, enabled)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Add a Field to the toolbar.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Function} method
{String} text
{Number} length
{String} tooltip
{Boolean} enabled
Table Row (tr)
idret
Table Cell (td)

Returns

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

Sample

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

addField

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
addField
Span
(method, text, length, tooltip, enabled, visible)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Add a Field to the toolbar.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Function} method
{String} text
{Number} length
{String} tooltip
{Boolean} enabled
{Boolean} visible
Table Row (tr)
idret
Table Cell (td)

Returns

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

Sample

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

addSeparator

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
addSeparator
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Add a Separator to the toolbar.
Table Row (tr)
idret
Table Cell (td)

Returns

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

Sample

Div
classsIndent
Code Block
languagejavascript
// add a toolbar
var toolbar = plugins.window.addToolBar("toolbar_0");
// add a button
toolbar.addButton("button", feedback_button);
// add a separator
toolbar.addSeparator();
// add a checkbox
toolbar.addCheckBox("checkbox", feedback_checkbox);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idenableItem-Number_Boolean
Table Row (tr)
idname
Table Cell (td)

enableItem

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
enableItem
Span
(index, enabled)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Enable/disable the item at the specified index.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Number} index
{Boolean} enabled
Table Row (tr)
idret
Table Cell (td)

Returns

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

Sample

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

removeAllItems

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
removeAllItems
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Remove all Buttons, Checkboxes etc. from the toolbar.
Table Row (tr)
idret
Table Cell (td)

Returns

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

Sample

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

removeItem

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
removeItem
Span
(index)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Remove a Button, CheckBox, ComboBox from the toolbar.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Number} index
Table Row (tr)
idret
Table Cell (td)

Returns

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

Sample

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

selectCheckBox

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
selectCheckBox
Span
(index, selected)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Set the CheckBox selection.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Number} index
{Boolean} selected
Table Row (tr)
idret
Table Cell (td)

Returns

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

Sample

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

selectComboBox

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
selectComboBox
Span
(index, selection)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Select a row of the ComboBox via the index.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Number} index
{Number} selection
Table Row (tr)
idret
Table Cell (td)

Returns

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

Sample

Div
classsIndent
Code Block
languagejavascript
// add a toolbar
var toolbar = plugins.window.
getToolBar
addToolBar("toolbar_
0
1");
// add a combobox
toolbar.addComboBox(feedback_combobox, 1, ["one", "two", "three"]);
//
remove the button, checkbox, combobox, separator or field from the toolbar
 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.
removeItem
selectComboBox(1, 0); 
//
and validate the changes
 entry "one" will be selected in the first combobox
toolbar.selectComboBox(2, 3); // entry 
to
4 
make
will 
them
be 
know
selected 
to
in the 
user interface) toolbar.validate(); {code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=2466312F-4A83-487C-95AB-8BFC43BC8D68}{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:2466312F-4A83-487C-95AB-8BFC43BC8D68_des|text=|trigger=button}{sub-section}{sub-section:2466312F-4A83-487C-95AB-8BFC43BC8D68_des|trigger=none|class=sIndent}Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:2466312F-4A83-487C-95AB-8BFC43BC8D68_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:2466312F-4A83-487C-95AB-8BFC43BC8D68_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:2466312F-4A83-487C-95AB-8BFC43BC8D68_ret|text=|trigger=button}{sub-section}{sub-section:2466312F-4A83-487C-95AB-8BFC43BC8D68_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:2466312F-4A83-487C-95AB-8BFC43BC8D68_see|text=|trigger=button}{sub-section}{sub-section:2466312F-4A83-487C-95AB-8BFC43BC8D68_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:2466312F-4A83-487C-95AB-8BFC43BC8D68_see|text=|trigger=button}{sub-section}{sub-section:2466312F-4A83-487C-95AB-8BFC43BC8D68_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:2466312F-4A83-487C-95AB-8BFC43BC8D68_sam|text=|trigger=button}{sub-section}{sub-section:2466312F-4A83-487C-95AB-8BFC43BC8D68_sam|class=sIndent|trigger=none}{code:language=javascript} // get the toolbar at the panel by name
second combobox
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idsetFieldText-Number_String
Table Row (tr)
idname
Table Cell (td)

setFieldText

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
setFieldText
Span
(index, text)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Set a (default) text of the field at the given index.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Number} index
{String} text
Table Row (tr)
idret
Table Cell (td)

Returns

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

Sample

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

visibleItem

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
visibleItem
Span
(index, visible)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Make the item at the specified index visible/invisible.
Table Row (tr)
idprs
Table Cell (td)

Parameters

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

Returns

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

Sample

Div
classsIndent
Code Block
languagejavascript
// 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}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}
Table Row (tr)
classlastDetailRow
Table Cell (td)