Child pages
  • Binding

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)
#setCallBackInfo()
Set callback method for node selection and double click
Table Body (tbody)
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
#setCheckBoxValueDataprovider(dataprovider)
Set checkbox value dataprovider.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
#setChildSortDataprovider(dataprovider)
Set the dataprovider name to retrieve column name and sort order for the child nodes.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
#setConfigurationDataprovider(dataprovider)
Set configuration dataprovider.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
#setFontTypeDataprovider(dataprovider)
Set the dataprovider name to retrieve the node font from
Table Body (tbody)
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
#setHasCheckBoxDataprovider(dataprovider)
Set has checkbox flag dataprovider.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
#setImageMediaDataprovider(dataprovider)
Set the dataprovider name to retrieve the node image from (blob column)
Table Body (tbody)
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
#setImageURLDataprovider(dataprovider)
Set the dataprovider name to retrieve the node image from (via url)
Table Body (tbody)
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
#setMRelationDataprovider(dataprovider)
Set m-relation dataprovider.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
#setMRelationName(relation)
Set m-relation name
Table Body (tbody)
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
#setMethodToCallOnCheckBoxChange(function, returnDataprovider)
Set method to call on check box status change
Table Body (tbody)
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
#setMethodToCallOnClick(function, returnDataprovider)
Set method to call on click.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
#setMethodToCallOnDoubleClick(function, returnDataprovider)
Set method to call on double click.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
#setMethodToCallOnRightClick(function, returnDataprovider)
Set method to call on right click.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
#setNRelationDataprovider(dataprovider)
Set n-relation dataprovider.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
#setNRelationInfos()
Set n-relation infos (array of RelationInfo objects created using tree.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
#setNRelationName(relation)
Set n-relation name
Table Body (tbody)
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
#setTextDataprovider(dataprovider)
Set text dataprovider
Table Body (tbody)
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
#setToolTipTextDataprovider(dataprovider)
Set text dataprovider

HTML Table
idfunction
classservoy sDetail
Colgroup Tag
Column
padding0px
width100%

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan1
Method Details
Table Body (tbody)
idsetCallBackInfo
classnode
Table Row (tr)
idname
Table Cell (td)
setCallBackInfo
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
void
Span
stylefloat: left; font-weight: bold;
idiets
setCallBackInfo
Span
stylefloat: left;
idiets
()
Table Row (tr)
iddes
Table Cell (td)
Set callback method for node selection and double click
Table Row (tr)
idret
Table Cell (td)
Returns
void
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
binding.setCallBackInfo(callbackFunction, 'returnDataprovider');
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idsetCheckBoxValueDataprovider
classnode
Table Row (tr)
idname
Table Cell (td)
setCheckBoxValueDataprovider
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
void
Span
stylefloat: left; font-weight: bold;
idiets
setCheckBoxValueDataprovider
Span
stylefloat: left;
idiets
(dataprovider)
Table Row (tr)
iddes
Table Cell (td)
Set checkbox value dataprovider. Dataprovider returns INTEGER (0 or 1) or STRING (false or true)
Table Row (tr)
idprs
Table Cell (td)
Parameters
dataprovider
Table Row (tr)
idret
Table Cell (td)
Returns
void
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
binding.setCheckBoxValueDataprovider('dataprovider');
Table Row (tr)
classlastDetailRow
Table Cell (td)

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

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

Table Body (tbody)
idsetFontTypeDataprovider
classnode
Table Row (tr)
idname
Table Cell (td)
setFontTypeDataprovider
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
void
Span
stylefloat: left; font-weight: bold;
idiets
setFontTypeDataprovider
Span
stylefloat: left;
idiets
(dataprovider)
Table Row (tr)
iddes
Table Cell (td)
Set the dataprovider name to retrieve the node font from
Table Row (tr)
idprs
Table Cell (td)
Parameters
dataprovider
Table Row (tr)
idret
Table Cell (td)
Returns
void
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
binding.setFontTypeDataprovider('dataprovider');
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idsetHasCheckBoxDataprovider
classnode
Table Row (tr)
idname
Table Cell (td)
setHasCheckBoxDataprovider
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
void
Span
stylefloat: left; font-weight: bold;
idiets
setHasCheckBoxDataprovider
Span
stylefloat: left;
idiets
(dataprovider)
Table Row (tr)
iddes
Table Cell (td)
Set has checkbox flag dataprovider. Dataprovider returns INTEGER (0 / 1 / 2) or STRING (false / true / disabled) for (does not have / have / have but disabled)
Table Row (tr)
idprs
Table Cell (td)
Parameters
dataprovider
Table Row (tr)
idret
Table Cell (td)
Returns
void
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
binding.setHasCheckBoxDataprovider('dataprovider');
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idsetImageMediaDataprovider
classnode
Table Row (tr)
idname
Table Cell (td)
setImageMediaDataprovider
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
void
Span
stylefloat: left; font-weight: bold;
idiets
setImageMediaDataprovider
Span
stylefloat: left;
idiets
(dataprovider)
Table Row (tr)
iddes
Table Cell (td)
Set the dataprovider name to retrieve the node image from (blob column)
Table Row (tr)
idprs
Table Cell (td)
Parameters
dataprovider
Table Row (tr)
idret
Table Cell (td)
Returns
void
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
binding.setImageMediaDataprovider('dataprovider');
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idsetImageURLDataprovider
classnode
Table Row (tr)
idname
Table Cell (td)
setImageURLDataprovider
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
void
Span
stylefloat: left; font-weight: bold;
idiets
setImageURLDataprovider
Span
stylefloat: left;
idiets
(dataprovider)
Table Row (tr)
iddes
Table Cell (td)
Set the dataprovider name to retrieve the node image from (via url)
Table Row (tr)
idprs
Table Cell (td)
Parameters
dataprovider
Table Row (tr)
idret
Table Cell (td)
Returns
void
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
binding.setImageURLDataprovider('dataprovider');
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idsetMRelationDataprovider
classnode
Table Row (tr)
idname
Table Cell (td)
setMRelationDataprovider
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
void
Span
stylefloat: left; font-weight: bold;
idiets
setMRelationDataprovider
Span
stylefloat: left;
idiets
(dataprovider)
Table Row (tr)
iddes
Table Cell (td)
Set m-relation dataprovider. Dataprovider returns the name of the m-relation
Table Row (tr)
idprs
Table Cell (td)
Parameters
dataprovider
Table Row (tr)
idret
Table Cell (td)
Returns
void
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
binding.setMRelationDataprovider('dataprovider');
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idsetMRelationName
classnode
Table Row (tr)
idname
Table Cell (td)
setMRelationName
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
void
Span
stylefloat: left; font-weight: bold;
idiets
setMRelationName
Span
stylefloat: left;
idiets
(relation)
Table Row (tr)
iddes
Table Cell (td)
Set m-relation name
Table Row (tr)
idprs
Table Cell (td)
Parameters
relation
Table Row (tr)
idret
Table Cell (td)
Returns
void
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
binding.setMRelationName('relation');
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idsetMethodToCallOnCheckBoxChange
classnode
Table Row (tr)
idname
Table Cell (td)
setMethodToCallOnCheckBoxChange
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
void
Span
stylefloat: left; font-weight: bold;
idiets
setMethodToCallOnCheckBoxChange
Span
stylefloat: left;
idiets
(function, returnDataprovider)
Table Row (tr)
iddes
Table Cell (td)
Set method to call on check box status change
Table Row (tr)
idprs
Table Cell (td)
Parameters
function
returnDataprovider
Table Row (tr)
idret
Table Cell (td)
Returns
void
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
binding.setMethodToCallOnCheckBoxChange(callbackFunction, 'returnDataprovider');
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idsetMethodToCallOnClick
classnode
Table Row (tr)
idname
Table Cell (td)
setMethodToCallOnClick
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
void
Span
stylefloat: left; font-weight: bold;
idiets
setMethodToCallOnClick
Span
stylefloat: left;
idiets
(function, returnDataprovider)
Table Row (tr)
iddes
Table Cell (td)
Set method to call on click.
The callback will be called with the following arguments : returnDataprovider, tableName, mouseX, mouseY
Table Row (tr)
idprs
Table Cell (td)
Parameters
function
returnDataprovider
Table Row (tr)
idret
Table Cell (td)
Returns
void
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
//Set method to call on click.
The callback will be called with the following arguments : returnDataprovider, tableName, mouseX, mouseY
binding.setMethodToCallOnClick(callbackFunction, 'returnDataprovider');
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idsetMethodToCallOnDoubleClick
classnode
Table Row (tr)
idname
Table Cell (td)
setMethodToCallOnDoubleClick
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
void
Span
stylefloat: left; font-weight: bold;
idiets
setMethodToCallOnDoubleClick
Span
stylefloat: left;
idiets
(function, returnDataprovider)
Table Row (tr)
iddes
Table Cell (td)
Set method to call on double click.
The callback will be called with the following arguments : returnDataprovider, tableName, mouseX, mouseY
Table Row (tr)
idprs
Table Cell (td)
Parameters
function
returnDataprovider
Table Row (tr)
idret
Table Cell (td)
Returns
void
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
//Set method to call on double click.
The callback will be called with the following arguments : returnDataprovider, tableName, mouseX, mouseY
binding.setMethodToCallOnDoubleClick(callbackFunction, 'returnDataprovider');
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idsetMethodToCallOnRightClick
classnode
Table Row (tr)
idname
Table Cell (td)
setMethodToCallOnRightClick
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
void
Span
stylefloat: left; font-weight: bold;
idiets
setMethodToCallOnRightClick
Span
stylefloat: left;
idiets
(function, returnDataprovider)
Table Row (tr)
iddes
Table Cell (td)
Set method to call on right click.
The callback will be called with the following arguments : returnDataprovider, tableName, mouseX, mouseY
Table Row (tr)
idprs
Table Cell (td)
Parameters
function
returnDataprovider
Table Row (tr)
idret
Table Cell (td)
Returns
void
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
//Set method to call on right click.
The callback will be called with the following arguments : returnDataprovider, tableName, mouseX, mouseY
binding.setMethodToCallOnRightClick(callbackFunction, 'returnDataprovider');
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idsetNRelationDataprovider
classnode
Table Row (tr)
idname
Table Cell (td)
setNRelationDataprovider
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
void
Span
stylefloat: left; font-weight: bold;
idiets
setNRelationDataprovider
Span
stylefloat: left;
idiets
(dataprovider)
Table Row (tr)
iddes
Table Cell (td)
Set n-relation dataprovider. Dataprovider returns the name of the n-relation
Table Row (tr)
idprs
Table Cell (td)
Parameters
dataprovider
Table Row (tr)
idret
Table Cell (td)
Returns
void
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
binding.setNRelationDataprovider('dataprovider');
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idsetNRelationInfos
classnode
Table Row (tr)
idname
Table Cell (td)
setNRelationInfos
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
void
Span
stylefloat: left; font-weight: bold;
idiets
setNRelationInfos
Span
stylefloat: left;
idiets
()
Table Row (tr)
iddes
Table Cell (td)
Set n-relation infos (array of RelationInfo objects created using tree.createRelationInfo() for having multiple child relations for one node)
Table Row (tr)
idret
Table Cell (td)
Returns
void
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
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);
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idsetNRelationName
classnode
Table Row (tr)
idname
Table Cell (td)
setNRelationName
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
void
Span
stylefloat: left; font-weight: bold;
idiets
setNRelationName
Span
stylefloat: left;
idiets
(relation)
Table Row (tr)
iddes
Table Cell (td)
Set n-relation name
Table Row (tr)
idprs
Table Cell (td)
Parameters
relation
Table Row (tr)
idret
Table Cell (td)
Returns
void
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
binding.setNRelationName('relation');
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idsetTextDataprovider
classnode
Table Row (tr)
idname
Table Cell (td)
setTextDataprovider
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
void
Span
stylefloat: left; font-weight: bold;
idiets
setTextDataprovider
Span
stylefloat: left;
idiets
(dataprovider)
Table Row (tr)
iddes
Table Cell (td)
Set text dataprovider
Table Row (tr)
idprs
Table Cell (td)
Parameters
dataprovider
Table Row (tr)
idret
Table Cell (td)
Returns
void
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
binding.setTextDataprovider('dataprovider');
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idsetToolTipTextDataprovider
classnode
Table Row (tr)
idname
Table Cell (td)
setToolTipTextDataprovider
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
void
Span
stylefloat: left; font-weight: bold;
idiets
setToolTipTextDataprovider
Span
stylefloat: left;
idiets
(dataprovider)
Table Row (tr)
iddes
Table Cell (td)
Set text dataprovider
Table Row (tr)
idprs
Table Cell (td)
Parameters
dataprovider
Table Row (tr)
idret
Table Cell (td)
Returns
void
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
binding.setToolTipTextDataprovider('dataprovider');
Table Row (tr)
classlastDetailRow
Table Cell (td)