Table Row (tr) |
---|
| Table Head (th) |
---|
| Method Details |
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| void |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| addButton |
Span |
---|
| (text, method, [arguments], [icon], [tooltip], [enabled], [visible]) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Add a Button to the toolbar. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters text method [arguments] [icon] [tooltip] [enabled] [visible] |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns void |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
// 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 Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| void |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| addCheckBox |
Span |
---|
| (text, method, [selected], [tooltip], [enabled], [visible]) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Add a CheckBox to the toolbar. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters text method [selected] [tooltip] [enabled] [visible] |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns void |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
// 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 Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| void |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| addComboBox |
Span |
---|
| (method, index, input, [tooltip], [enabled], [visible]) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Add a ComboBox to the toolbar. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters method index input [tooltip] [enabled] [visible] |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns void |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
// 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 Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| void |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| addField |
Span |
---|
| (method, text, [tooltip], [enabled], [visible]) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Add a Field to the toolbar. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters method text [tooltip] [enabled] [visible] |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns void |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
// 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 Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| void |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| addSeparator |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Add a Separator to the toolbar. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns void |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
// 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 Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| void |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| enableItem |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Replace with description |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns void |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
// 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 Body (tbody) |
---|
id | removeAllItems |
---|
class | node |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| void |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| removeAllItems |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Remove all Buttons, Checkboxes etc. from the toolbar. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns void |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
// get the toolbar at the panel by name
var toolbar = plugins.window.getToolBar("toolbar_0");
// remove all buttons from the toolbar
toolbar.removeAllItems();
|
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| void |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| removeItem |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Remove a Button, CheckBox, ComboBox from the toolbar. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters index |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns void |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
// 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 Body (tbody) |
---|
id | selectCheckBox |
---|
class | node |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| void |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| selectCheckBox |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Set the CheckBox selection. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters index boolean |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns void |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
// 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 Body (tbody) |
---|
id | selectComboBox |
---|
class | node |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| void |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| selectComboBox |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Select a row of the ComboBox via the index. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters index rowindex |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns void |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
// 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 Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
setFieldText |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| void |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| setFieldText |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Set a (default) text of the field at the given index. |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters index text |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns void |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
// 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 Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
style | float: left; margin-right: 5px; |
---|
| void |
Span |
---|
style | float: left; font-weight: bold; |
---|
id | iets |
---|
| visibleItem |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Replace with description |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns void |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
// 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);
|
|
|
|
|
|