Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3
Div
styledisplay: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.

Div
iddescription



HTML Table
id
classservoy sSummary
Colgroup Tag
Col
width80px
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Method Summary
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
setCallBackInfo(f, returnDataprovider)
Set callback method for node selection and double click
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
setCheckBoxValueDataprovider(checkBoxValueDataprovider)
Set checkbox value dataprovider.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
setChildSortDataprovider(childSortDataprovider)
Set the dataprovider name to retrieve column name and sort order for the child nodes.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
setConfigurationDataprovider(configurationDataprovider)
Set configuration dataprovider.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
setFontTypeDataprovider(fontTypeDataprovider)
Set the dataprovider name to retrieve the node font from
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
setHasCheckBoxDataprovider(hasCheckBoxDataprovider)
Set has checkbox flag dataprovider.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
setImageMediaDataprovider(imageMediaDataprovider)
Set the dataprovider name to retrieve the node image from (blob column)
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
setImageURLDataprovider(imageURLDataprovider)
Set the dataprovider name to retrieve the node image from (via url)
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
setMRelationDataprovider(dataprovider)
Set m-relation dataprovider.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
setMRelationName(name)
Set m-relation name
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
setMethodToCallOnCheckBoxChange(methodToCallOnCheckBoxChange, returnDataproviderOnCheckBoxChange)
Set method to call on check box status change
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
setMethodToCallOnClick(methodToCallOnClick, returnDataproviderOnClick)
Set method to call on click.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
setMethodToCallOnDoubleClick(methodToCallOnDoubleClick, returnDataproviderOnDoubleClick)
Set method to call on double click.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
setMethodToCallOnRightClick(methodToCallOnRightClick, returnDataproviderOnRightClick)
Set method to call on right click.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
setNRelationDataprovider(dataprovider)
Set n-relation dataprovider.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
setNRelationInfos(relationInfos)
Set n-relation infos (array of RelationInfo objects created using tree.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
setNRelationName(name)
Set n-relation name
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
setTextDataprovider(textDataprovider)
Set text dataprovider
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
setToolTipTextDataprovider(toolTipTextDataprovider)
Set the dataprovider name to retrieve the node tooltiptext from



HTML Table
idfunction
classservoy sDetail
Colgroup Tag
Col
colspan2
width100%
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Method Details
Table Body (tbody)
idsetCallBackInfo-Function_String
Table Row (tr)
idname
Table Cell (td)

setCallBackInfo

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
setCallBackInfo
Span
(f, returnDataprovider)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Set callback method for node selection and double click
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Function} f
{String} returnDataprovider
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var binding = elements.dbtreeview.createBinding(controller.getServerName(), controller.getTableName());
binding.setCallBackInfo(globals.node_selected, 'node_id');
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idsetCheckBoxValueDataprovider-String
Table Row (tr)
idname
Table Cell (td)

setCheckBoxValueDataprovider

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
setCheckBoxValueDataprovider
Span
(checkBoxValueDataprovider)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Set checkbox value dataprovider. Dataprovider returns INTEGER (0 or 1) or STRING (false or true)
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} checkBoxValueDataprovider
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var binding = elements.dbtreeview.createBinding(controller.getServerName(), controller.getTableName());
binding.setCheckBoxValueDataprovider('comment_text');
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idsetChildSortDataprovider-String
Table Row (tr)
idname
Table Cell (td)

setChildSortDataprovider

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
setChildSortDataprovider
Span
(childSortDataprovider)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Set the dataprovider name to retrieve column name and sort order for the child nodes.\nThe 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

Div
classsIndent
{String} childSortDataprovider
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var binding = elements.dbtreeview.createBinding(controller.getServerName(), 'customers');
binding.setChildSortDataprovider('company_sort');
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idsetConfigurationDataprovider-String
Table Row (tr)
idname
Table Cell (td)

setConfigurationDataprovider

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
setConfigurationDataprovider
Span
(configurationDataprovider)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Set configuration dataprovider. Dataprovider must be MEDIA type and returns a configuration object
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} configurationDataprovider
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
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)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idsetFontTypeDataprovider-String
Table Row (tr)
idname
Table Cell (td)

setFontTypeDataprovider

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
setFontTypeDataprovider
Span
(fontTypeDataprovider)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Set the dataprovider name to retrieve the node font from
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} fontTypeDataprovider
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var binding = elements.dbtreeview.createBinding(controller.getServerName(), controller.getTableName());
binding.setFontTypeDataprovider('bean_font');
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idsetHasCheckBoxDataprovider-String
Table Row (tr)
idname
Table Cell (td)

setHasCheckBoxDataprovider

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
setHasCheckBoxDataprovider
Span
(hasCheckBoxDataprovider)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
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

Div
classsIndent
{String} hasCheckBoxDataprovider
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var binding = elements.dbtreeview.createBinding(controller.getServerName(), controller.getTableName());
binding.setHasCheckBoxDataprovider('hasCheckBox');
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idsetImageMediaDataprovider-String
Table Row (tr)
idname
Table Cell (td)

setImageMediaDataprovider

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
setImageMediaDataprovider
Span
(imageMediaDataprovider)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Set the dataprovider name to retrieve the node image from (blob column)
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} imageMediaDataprovider
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var binding = elements.dbtreeview.createBinding(controller.getServerName(), 'customers');
binding.setImageMediaDataprovider('company_icon');
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idsetImageURLDataprovider-String
Table Row (tr)
idname
Table Cell (td)

setImageURLDataprovider

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
setImageURLDataprovider
Span
(imageURLDataprovider)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Set the dataprovider name to retrieve the node image from (via url)
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} imageURLDataprovider
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var binding = elements.dbtreeview.createBinding(controller.getServerName(), 'orders');
binding.setImageURLDataprovider('order_icon');
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idsetMRelationDataprovider-String
Table Row (tr)
idname
Table Cell (td)

setMRelationDataprovider

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
setMRelationDataprovider
Span
(dataprovider)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Set m-relation dataprovider. Dataprovider returns the name of the m-relation
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} dataprovider
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var binding = elements.dbtreeview.createBinding(controller.getServerName(), controller.getTableName());
binding.setMRelationDataprovider('m_relation');
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idsetMRelationName-String
Table Row (tr)
idname
Table Cell (td)

setMRelationName

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
setMRelationName
Span
(name)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Set m-relation name
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} name
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var binding = elements.dbtreeview.createBinding(controller.getServerName(), controller.getTableName());
binding.setMRelationName('m_relation_name');
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idsetMethodToCallOnCheckBoxChange-Function_String
Table Row (tr)
idname
Table Cell (td)

setMethodToCallOnCheckBoxChange

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
setMethodToCallOnCheckBoxChange
Span
(methodToCallOnCheckBoxChange, returnDataproviderOnCheckBoxChange)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Set method to call on check box status change
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Function} methodToCallOnCheckBoxChange
{String} returnDataproviderOnCheckBoxChange
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var binding = elements.dbtreeview.createBinding(controller.getServerName(), 'orders');
binding.setMethodToCallOnCheckBoxChange(onCheckBoxChangeMethod,'orderdate');
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idsetMethodToCallOnClick-Function_String
Table Row (tr)
idname
Table Cell (td)

setMethodToCallOnClick

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
setMethodToCallOnClick
Span
(methodToCallOnClick, returnDataproviderOnClick)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Set method to call on click.\nThe callback will be called with the following arguments : returnDataprovider, tableName, mouseX, mouseY
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Function} methodToCallOnClick
{String} returnDataproviderOnClick
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var binding = elements.dbtreeview.createBinding(controller.getServerName(), 'orders');
binding.setMethodToCallOnClick(onClickMethod,'orderid');
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idsetMethodToCallOnDoubleClick-Function_String
Table Row (tr)
idname
Table Cell (td)

setMethodToCallOnDoubleClick

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
setMethodToCallOnDoubleClick
Span
(methodToCallOnDoubleClick, returnDataproviderOnDoubleClick)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Set method to call on double click.\nThe callback will be called with the following arguments : returnDataprovider, tableName, mouseX, mouseY
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Function} methodToCallOnDoubleClick
{String} returnDataproviderOnDoubleClick
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var binding = elements.dbtreeview.createBinding(controller.getServerName(), 'orders');
binding.setMethodToCallOnDoubleClick(doubleClickMethod,'orderid');
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idsetMethodToCallOnRightClick-Function_String
Table Row (tr)
idname
Table Cell (td)

setMethodToCallOnRightClick

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
setMethodToCallOnRightClick
Span
(methodToCallOnRightClick, returnDataproviderOnRightClick)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Set method to call on right click.\nThe callback will be called with the following arguments : returnDataprovider, tableName, mouseX, mouseY
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Function} methodToCallOnRightClick
{String} returnDataproviderOnRightClick
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var binding = elements.dbtreeview.createBinding(controller.getServerName(), 'orders');
binding.setMethodToCallOnRightClick(rightClickMethod,'orderid');
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idsetNRelationDataprovider-String
Table Row (tr)
idname
Table Cell (td)

setNRelationDataprovider

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
setNRelationDataprovider
Span
(dataprovider)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Set n-relation dataprovider. Dataprovider returns the name of the n-relation
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} dataprovider
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var binding = elements.dbtreeview.createBinding(controller.getServerName(), controller.getTableName());
binding.setNRelationDataprovider('n_relation');
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idsetNRelationInfos-RelationInfoArray
Table Row (tr)
idname
Table Cell (td)

setNRelationInfos

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
setNRelationInfos
Span
(relationInfos)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Set n-relation infos (array of RelationInfo objects created using tree.createRelationInfo() for having multiple child relations for one node)
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{RelationInfo[]} relationInfos
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
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-String
Table Row (tr)
idname
Table Cell (td)

setNRelationName

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
setNRelationName
Span
(name)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Set n-relation name
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} name
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var binding = elements.dbtreeview.createBinding(controller.getServerName(), controller.getTableName());
binding.setNRelationName('n_relation_name');
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idsetTextDataprovider-String
Table Row (tr)
idname
Table Cell (td)

setTextDataprovider

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
setTextDataprovider
Span
(textDataprovider)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Set text dataprovider
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} textDataprovider
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var binding = elements.dbtreeview.createBinding(controller.getServerName(), 'orders');
binding.setTextDataprovider('orderid');
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idsetToolTipTextDataprovider-String
Table Row (tr)
idname
Table Cell (td)

setToolTipTextDataprovider

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
setToolTipTextDataprovider
Span
(toolTipTextDataprovider)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Set the dataprovider name to retrieve the node tooltiptext from
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} toolTipTextDataprovider
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var binding = elements.dbtreeview.createBinding(controller.getServerName(), 'customers');
binding.setToolTipTextDataprovider('companyname');
Table Row (tr)
classlastDetailRow
Table Cell (td)