DBTreeview

(part of package 'Servoy Extra Components') Extends designtime/SolutionModel: JSWebComponent Extends runtime: RuntimeWebComponent

This is a reference page; many components have detailed usage guides here.

Properties

allowDrag

Can be used to enable dragging of nodes. Can either be a boolean value or a clientfunction that is executed in browser. Default value is false.

Type: object

---

allowDrop

Can be used to enable dropping of nodes. Can either be a boolean value or a clientfunction that is executed in browser. Default value is false.

Type: object

---

autoRefresh

If true, component listens to foundset changes and updates itself while visible.

Type: boolean Default Value: true

---

enabled

Type: boolean Default Value: true

---

responsiveHeight

Height of the treeview, set only in responsive forms.

Type: int Default Value: 0

---

showLoadingIndicator

Type: boolean Default Value: true

---

styleClass

Type: styleclass

---

visible

Type: boolean Default Value: true

---

Events

onDrop(sourceNodePkPath,targetNodePkPath,indexInParent,event)

Called when a node is dropped as a result of a drag-n-drop

Parameters:

• {string[]} sourceNodePkPath

• {string[]} targetNodePkPath

• {int} indexInParent

• {JSEvent} event

---

onReady(event)

Parameters:

• {JSEvent} event

---

API

addRoots(root)

Add foundset to the list of foundsets used to create the tree's root nodes.

Example:

myElement.addRoots(foundset);

Parameters:

• {foundsetref} root ** foundSet

---

createRelationInfo(label,nRelationName)

Create relation info object used to set multiple child relations for a tree node

Parameters:

• {string} label ** label

• {string} nRelationName ** nRelationName

Returns: relationInfo

---

getCheckBoxValues(datasource)

@return {string[]}

Parameters:

• {string} datasource

Returns: string[]

---

getSelectionPath()

Returns path of the selected node.

Example:

var selection = myElement.getSelectionPath()

Returns: object[]

---

isNodeExpanded(pk)

Returns expand state of a node.

Example:

var expanded = myElement.isNodeExpanded([22])

Parameters:

• {object[]} pk ** pkarray array of each level id

Returns: boolean

---

refresh()

Refresh the tree display.

Example:

myElement.refresh()

---

removeAllRoots()

Clears all foundset roots of the tree.

Example:

myElement.removeAllRoots();

---

setActionsCallBack(actions)

Set callback info for specific actions.

Example:

myElement.setActionsCallBack([[datasource, function1, arg1, element1], [datasource, function2, arg2, element2]]);

Parameters:

• {action[]} actions ** actions

---

setCallBackInfo(datasource,callbackfunction,param)

Set callback info for a datasource foundset display.

Example:

myElement.setCallBackInfo(databaseManager.getDataSource('example_data', 'categories'),'myfunction','arg');

Parameters:

• {string} datasource ** datasource

• {function} callbackfunction ** callbackfunction callback function name

• {string} param ** param

---

setCheckBoxAutoselectsChildren(datasource,autoselect)

Set the nodes whose checkbox will automatically autoselect children.

Example:

myElement.setCheckBoxAutoselectsChildren(databaseManager.getDataSource('example_data', 'categories'),false);

Parameters:

• {string} datasource ** datasource

• {boolean} autoselect ** autoselect

---

setCheckBoxValueDataprovider(datasource,checkboxvaluedataprovider)

Set dataprovider for the checkbox displayed for a datasource foundset.

Example:

myElement.setCheckBoxValueDataprovider(databaseManager.getDataSource('example_data', 'categories'),'enabled');

Parameters:

• {string} datasource ** datasource

• {string} checkboxvaluedataprovider ** checkboxvaluedataprovider dataprovider of the displayed checkbox

---

setChildSortDataprovider(datasource,childsortdataprovider)

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)

Example:

myElement.setChildSortDataprovider(databaseManager.getDataSource('example_data', 'companies'),'company_sort');

Parameters:

• {string} datasource ** datasource

• {string} childsortdataprovider ** childsortdataprovider dataprovider of the sort text

---

setExpandNode(pk,state)

Sets expand state of a node.

Example:

myElement.setExpandNode([22],true)

Parameters:

• {object[]} pk ** pkarray array of each level id

• {boolean} state ** state expand state

---

setHasCheckBoxDataprovider(datasource,hascheckboxdataprovider)

Set relation for displaying a datasource foundset.

Example:

myElement.setNRelationName(databaseManager.getDataSource('example_data', 'categories'),'companies_to_categories');

Parameters:

• {string} datasource ** datasource

• {string} hascheckboxdataprovider ** nrelationname relation name

---

setHasCheckBoxValue(datasource,pks)

Set the nodes that should have checkbox for a datasource when no hascheckboxdataprovider is used

Example:

myElement.setHasCheckBoxValue(databaseManager.getDataSource('example_data', 'categories'),["1", "3", "5"]);

Parameters:

• {string} datasource ** datasource

• {string[]} pks ** hasCheckboxValue array of pks that should have checkbox

---

setImageURLDataprovider(datasource,imageurldataprovider)

Set dataprovider for the image displayed in tree node for a datasource foundset.

Example:

myElement.setImageURLDataprovider(databaseManager.getDataSource('example_data', 'categories'),'mymedia');

Parameters:

• {string} datasource ** datasource

• {string} imageurldataprovider ** imageurldataprovider dataprovider of the node image

---

setInitialCheckBoxValues(datasource,pks)

Set intial checked checkboxes for a datasource foundset when no checkboxdataprovider is used

Example:

myElement.setInitialCheckBoxValues(databaseManager.getDataSource('example_data', 'categories'),["1", "3", "5"]);

Parameters:

• {string} datasource ** datasource

• {string[]} pks ** checkboxValues array of pks that should have the checkbox checked

---

setMethodToCallOnCheckBoxChange(datasource,callbackfunction,param)

Set callback info for a datasource foundset checkbox display.

Example:

myElement.setMethodToCallOnCheckBoxChange(databaseManager.getDataSource('example_data', 'categories'),'myfunction','arg');

Parameters:

• {string} datasource ** datasource

• {function} callbackfunction ** callbackfunction callback function name

• {string} param ** param

---

setMethodToCallOnDoubleClick(datasource,callbackfunction,param)

Set callback info for a datasource foundset doubleclick event.

Example:

myElement.setMethodToCallOnDoubleClick(databaseManager.getDataSource('example_data', 'categories'),'myfunction','arg');

Parameters:

• {string} datasource ** datasource

• {function} callbackfunction ** callbackfunction callback function name

• {string} param ** param

---

setMethodToCallOnRightClick(datasource,callbackfunction,param)

Set callback info for a datasource foundset right click event.

Example:

myElement.setMethodToCallOnRightClick(databaseManager.getDataSource('example_data', 'categories'),'myfunction','arg');

Parameters:

• {string} datasource ** datasource

• {function} callbackfunction ** callbackfunction callback function name

• {string} param ** param

---

setNRelationInfos(datasource,relationInfos)

Set n-relation infos (array of RelationInfo objects created using tree.createRelationInfo() for having multiple child relations for one node)

Parameters:

• {string} datasource ** datasource

• {relationInfo[]} relationInfos ** relationInfos

---

setNRelationName(datasource,nrelationname)

Set relation for displaying a datasource foundset.

Example:

myElement.setNRelationName(databaseManager.getDataSource('example_data', 'categories'),'companies_to_categories');

Parameters:

• {string} datasource ** datasource

• {string} nrelationname ** nrelationname relation name

---

setNodeLevelVisible(level,visible)

Sets expanded state for a tree level. Expanding the tree may cause performance issues.

Example:

myElement.setNodeLevelVisible(2,true)

Parameters:

• {int} level ** level level in tree

• {boolean} visible ** state expanded state

---

setSelectionPath(pk)

Sets selection node of the tree.

Example:

myElement.setSelectionPath([22])

Parameters:

• {object[]} pk ** pkarray array of each level id

---

setTextDataprovider(datasource,textdataprovider)

Set dataprovider for the text displayed from a datasource foundset.

Example:

myElement.setTextDataprovider(databaseManager.getDataSource('example_data', 'categories'),'categoryname');

Parameters:

• {string} datasource ** datasource

• {string} textdataprovider ** textdataprovider dataprovider of the displayed text

---

setToolTipTextDataprovider(datasource,tooltiptextdataprovider)

Set dataprovider for the tooltip text displayed for a datasource foundset.

Example:

myElement.setToolTipTextDataprovider(databaseManager.getDataSource('example_data', 'categories'),'tooltip');

Parameters:

• {string} datasource ** datasource

• {string} tooltiptextdataprovider ** tooltiptextdataprovider dataprovider of the displayed checkbox

---

updateCheckBoxValues(datasource,pks,state)

Parameters:

• {string} datasource

• {string[]} pks

• {boolean} state

---

Types

action

scripting type: CustomType<servoyextra-dbtreeview.action>

• callbackfunction

  • Type: function

• datasource

  • Type: string

• name

  • Type: string

• param

  • Type: string

binding

scripting type: CustomType<servoyextra-dbtreeview.binding>

• callbackinfo

  • Type: callback

• checkboxvaluedataprovider

  • Type: string

• childsortdataprovider

  • Type: string

• datasource

  • Type: string

• hasCheckboxValue

  • Type: object[]

• hascheckboxdataprovider

  • Type: string

• imageurldataprovider

  • Type: string

• initialCheckboxValues

  • Type: object[]

• methodToCallOnCheckBoxChange

  • Type: callback

• methodToCallOnDoubleClick

  • Type: callback

• methodToCallOnRightClick

  • Type: callback

• nRelationInfos

  • Type: relationInfo[]

• nrelationname

  • Type: string

• textdataprovider

  • Type: string

• tooltiptextdataprovider

  • Type: string

callback

scripting type: CustomType<servoyextra-dbtreeview.callback>

• f

  • Type: function

• param

  • Type: string

levelVisibilityType

scripting type: CustomType<servoyextra-dbtreeview.levelVisibilityType>

• level

  • Type: int

• value

  • Type: boolean

relationInfo

scripting type: CustomType<servoyextra-dbtreeview.relationInfo>

• label

  • Type: string

• nRelationName

  • Type: string

---