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
Method Summary
void
#setCallBackInfo()
Set callback method for node selection and double click
Set the dataprovider name to retrieve column name and sort order for the child nodes.
The provided data must be a string of form : column_name_used_for_sort sort_order(asc or desc)
Parameters dataprovider
Returns void
Sample
//Set the dataprovider name to retrieve column name and sort order for the child nodes.
The provided data must be a string of form : column_name_used_for_sort sort_order(asc or desc)
binding.setChildSortDataprovider('dataprovider');
setConfigurationDataprovider
void
setConfigurationDataprovider
(dataprovider)
Set configuration dataprovider. Dataprovider must be MEDIA type and returns a configuration object
Ex.:
var config = new Object();
config.text = 'my_text';
config.nRelation = 'my_n_relation';
config.mRelation = 'my_m_relation';
config.childSort = 'my_sort_field';
config.fontType = 'my_font';
config.toolTipText = 'my_tooltip';
config.hasCheckBox = 'true';
config.checkBoxValue = 'true';
Parameters dataprovider
Returns void
Sample
//Set configuration dataprovider. Dataprovider must be MEDIA type and returns a configuration object
Ex.:
var config = new Object();
config.text = 'my_text';
config.nRelation = 'my_n_relation';
config.mRelation = 'my_m_relation';
config.childSort = 'my_sort_field';
config.fontType = 'my_font';
config.toolTipText = 'my_tooltip';
config.hasCheckBox = 'true';
config.checkBoxValue = 'true';
binding.setConfigurationDataprovider('dataprovider');
setFontTypeDataprovider
void
setFontTypeDataprovider
(dataprovider)
Set the dataprovider name to retrieve the node font from
Parameters dataprovider
Returns void
Sample
binding.setFontTypeDataprovider('dataprovider');
setHasCheckBoxDataprovider
void
setHasCheckBoxDataprovider
(dataprovider)
Set has checkbox flag dataprovider. Dataprovider returns INTEGER (0 / 1 / 2) or STRING (false / true / disabled) for (does not have / have / have but disabled)
Set method to call on click.
The callback will be called with the following arguments : returnDataprovider, tableName, mouseX, mouseY
Parameters function
returnDataprovider
Returns void
Sample
//Set method to call on click.
The callback will be called with the following arguments : returnDataprovider, tableName, mouseX, mouseY
binding.setMethodToCallOnClick(callbackFunction, 'returnDataprovider');
setMethodToCallOnDoubleClick
void
setMethodToCallOnDoubleClick
(function, returnDataprovider)
Set method to call on double click.
The callback will be called with the following arguments : returnDataprovider, tableName, mouseX, mouseY
Parameters function
returnDataprovider
Returns void
Sample
//Set method to call on double click.
The callback will be called with the following arguments : returnDataprovider, tableName, mouseX, mouseY
binding.setMethodToCallOnDoubleClick(callbackFunction, 'returnDataprovider');
setMethodToCallOnRightClick
void
setMethodToCallOnRightClick
(function, returnDataprovider)
Set method to call on right click.
The callback will be called with the following arguments : returnDataprovider, tableName, mouseX, mouseY
Parameters function
returnDataprovider
Returns void
Sample
//Set method to call on right click.
The callback will be called with the following arguments : returnDataprovider, tableName, mouseX, mouseY
binding.setMethodToCallOnRightClick(callbackFunction, 'returnDataprovider');
setNRelationDataprovider
void
setNRelationDataprovider
(dataprovider)
Set n-relation dataprovider. Dataprovider returns the name of the n-relation
Parameters dataprovider
Returns void
Sample
binding.setNRelationDataprovider('dataprovider');
setNRelationInfos
void
setNRelationInfos
()
Set n-relation infos (array of RelationInfo objects created using tree.createRelationInfo() for having multiple child relations for one node)
Returns void
Sample
var company_relations = new Array();
company_relations[0] = tree.createRelationInfo();
company_relations[0].setLabel('Employees');
company_relations[0].setNRelationName('companies_to_employees');
company_relations[1] = tree.createRelationInfo();
company_relations[1].setLabel('Customers');
company_relations[1].setNRelationName('companies_to_customers');
binding.setNRelationInfos(company_relations);