Method forEachItem() calls a user-defined function for every existing item in the toolbar passing item's id into it. Using iterator can be very useful in case the user wants all the items to be subjects for the same changes.
<script> toolbar.forEachItem(function(itemId){}); // or function doWithItem(itemId){ // code here } toolbar.forEachItem(doWithItem); </script>
For example, let's write the code that will be responsible for disabling all toolbar items:
<script> toolbar.forEachItem(function(id){ toolbar.disableItem(id); }); </script>
Method forEachListOption() calls a user-defined function for every listed option of a certain Select Button in the toolbar passing listed option's id into it.
<script> toolbar.forEachListOption(itemId, function(listOptionId){}); // or function doWithListOption(listOptionId){ // code here } toolbar.forEachListOption(itemId, doWithListOption); </script>
The following methods can be applied to any item in the toolbar:
<script> toolbar.setPosition(itemId, pos); var position = toolbar.getPosition(itemId); // returns current item's position var itemType = toolbar.getType(itemId); // returns item's type </script>
To hide/show any button the user should pass button's id to the following methods:
<script> toolbar.showItem(id); toolbar.hideItem(id); </script>
The user has the possibility to check whether any button is visible. The method returns true if the button is visible:
<script> var isVisible = toolbar.isVisible(id); // returns true|false </script>
Any button in the toolbar can be enabled/disabled by user:
<script> toolbar.enableItem(id); toolbar.disableItem(id); </script>
Also the user has the possibility to check whether any button is enabled. This can be done by calling the following method:
<script> var isEnabled = toolbar.isEnabled(id); // returns true|false </scrip>
The user should pass id of the button that will be checked. The method returns true if the button is enabled, and false if it's disabled.
The user can set any button's text/label. This button's id and text of button's label are passed as parameters to the following method:
<script> toolbar.setItemText(id, text); </script>
The user can get button's text using getItemText() method. The method returns the current title text of the button:
<script> var text = toolbar.getItemText(id); // returns current item's text </script>
Any button in the toolbar can have its own image displayed in the button display area. setItemImage() and setItemImageDis() methods allow user to set image to a button by passing the following parameters:
<script> toolbar.setItemImage(id, url); toolbar.setItemImageDis(id, url); </scrip>
Button's image whether for the enabled or the disabled state can be easily removed/cleared by means of clearItemImage() and clearItemImageDis() methods to which the user should pass button's id:
<script> toolbar.clearItemImage(id); toolbar.clearItemImageDis(id); </script>
The user can specify the supplementary information regarding any button in the toolbar. setItemToolTip() method takes the following parameters:
<script> toolbar.setItemToolTip(id, tip); </script>
The following method can return the current button's tooltip text:
<script> var tip = toolbar.getItemToolTip(id); // returns current button's tooltip text </script>
The following methods that are available for the Button item, can be applied to the Select Button item as well:
All the parameters of the above mentioned methods are the same to those described in Button Settings Manipulations section.
A simple method is used to set this item's width:
<script> toolbar.setWidth(id, width); </script>
The parameters are:
A new Listed Option can be added using addListOption() method that accepts the following parameters:
<script> toolbar.addListOption(parentId, id, pos, type, text, img); </script>
Any Listed Option can be easily removed by calling the following method:
<script> toolbar.removeListOption(parentId,id); </script>
Any of the Listed Options can be shown/hidden if one of the following methods is applied to it:
<script> toolbar.showListOption(parentId, id); toolbar.hideListOption(parentId, id); </script>
The user has the possibility to check whether any Listed Option is visible. The method returns true if the item is visible:
<script> var isVisible = toolbar.isListOptionVisible(parentId, id); // returns true|false </script>
Any Listed Option in the toolbar can be enabled/disabled by user:
<script> toolbar.enableListOption(parentId, id); toolbar.disableListOption(parentId, id); </script>
Also the user has the possibility to check whether any Listed Option is enabled. This can be done by calling the following method:
<script> var isEnabled = toolbar.isListOptionEnabled(parentId, id); // returns true|false </script>
The user should pass parentId and id of the Listed Option that will be checked. The method returns true if the Listed Option is enabled.
The following methods can be used to set new position for a Listed Option and to get the current position of it:
<script> toolbar.setListOptionPosition(parentId, id, pos); var pos = toolbar.getListOptionPosition(parentId, id); </script>
The user can set any Listed Option's title. This item's parentId, id and title's text are passed as parameters to the following method:
<script> toolbar.setListOptionText(parentId, id, text); </script>
The user can get Listed Option's title using getListOptionText() method. The method returns the current title text of the item:
<script> var text = toolbar.getListOptionText(parentId, id); // returns current listed option's title text </script>
A Listed Option in the toolbar can have its own image displayed in the left part of item's display area. setListOptionImage() method allows the user to set image to a Listed Option by passing the following parameters:
<script> toolbar.setListOptionImage(parentId, id, img); </script>
Path to current listed option image can be got like this:
<script> var listOptionImage = toolbar.getListOptionImage(parentId, id); // returns path to the current listed option image </script>
Listed Option's image can be easily removed/cleared by means of clearListOptionImage() method to which the user should pass item's parentId and id as parameters:
<script> toolbar.clearListOptionImage(parentId, id); </script>
The user can specify the supplementary information regarding any Listed Option in the toolbar. setListOptionToolTip() method takes the following parameters:
<script> toolbar.setListOptionToolTip(parentId, id, tip); </scri>
The following method can return the current Listed Option's tooltip text:
<script> var tip = toolbar.getListOptionToolTip(parentId, id); // returns current listed option's tooltip text </scri>
The user can make any listed option selected by default from script. On startup, when the user first opens the list of options, this chosen listed option will be highlighted (selected). The method setListOptionSelected() takes the following parameters:
<script> toolbar.setListOptionSelected(parentId, id); </script>
This method doesn't make the listed option selected forever. Another listed option can be easily selected by user from page.
There is also the possibility to get the id of the current selected listed option by method getListOptionSelected():
<script> var listOptionId = toolbar.getListOptionSelected(parentId); //returns id of the selected listed option </script>
The parameter the user should pass to this method is id of the Select Button, which listed option's id the user wants to get.
Method getAllListOptions() allows the user to get all listed options ids of a certain Select Button. The only one parameter that the user should pass is the id of the chosen Select Button:
<script> var allListOptions = toolbar.getAllListOptions(parentId); // returns array of all listed options ids <script>
The following methods that are available for the Button item, can be applied to the Two-State Button item as well:
All the parameters of the above mentioned methods are the same to those described in Button Settings Manipulations section.
The user can set one of two states for the Two-State Button with the help of the following method:
<script> toolbar.setItemState(id, state, callEvent); </script>
The parameters for this method are the following:
There is also the possibility to get current item's state by calling getItemState() method:
<script> var isPressed = toolbar.getItemState(id); // returns true|false </script>
The method returns true in case the button is pressed, and false in case the button is released.
The following methods that are available for the Button item, can be applied to the Text Item as well:
All the parameters of the above mentioned methods are the same to those described in Button Settings Manipulations section.
The following methods that are available for the Button item, can be applied to the Separator as well:
All the parameters of the above mentioned methods are the same to those described in Button Settings Manipulations section.
The following methods that are available for the Button item, can be applied to the Slider as well:
All the parameters of the above mentioned methods are the same to those described in Button Settings Manipulations section.
Toltip template is applied only to Slider. The tooltip template can be represented in three ways:
setItemToolTipTemplate() method is used to set the tooltip template:
<script> toolbar.setItemToolTipTemplate(id, template); </script>
This method takes the following parameters:
For example, if the user wants his tooltip to show the text like this: “Current Value is:” plus the changeable text showing slider's values when the thumb is moved, the code must be the following:
<script> toolbar.setItemToolTipTemplate("slider","Current Value is:+%v"); </script>
The following method can return current slider's tooltip template:
<script> var template = toolbar.getItemToolTipTemplate(id); // returns current slider's tooltip text </script>
The user can set the Slider to a certain value within the range of available values with the help of the following method:
<script> toolbar.setValue(id,value,callEvent); </script>
The parameters are as follows:
Note: If the user has indicated the value that is not within the range of available values, the slider's thumb will be set either to the minimum or to the maximum value.
Slider's current value can be easily got by the following method:
<script> var value = toolbar.getValue(id); // returns slider's current value </script>
There is a method to set slider's minimum value:
<script> toolbar.setMinValue(id, value, label); </script>
The following parameters should be passed to this method:
Note: if the user wants the slider's minimum value to be created text-free, it's necessary to write an empty string as label parameter. For example:
<script> toolbar.setMinValue("slider", 25, ""); </script>
Slider's current minimum value can be got using getMinValue() method:
<script> var data = toolbar.getMinValue(id); // returns slider's current minimum value </script>
This method returns the following Array(value, label).
There is a method to set slider's maximum value:
<script> toolbar.setMaxValue(id,value,label); </script>
The following parameters should be passed to this method:
Note: if the user wants the slider's maximum value to be created text-free, it's necessary to write an empty string as label parameter. For example:
<script> toolbar.setMaxValue("slider", 25, ""); </script>
Slider's current maximum value can be got using getMaxValue() method:
<script> var data = toolbar.getMaxValue(id); // returns current maximum value </script>
This method returns the following Array(value, label).
The following methods that are available for the Button item, can be applied to the Input Item as well:
All the parameters of the above mentioned methods are the same to those described in Button Settings Manipulations section.
The following methods that are available for the Slider item, can be applied to the Input Item as well:
All the parameters of the above mentioned methods are the same to those described in Slider Settings Manipulations section. There's one more method applied to Select Button that can be applied to the Input Item as well:
All the parameters of the above mentioned method are the same to those described in Setting Select Button Width section.
The current input's width can be got with the help of getWidth() method:
<script> var width = toolbar.getWidth(id); // returns current input's width </script>