Page History
Wiki Markup |
---|
{div:style=display:none} DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY (EXCEPT INSIDE THE DIV BELOW WITH ID=DESCRIPTION), UNLESS YOU KNOW WHAT YOU'RE DOING. THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO AUTO UPDATE THE CONTENT THROUGH THE DOC GENERATOR.\\ \\ Enter additional information related to this 'class' inside the \{div} macro with 'id=description'{div} {div:id=description}{div}\\ {table:id=|class=servoy sSummary}{colgroup}{column:width=80px|padding=0px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Method Summary{th}{tr}{tbody}{tr}{td}void{td}{td}[#addButton]\(text, method) Add a Button to the toolbar.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#addButton]\(text, method, arguments) Add a Button to the toolbar.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#addButton]\(text, method, arguments, icon) Add a Button to the toolbar.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#addButton]\(text, method, arguments, icon, tooltip) Add a Button to the toolbar.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#addButton]\(text, method, arguments, icon, tooltip, enabled) Add a Button to the toolbar.{td}{tr}{tbody}{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) Add a CheckBox to the toolbar.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#addCheckBox]\(text, method, selected) Add a CheckBox to the toolbar.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#addCheckBox]\(text, method, selected, tooltip) Add a CheckBox to the toolbar.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#addCheckBox]\(text, method, selected, tooltip, enabled) Add a CheckBox 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, values) Add a ComboBox to the toolbar.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#addComboBox]\(method, index, values, tooltip) Add a ComboBox to the toolbar.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#addComboBox]\(method, index, values, tooltip, enabled) Add a ComboBox to the toolbar.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#addComboBox]\(method, index, values, tooltip, enabled, visible) Add a ComboBox to the toolbar.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#addField]\(method, text) Add a Field to the toolbar.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#addField]\(method, text, length) Add a Field to the toolbar.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#addField]\(method, text, length, tooltip) Add a Field to the toolbar.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#addField]\(method, text, length, tooltip, enabled) Add a Field to the toolbar.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#addField]\(method, text, length, 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]\(index, enabled) Enable/disable the item at the specified index.{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, selected) Set the CheckBox selection.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#selectComboBox]\(index, selection) 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}[#visibleItem]\(index, visible) Make the item at the specified index visible/invisible.{td}{tr}{tbody}{table}\\ {table:id=function|class=servoy sDetail}{colgroup}{column:width=100%|padding=0px}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Method Details{th}{tr}{tbody:id=addButton-String_Function}{tr:id=name}{td}h6.addButton{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}addButton{span}{span}\(text, method){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Add a Button to the toolbar.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} text \{[Function]} method {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} // create a new toolbar var toolbar = plugins.window.addToolBar('toolbar_0'); // add a button with a text and a method toolbar.addButton("button", feedback_button); // add an input array to the button for feedback in the selected method toolbar.addButton("button", feedback_button, [1, "2", "three"]); // add an icon to the button toolbar.addButton("button", feedback_button, [1, "2", "three"], "media:///yourimage.gif"); // add a tooltip to the button toolbar.addButton("button", feedback_button, [1, "2", "three"], "media:///yourimage.gif", "tooltip"); // show only an icon on the button and disable the button toolbar.addButton(null, feedback_button, [1, "2", "three"], "media:///yourimage.gif", "tooltip", false); // make the button non visible toolbar.addButton(null, feedback_button, [1, "2", "three"], "media:///yourimage.gif", "tooltip", true, false); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=addButton-String_Function_ObjectArray}{tr:id=name}{td}h6.addButton{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}addButton{span}{span}\(text, method, arguments){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Add a Button to the toolbar.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} text \{[Function]} method \{[Object]\[]} arguments {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} // create a new toolbar var toolbar = plugins.window.addToolBar('toolbar_0'); // add a button with a text and a method toolbar.addButton("button", feedback_button); // add an input array to the button for feedback in the selected method toolbar.addButton("button", feedback_button, [1, "2", "three"]); // add an icon to the button toolbar.addButton("button", feedback_button, [1, "2", "three"], "media:///yourimage.gif"); // add a tooltip to the button toolbar.addButton("button", feedback_button, [1, "2", "three"], "media:///yourimage.gif", "tooltip"); // show only an icon on the button and disable the button toolbar.addButton(null, feedback_button, [1, "2", "three"], "media:///yourimage.gif", "tooltip", false); // make the button non visible toolbar.addButton(null, feedback_button, [1, "2", "three"], "media:///yourimage.gif", "tooltip", true, false); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=addButton-String_Function_ObjectArray_Object}{tr:id=name}{td}h6.addButton{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}addButton{span}{span}\(text, method, arguments, icon){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Add a Button to the toolbar.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} text \{[Function]} method \{[Object]\[]} arguments \{[Object]} icon {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} // create a new toolbar var toolbar = plugins.window.addToolBar('toolbar_0'); // add a button with a text and a method toolbar.addButton("button", feedback_button); // add an input array to the button for feedback in the selected method toolbar.addButton("button", feedback_button, [1, "2", "three"]); // add an icon to the button toolbar.addButton("button", feedback_button, [1, "2", "three"], "media:///yourimage.gif"); // add a tooltip to the button toolbar.addButton("button", feedback_button, [1, "2", "three"], "media:///yourimage.gif", "tooltip"); // show only an icon on the button and disable the button toolbar.addButton(null, feedback_button, [1, "2", "three"], "media:///yourimage.gif", "tooltip", false); // make the button non visible toolbar.addButton(null, feedback_button, [1, "2", "three"], "media:///yourimage.gif", "tooltip", true, false); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=addButton-String_Function_ObjectArray_Object_String}{tr:id=name}{td}h6.addButton{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}addButton{span}{span}\(text, method, arguments, icon, tooltip){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Add a Button to the toolbar.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} text \{[Function]} method \{[Object]\[]} arguments \{[Object]} icon \{[String]} tooltip {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} // create a new toolbar var toolbar = plugins.window.addToolBar('toolbar_0'); // add a button with a text and a method toolbar.addButton("button", feedback_button); // add an input array to the button for feedback in the selected method toolbar.addButton("button", feedback_button, [1, "2", "three"]); // add an icon to the button toolbar.addButton("button", feedback_button, [1, "2", "three"], "media:///yourimage.gif"); // add a tooltip to the button toolbar.addButton("button", feedback_button, [1, "2", "three"], "media:///yourimage.gif", "tooltip"); // show only an icon on the button and disable the button toolbar.addButton(null, feedback_button, [1, "2", "three"], "media:///yourimage.gif", "tooltip", false); // make the button non visible toolbar.addButton(null, feedback_button, [1, "2", "three"], "media:///yourimage.gif", "tooltip", true, false); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=addButton-String_Function_ObjectArray_Object_String_Boolean}{tr:id=name}{td}h6.addButton{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}addButton{span}{span}\(text, method, arguments, icon, tooltip, enabled){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Add a Button to the toolbar.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} text \{[Function]} method \{[Object]\[]} arguments \{[Object]} icon \{[String]} tooltip \{[Boolean]} enabled {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} // create a new toolbar var toolbar = plugins.window.addToolBar('toolbar_0'); // add a button with a text and a method toolbar.addButton("button", feedback_button); // add an input array to the button for feedback in the selected method toolbar.addButton("button", feedback_button, [1, "2", "three"]); // add an icon to the button toolbar.addButton("button", feedback_button, [1, "2", "three"], "media:///yourimage.gif"); // add a tooltip to the button toolbar.addButton("button", feedback_button, [1, "2", "three"], "media:///yourimage.gif", "tooltip"); // show only an icon on the button and disable the button toolbar.addButton(null, feedback_button, [1, "2", "three"], "media:///yourimage.gif", "tooltip", false); // make the button non visible toolbar.addButton(null, feedback_button, [1, "2", "three"], "media:///yourimage.gif", "tooltip", true, false); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=addButton-String_Function_ObjectArray_Object_String_Boolean_Boolean}{tr:id=name}{td}h6.addButton{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}addButton{span}{span}\(text, method, arguments, icon, tooltip, enabled, visible){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Add a Button to the toolbar.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} text \{[Function]} method \{[Object]\[]} arguments \{[Object]} icon \{[String]} tooltip \{[Boolean]} enabled \{[Boolean]} visible {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} // create a new toolbar var toolbar = plugins.window.addToolBar('toolbar_0'); // add a button with a text and a method toolbar.addButton("button", feedback_button); // add an input array to the button for feedback in the selected method toolbar.addButton("button", feedback_button, [1, "2", "three"]); // add an icon to the button toolbar.addButton("button", feedback_button, [1, "2", "three"], "media:///yourimage.gif"); // add a tooltip to the button toolbar.addButton("button", feedback_button, [1, "2", "three"], "media:///yourimage.gif", "tooltip"); // show only an icon on the button and disable the button toolbar.addButton(null, feedback_button, [1, "2", "three"], "media:///yourimage.gif", "tooltip", false); // make the button non visible toolbar.addButton(null, feedback_button, [1, "2", "three"], "media:///yourimage.gif", "tooltip", true, false); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=addCheckBox-String_Function}{tr:id=name}{td}h6.addCheckBox{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}addCheckBox{span}{span}\(text, method){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Add a CheckBox to the toolbar.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} text \{[Function]} method {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} // add a toolbar var toolbar = plugins.window.addToolBar("toolbar_1"); // add a checkbox with a text and a method toolbar.addCheckBox("checkbox", feedback_checkbox); // add an checkbox and set it's state to selected (not selected by default) toolbar.addCheckBox("checkbox", feedback_checkbox, true); // add a tooltip to the checkbox toolbar.addCheckBox("checkbox", feedback_checkbox, false, "tooltip"); // disable the checkbox and select it toolbar.addCheckBox("checkbox", feedback_checkbox, true, "tooltip", false); // make the checkbox non visible toolbar.addCheckBox("checkbox", feedback_checkbox, false, "tooltip", false, false); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=addCheckBox-String_Function_Boolean}{tr:id=name}{td}h6.addCheckBox{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}addCheckBox{span}{span}\(text, method, selected){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Add a CheckBox to the toolbar.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} text \{[Function]} method \{[Boolean]} selected {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} // add a toolbar var toolbar = plugins.window.addToolBar("toolbar_1"); // add a checkbox with a text and a method toolbar.addCheckBox("checkbox", feedback_checkbox); // add an checkbox and set it's state to selected (not selected by default) toolbar.addCheckBox("checkbox", feedback_checkbox, true); // add a tooltip to the checkbox toolbar.addCheckBox("checkbox", feedback_checkbox, false, "tooltip"); // disable the checkbox and select it toolbar.addCheckBox("checkbox", feedback_checkbox, true, "tooltip", false); // make the checkbox non visible toolbar.addCheckBox("checkbox", feedback_checkbox, false, "tooltip", false, false); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=addCheckBox-String_Function_Boolean_String}{tr:id=name}{td}h6.addCheckBox{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}addCheckBox{span}{span}\(text, method, selected, tooltip){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Add a CheckBox to the toolbar.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} text \{[Function]} method \{[Boolean]} selected \{[String]} tooltip {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} // add a toolbar var toolbar = plugins.window.addToolBar("toolbar_1"); // add a checkbox with a text and a method toolbar.addCheckBox("checkbox", feedback_checkbox); // add an checkbox and set it's state to selected (not selected by default) toolbar.addCheckBox("checkbox", feedback_checkbox, true); // add a tooltip to the checkbox toolbar.addCheckBox("checkbox", feedback_checkbox, false, "tooltip"); // disable the checkbox and select it toolbar.addCheckBox("checkbox", feedback_checkbox, true, "tooltip", false); // make the checkbox non visible toolbar.addCheckBox("checkbox", feedback_checkbox, false, "tooltip", false, false); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=addCheckBox-String_Function_Boolean_String_Boolean}{tr:id=name}{td}h6.addCheckBox{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}addCheckBox{span}{span}\(text, method, selected, tooltip, enabled){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Add a CheckBox to the toolbar.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} text \{[Function]} method \{[Boolean]} selected \{[String]} tooltip \{[Boolean]} enabled {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} // add a toolbar var toolbar = plugins.window.addToolBar("toolbar_1"); // add a checkbox with a text and a method toolbar.addCheckBox("checkbox", feedback_checkbox); // add an checkbox and set it's state to selected (not selected by default) toolbar.addCheckBox("checkbox", feedback_checkbox, true); // add a tooltip to the checkbox toolbar.addCheckBox("checkbox", feedback_checkbox, false, "tooltip"); // disable the checkbox and select it toolbar.addCheckBox("checkbox", feedback_checkbox, true, "tooltip", false); // make the checkbox non visible toolbar.addCheckBox("checkbox", feedback_checkbox, false, "tooltip", false, false); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=addCheckBox-String_Function_Boolean_String_Boolean_Boolean}{tr:id=name}{td}h6.addCheckBox{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}addCheckBox{span}{span}\(text, method, selected, tooltip, enabled, visible){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Add a CheckBox to the toolbar.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} text \{[Function]} method \{[Boolean]} selected \{[String]} tooltip \{[Boolean]} enabled \{[Boolean]} visible {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} // add a toolbar var toolbar = plugins.window.addToolBar("toolbar_1"); // add a checkbox with a text and a method toolbar.addCheckBox("checkbox", feedback_checkbox); // add an checkbox and set it's state to selected (not selected by default) toolbar.addCheckBox("checkbox", feedback_checkbox, true); // add a tooltip to the checkbox toolbar.addCheckBox("checkbox", feedback_checkbox, false, "tooltip"); // disable the checkbox and select it toolbar.addCheckBox("checkbox", feedback_checkbox, true, "tooltip", false); // make the checkbox non visible toolbar.addCheckBox("checkbox", feedback_checkbox, false, "tooltip", false, false); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=addComboBox-Function_Number_StringArray}{tr:id=name}{td}h6.addComboBox{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}addComboBox{span}{span}\(method, index, values){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Add a ComboBox to the toolbar.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Function]} method \{[Number]} index \{[String]\[]} values {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} // add a toolbar var toolbar = plugins.window.addToolBar("toolbar_2"); // add a combobox with the attached method, selected index and input (list) array toolbar.addComboBox(feedback_combobox, 0, ["input","array","combobox",1]); // add a tooltip to the combobox toolbar.addComboBox(feedback_combobox, 1, ["input","array","combobox",2], "tooltip"); // disable the combobox toolbar.addComboBox(feedback_combobox, 2, ["input","array","combobox",3], "tooltip", false); // make the combobox non visible toolbar.addComboBox(feedback_combobox, 3, ["input","array","combobox",4], "tooltip", false, false); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=addComboBox-Function_Number_StringArray_String}{tr:id=name}{td}h6.addComboBox{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}addComboBox{span}{span}\(method, index, values, tooltip){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Add a ComboBox to the toolbar.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Function]} method \{[Number]} index \{[String]\[]} values \{[String]} tooltip {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} // add a toolbar var toolbar = plugins.window.addToolBar("toolbar_2"); // add a combobox with the attached method, selected index and input (list) array toolbar.addComboBox(feedback_combobox, 0, ["input","array","combobox",1]); // add a tooltip to the combobox toolbar.addComboBox(feedback_combobox, 1, ["input","array","combobox",2], "tooltip"); // disable the combobox toolbar.addComboBox(feedback_combobox, 2, ["input","array","combobox",3], "tooltip", false); // make the combobox non visible toolbar.addComboBox(feedback_combobox, 3, ["input","array","combobox",4], "tooltip", false, false); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=addComboBox-Function_Number_StringArray_String_Boolean}{tr:id=name}{td}h6.addComboBox{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}addComboBox{span}{span}\(method, index, values, tooltip, enabled){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Add a ComboBox to the toolbar.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Function]} method \{[Number]} index \{[String]\[]} values \{[String]} tooltip \{[Boolean]} enabled {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} // add a toolbar var toolbar = plugins.window.addToolBar("toolbar_2"); // add a combobox with the attached method, selected index and input (list) array toolbar.addComboBox(feedback_combobox, 0, ["input","array","combobox",1]); // add a tooltip to the combobox toolbar.addComboBox(feedback_combobox, 1, ["input","array","combobox",2], "tooltip"); // disable the combobox toolbar.addComboBox(feedback_combobox, 2, ["input","array","combobox",3], "tooltip", false); // make the combobox non visible toolbar.addComboBox(feedback_combobox, 3, ["input","array","combobox",4], "tooltip", false, false); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=addComboBox-Function_Number_StringArray_String_Boolean_Boolean}{tr:id=name}{td}h6.addComboBox{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}addComboBox{span}{span}\(method, index, values, tooltip, enabled, visible){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Add a ComboBox to the toolbar.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Function]} method \{[Number]} index \{[String]\[]} values \{[String]} tooltip \{[Boolean]} enabled \{[Boolean]} visible {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} // add a toolbar var toolbar = plugins.window.addToolBar("toolbar_2"); // add a combobox with the attached method, selected index and input (list) array toolbar.addComboBox(feedback_combobox, 0, ["input","array","combobox",1]); // add a tooltip to the combobox toolbar.addComboBox(feedback_combobox, 1, ["input","array","combobox",2], "tooltip"); // disable the combobox toolbar.addComboBox(feedback_combobox, 2, ["input","array","combobox",3], "tooltip", false); // make the combobox non visible toolbar.addComboBox(feedback_combobox, 3, ["input","array","combobox",4], "tooltip", false, false); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=addField-Function_String}{tr:id=name}{td}h6.addField{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}addField{span}{span}\(method, text){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Add a Field to the toolbar.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Function]} method \{[String]} text {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} // add a toolbar var toolbar = plugins.window.addToolBar("toolbar_3"); // add a field with the attached method and a default text toolbar.addField(feedback_field, null); // set the length of the field. // default length = 8 when length is not set or set to 0 toolbar.addField(feedback_field, "field", 0, "tooltip"); // add a tooltip to the field toolbar.addField(feedback_field, null, 10, "tooltip"); // disable the field toolbar.addField(feedback_field, "field", 5, "tooltip", false); // make the field non visible toolbar.addField(feedback_field, "field", 0, "tooltip", false, false); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=addField-Function_String_Number}{tr:id=name}{td}h6.addField{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}addField{span}{span}\(method, text, length){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Add a Field to the toolbar.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Function]} method \{[String]} text \{[Number]} length {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} // add a toolbar var toolbar = plugins.window.addToolBar("toolbar_3"); // add a field with the attached method and a default text toolbar.addField(feedback_field, null); // set the length of the field. // default length = 8 when length is not set or set to 0 toolbar.addField(feedback_field, "field", 0, "tooltip"); // add a tooltip to the field toolbar.addField(feedback_field, null, 10, "tooltip"); // disable the field toolbar.addField(feedback_field, "field", 5, "tooltip", false); // make the field non visible toolbar.addField(feedback_field, "field", 0, "tooltip", false, false); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=addField-Function_String_Number_String}{tr:id=name}{td}h6.addField{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}addField{span}{span}\(method, text, length, tooltip){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Add a Field to the toolbar.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Function]} method \{[String]} text \{[Number]} length \{[String]} tooltip {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} // add a toolbar var toolbar = plugins.window.addToolBar("toolbar_3"); // add a field with the attached method and a default text toolbar.addField(feedback_field, null); // set the length of the field. // default length = 8 when length is not set or set to 0 toolbar.addField(feedback_field, "field", 0, "tooltip"); // add a tooltip to the field toolbar.addField(feedback_field, null, 10, "tooltip"); // disable the field toolbar.addField(feedback_field, "field", 5, "tooltip", false); // make the field non visible toolbar.addField(feedback_field, "field", 0, "tooltip", false, false); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=addField-Function_String_Number_String_Boolean}{tr:id=name}{td}h6.addField{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}addField{span}{span}\(method, text, length, tooltip, enabled){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Add a Field to the toolbar.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Function]} method \{[String]} text \{[Number]} length \{[String]} tooltip \{[Boolean]} enabled {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} // add a toolbar var toolbar = plugins.window.addToolBar("toolbar_3"); // add a field with the attached method and a default text toolbar.addField(feedback_field, null); // set the length of the field. // default length = 8 when length is not set or set to 0 toolbar.addField(feedback_field, "field", 0, "tooltip"); // add a tooltip to the field toolbar.addField(feedback_field, null, 10, "tooltip"); // disable the field toolbar.addField(feedback_field, "field", 5, "tooltip", false); // make the field non visible toolbar.addField(feedback_field, "field", 0, "tooltip", false, false); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=addField-Function_String_Number_String_Boolean_Boolean}{tr:id=name}{td}h6.addField{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}addField{span}{span}\(method, text, length, tooltip, enabled, visible){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Add a Field to the toolbar.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Function]} method \{[String]} text \{[Number]} length \{[String]} tooltip \{[Boolean]} enabled \{[Boolean]} visible {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} // add a toolbar var toolbar = plugins.window.addToolBar("toolbar_3"); // add a field with the attached method and a default text toolbar.addField(feedback_field, null); // set the length of the field. // default length = 8 when length is not set or set to 0 toolbar.addField(feedback_field, "field", 0, "tooltip"); // add a tooltip to the field toolbar.addField(feedback_field, null, 10, "tooltip"); // disable the field toolbar.addField(feedback_field, "field", 5, "tooltip", false); // make the field non visible toolbar.addField(feedback_field, "field", 0, "tooltip", false, false); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=addSeparator}{tr:id=name}{td}h6.addSeparator{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}addSeparator{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Add a Separator to the toolbar.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} // 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); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=enableItem-Number_Boolean}{tr:id=name}{td}h6.enableItem{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}enableItem{span}{span}\(index, enabled){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Enable/disable the item at the specified index.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Number]} index \{[Boolean]} enabled {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} // add a toolbar var toolbar = plugins.window.addToolBar("toolbar_1"); // add a checkbox toolbar.addCheckBox("checkbox", feedback_checkbox); // disable the button // REMARK: the pitfall here is that the indexes start at position 1 here // position 0 is reserved for the toolbar handle! toolbar.enableItem(1, false); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=removeAllItems}{tr:id=name}{td}h6.removeAllItems{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}removeAllItems{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Remove all Buttons, Checkboxes etc. from the toolbar.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} // add a toolbar var toolbar = plugins.window.addToolBar("toolbar_1"); // add a button toolbar.addButton("button", feedback_button); // add a checkbox toolbar.addCheckBox("checkbox", feedback_checkbox); // remove all items from the toolbar toolbar.removeAllItems(); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=removeItem-Number}{tr:id=name}{td}h6.removeItem{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}removeItem{span}{span}\(index){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Remove a Button, CheckBox, ComboBox from the toolbar.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Number]} index {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} // add a toolbar var toolbar = plugins.window.addToolBar("toolbar_1"); // add a button toolbar.addButton("button", feedback_button); // add a checkbox toolbar.addCheckBox("checkbox", feedback_checkbox); // remove the first item (the button in this case) from the toolbar // REMARK: the pitfall here is that the indexes start at position 1 here // position 0 is reserved for the toolbar handle! toolbar.removeItem(1); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=selectCheckBox-Number_Boolean}{tr:id=name}{td}h6.selectCheckBox{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}selectCheckBox{span}{span}\(index, selected){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Set the CheckBox selection.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Number]} index \{[Boolean]} selected {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} // add a toolbar var toolbar = plugins.window.addToolBar("toolbar_1"); // add a checkbox toolbar.addCheckBox("checkbox 1", feedback_checkbox); // add another checkbox toolbar.addCheckBox("checkbox 2", feedback_checkbox); // set the selection of the checkboxes // REMARK: the pitfall here is that the indexes start at position 1 here // position 0 is reserved for the toolbar handle! toolbar.selectCheckBox(1, false); toolbar.selectCheckBox(2, true); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=selectComboBox-Number_Number}{tr:id=name}{td}h6.selectComboBox{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}selectComboBox{span}{span}\(index, selection){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Select a row of the ComboBox via the index.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Number]} index \{[Number]} selection {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} // add a toolbar var toolbar = plugins.window.addToolBar("toolbar_1"); // add a combobox toolbar.addComboBox(feedback_combobox, 1, ["one", "two", "three"]); // add another combobox toolbar.addComboBox(feedback_combobox, 2, [1, 2, 3, 4, 5]); // set the selection of the comboboxes // REMARK: the pitfall here is that the indexes start at position 1 here // position 0 is reserved for the toolbar handle! toolbar.selectComboBox(1, 0); // entry "one" will be selected in the first combobox toolbar.selectComboBox(2, 3); // entry 4 will be selected in the second combobox {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=setFieldText-Number_String}{tr:id=name}{td}h6.setFieldText{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}setFieldText{span}{span}\(index, text){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Set a (default) text of the field at the given index.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Number]} index \{[String]} text {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} // add a toolbar var toolbar = plugins.window.addToolBar("toolbar_1"); // add a field toolbar.addField(feedback_field, "field one"); // add another field toolbar.addField(feedback_field , "field_two"); // set the text of the fields // REMARK: the pitfall here is that the indexes start at position 1 here // position 0 is reserved for the toolbar handle! toolbar.setFieldText(1, "new text 1"); toolbar.setFieldText(2, "new text 2"); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=visibleItem-Number_Boolean}{tr:id=name}{td}h6.visibleItem{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}visibleItem{span}{span}\(index, visible){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Make the item at the specified index visible/invisible.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Number]} index \{[Boolean]} visible {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} // add a toolbar var toolbar = plugins.window.addToolBar("toolbar_1"); // add a button toolbar.addButton("button", feedback_button); // add a checkbox toolbar.addCheckBox("checkbox", feedback_checkbox); // 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); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table} |
Overview
Content Tools
Activity