Child pages
  • ToolBar

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin
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


HTML Table
classservoy sSummary
Colgroup Tag
Column
padding0px
width80px

Column

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Method Summary
Table Body (tbody)
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 Body (tbody)
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
#addCheckBox(text, method, [selected], [tooltip], [enabled], [visible])
Add a CheckBox to the toolbar.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
#addComboBox(method, index, input, [tooltip], [enabled], [visible])
Add a ComboBox to the toolbar.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
#addField(method, text, [tooltip], [enabled], [visible])
Add a Field to the toolbar.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
#addSeparator()
Add a Separator to the toolbar.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
#enableItem()
Table Body (tbody)
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
#removeAllItems()
Remove all Buttons, Checkboxes etc.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
#removeItem(index)
Remove a Button, CheckBox, ComboBox from the toolbar.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
#selectCheckBox(index, boolean)
Set the CheckBox selection.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
#selectComboBox(index, rowindex)
Select a row of the ComboBox via the index.
Table Body (tbody)
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 Body (tbody)
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
#visibleItem()

HTML Table
idfunction
classservoy sDetail
Colgroup Tag
Column
padding0px
width100%

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan1
Method Details
Table Body (tbody)
idaddButton
classnode
Table Row (tr)
idname
Table Cell (td)
addButton
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
void
Span
stylefloat: left; font-weight: bold;
idiets
addButton
Span
stylefloat: left;
idiets
(text, method, [arguments], [icon], [tooltip], [enabled], [visible])
Table Row (tr)
iddes
Table Cell (td)
Add a Button to the toolbar.
Table Row (tr)
idprs
Table Cell (td)
Parameters
text
method
[arguments]
[icon]
[tooltip]
[enabled]
[visible]
Table Row (tr)
idret
Table Cell (td)
Returns
void
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
// 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();
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idaddCheckBox
classnode
Table Row (tr)
idname
Table Cell (td)
addCheckBox
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
void
Span
stylefloat: left; font-weight: bold;
idiets
addCheckBox
Span
stylefloat: left;
idiets
(text, method, [selected], [tooltip], [enabled], [visible])
Table Row (tr)
iddes
Table Cell (td)
Add a CheckBox to the toolbar.
Table Row (tr)
idprs
Table Cell (td)
Parameters
text
method
[selected]
[tooltip]
[enabled]
[visible]
Table Row (tr)
idret
Table Cell (td)
Returns
void
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
// 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();
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idaddComboBox
classnode
Table Row (tr)
idname
Table Cell (td)
addComboBox
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
void
Span
stylefloat: left; font-weight: bold;
idiets
addComboBox
Span
stylefloat: left;
idiets
(method, index, input, [tooltip], [enabled], [visible])
Table Row (tr)
iddes
Table Cell (td)
Add a ComboBox to the toolbar.
Table Row (tr)
idprs
Table Cell (td)
Parameters
method
index
input
[tooltip]
[enabled]
[visible]
Table Row (tr)
idret
Table Cell (td)
Returns
void
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
// add a toolbar with a name and internal name at the given row index
var toolbar = plugins.window.addToolBar("toolbar_2", "toolbar_2", 3);

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

// add a tooltip to the combobox
toolbar.addComboBox(feedback_button, 1, ["input","array","combobox",2], "tooltip");

// add a separator
toolbar.addSeparator();

// disable the combobox
toolbar.addComboBox(feedback_button, 2, ["input","array","combobox",3], "tooltip",false);

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

// and validate the changes
// to make them know to the user interface)
toolbar.validate();
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idaddField
classnode
Table Row (tr)
idname
Table Cell (td)
addField
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
void
Span
stylefloat: left; font-weight: bold;
idiets
addField
Span
stylefloat: left;
idiets
(method, text, [tooltip], [enabled], [visible])
Table Row (tr)
iddes
Table Cell (td)
Add a Field to the toolbar.
Table Row (tr)
idprs
Table Cell (td)
Parameters
method
text
[tooltip]
[enabled]
[visible]
Table Row (tr)
idret
Table Cell (td)
Returns
void
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
// 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();
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idaddSeparator
classnode
Table Row (tr)
idname
Table Cell (td)
addSeparator
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
void
Span
stylefloat: left; font-weight: bold;
idiets
addSeparator
Span
stylefloat: left;
idiets
()
Table Row (tr)
iddes
Table Cell (td)
Add a Separator to the toolbar.
Table Row (tr)
idret
Table Cell (td)
Returns
void
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
// 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();
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idenableItem
classnode
Table Row (tr)
idname
Table Cell (td)
enableItem
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
void
Span
stylefloat: left; font-weight: bold;
idiets
enableItem
Span
stylefloat: left;
idiets
()
Table Row (tr)
iddes
Table Cell (td)
Replace with description
Table Row (tr)
idret
Table Cell (td)
Returns
void
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
// 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);
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idremoveAllItems
classnode
Table Row (tr)
idname
Table Cell (td)
removeAllItems
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
void
Span
stylefloat: left; font-weight: bold;
idiets
removeAllItems
Span
stylefloat: left;
idiets
()
Table Row (tr)
iddes
Table Cell (td)
Remove all Buttons, Checkboxes etc. from the toolbar.
Table Row (tr)
idret
Table Cell (td)
Returns
void
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
// get the toolbar at the panel by name
var toolbar = plugins.window.getToolBar("toolbar_0");

// remove all buttons from the toolbar
toolbar.removeAllItems();
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idremoveItem
classnode
Table Row (tr)
idname
Table Cell (td)
removeItem
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
void
Span
stylefloat: left; font-weight: bold;
idiets
removeItem
Span
stylefloat: left;
idiets
(index)
Table Row (tr)
iddes
Table Cell (td)
Remove a Button, CheckBox, ComboBox from the toolbar.
Table Row (tr)
idprs
Table Cell (td)
Parameters
index
Table Row (tr)
idret
Table Cell (td)
Returns
void
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
// 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();
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idselectCheckBox
classnode
Table Row (tr)
idname
Table Cell (td)
selectCheckBox
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
void
Span
stylefloat: left; font-weight: bold;
idiets
selectCheckBox
Span
stylefloat: left;
idiets
(index, boolean)
Table Row (tr)
iddes
Table Cell (td)
Set the CheckBox selection.
Table Row (tr)
idprs
Table Cell (td)
Parameters
index
boolean
Table Row (tr)
idret
Table Cell (td)
Returns
void
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
// get the toolbar at the panel by name
var toolbar = plugins.window.getToolBar("toolbar_1");

// set the selection of the checkbox 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.selectCheckBox(1, false);
toolbar.selectCheckBox(2, true);
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idselectComboBox
classnode
Table Row (tr)
idname
Table Cell (td)
selectComboBox
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
void
Span
stylefloat: left; font-weight: bold;
idiets
selectComboBox
Span
stylefloat: left;
idiets
(index, rowindex)
Table Row (tr)
iddes
Table Cell (td)
Select a row of the ComboBox via the index.
Table Row (tr)
idprs
Table Cell (td)
Parameters
index
rowindex
Table Row (tr)
idret
Table Cell (td)
Returns
void
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
// 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);
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idsetFieldText
classnode
Table Row (tr)
idname
Table Cell (td)
setFieldText
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
void
Span
stylefloat: left; font-weight: bold;
idiets
setFieldText
Span
stylefloat: left;
idiets
(index, text)
Table Row (tr)
iddes
Table Cell (td)
Set a (default) text of the field at the given index.
Table Row (tr)
idprs
Table Cell (td)
Parameters
index
text
Table Row (tr)
idret
Table Cell (td)
Returns
void
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
// get the toolbar at the panel by name
var toolbar = plugins.window.getToolBar("toolbar_3");

// set the text of the field 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.setFieldText(1, "new text 1");
toolbar.setFieldText(2, "new text 2");
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idvisibleItem
classnode
Table Row (tr)
idname
Table Cell (td)
visibleItem
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
void
Span
stylefloat: left; font-weight: bold;
idiets
visibleItem
Span
stylefloat: left;
idiets
()
Table Row (tr)
iddes
Table Cell (td)
Replace with description
Table Row (tr)
idret
Table Cell (td)
Returns
void
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
// get the toolbar at the panel by name
var toolbar = plugins.window.getToolBar("toolbar_2");

// make the selected item at the index 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);
Table Row (tr)
classlastDetailRow
Table Cell (td)