Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3
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.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
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_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
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.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_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.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
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.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)
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.addToolBar("toolbar_1");
// add a button
toolbar.addButton("button", feedback_button);
// add a checkbox
toolbar.addCheckBox("checkbox", feedback_checkbox);
// make the first item (the button) 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);
Table Row (tr)
classlastDetailRow
Table Cell (td)