Skip to end of metadata
Go to start of metadata



Known Subclasses
DB Tree Table View



Return Types
Binding RelationInfo



Property Summary
String bgcolor
Property for getting/setting the background color of the bean.
Boolean enabled
Property for getting/setting the enabled state of the bean
String fgcolor
Property for getting/setting the foreground color of the bean.
Object[] selectionPath
Get/Set the selection (path), array with pk records values (only single pk key supported)
String toolTipText
Property for getting/setting the text of the bean's tooltip
Boolean transparent
Property for getting/setting the transparent or opaque state of the bean
Boolean visible
Property for getting/setting the visibility of the bean.



Method Summary
Number addRoots(foundSet)
Add foundset to the list of foundsets used to create the tree's root nodes.
Binding createBinding(args)
Create and add binding object for a database table used to set data bindings for nodes.
RelationInfo createRelationInfo()
Create relation info object used to set multiple child relations for a tree node
Number getHeight()
Returns the height of the tree.
Number getLocationX()
Get the x coordinate of the location of the tree.
Number getLocationY()
Get the y coordinate of the location of the tree.
String getName()
Returns the name of the tree.
Number getWidth()
Returns the width of the tree.
Boolean isNodeExpanded(nodePath)
Check the path (array with pk records values (only single pk key supported)) expanded status
void refresh()
Refresh the tree display
void removeAllRoots()
Remove all root foundsets
void setExpandNode(nodePath, expand_collapse)
Expand/collapse the path, array with pk records values (only single pk key supported)
void setFont(font)
Sets the specified font as the font of the tree.
void setLocation(x, y)
Sets the location of the tree.
void setNodeLevelVisible(level, visible)
Set the level of visible nodes (expand or collapse to certain level)
void setOnDrag(fOnDrag)
Set method to be called when a drag is started on the tree.
void setOnDragEnd(fOnDragEnd)
Set method to be called when a drag of on the tree is ended.
void setOnDragOver(fOnDragOver)
Set method to be called during a drag over the tree.
void setOnDrop(fOnDrop)
Set method to be called on a drop on the tree.
void setRowHeight(height)
Set row height
void setSize(w, h)
Sets the size of the tree.



Property Details

bgcolor

Property for getting/setting the background color of the bean.

Returns

String - the background color

Sample

elements.customer_id.bgcolor = "#FFFFFF";
var x = elements.customer_id.bgcolor;
 

enabled

Property for getting/setting the enabled state of the bean

Returns

Boolean - the enabled state of the bean

Sample

var b = elements.customer_id.enabled;
if (b) elements.customer_id.enabled = false;
 

fgcolor

Property for getting/setting the foreground color of the bean.

Returns

Sample

elements.customer_id.fgcolor = "#000000";
var y = elements.customer_id.fgcolor;
 

selectionPath

Get/Set the selection (path), array with pk records values (only single pk key supported)

Returns

Sample

elements.customer_id.selectionPath = new Array(14,24,45,67);
var currentSelectionArray = elements.customer_id.selectionPath;
 

toolTipText

Property for getting/setting the text of the bean's tooltip

Returns

String - the tooltip text of the bean

Sample

elements.customer_id.toolTipText = 'Hello world!';
 

transparent

Property for getting/setting the transparent or opaque state of the bean

Returns

Boolean - the transparent state of the bean

Sample

var t = elements.customer_id.transparent;
if (!t) elements.customer_id.transparent = true;
 

visible

Property for getting/setting the visibility of the bean.

Returns

Boolean - the visibility of the bean

Sample

var v = elements.customer_id.visible;
 



Method Details

addRoots

Number addRoots (foundSet)
Add foundset to the list of foundsets used to create the tree's root nodes.\nNote: the bean will use a clone of the foundset, so any changes on the foundset parameter will be ignored in the tree.

Parameters

{Object} foundSet

Returns

Number - The number of added root nodes

Sample

var addedRootNodes = elements.customer_id.addRoots(foundset);
 

createBinding

Binding createBinding (args)
Create and add binding object for a database table used to set data bindings for nodes.

Parameters

{String...} args

Returns

Binding - Binding object for a database table

Sample

var companies_binding = elements.customer_id.createBinding('example_data', 'companies');
companies_binding.setTextDataprovider('company_name');
companies_binding.setNRelationName('companies_to_companies');
companies_binding.setImageURLDataprovider('type_icon');
companies_binding.setChildSortDataprovider('company_sort');
 

createRelationInfo

RelationInfo createRelationInfo ()
Create relation info object used to set multiple child relations for a tree node

Returns

RelationInfo - RelationInfo object

Sample

var company_relations = new Array();
company_relations[0] = elements.customer_id.createRelationInfo();
company_relations[0].setLabel('Employees');
company_relations[0].setNRelationName('companies_to_employees');
company_relations[1] = elements.customer_id.createRelationInfo();
company_relations[1].setLabel('Customers');
company_relations[1].setNRelationName('companies_to_customers');
companies_binding.setNRelationInfos(company_relations);
 

getHeight

Number getHeight ()
Returns the height of the tree.

Returns

Number - The height

Sample

elements.customer_id.getHeight();
 

getLocationX

Number getLocationX ()
Get the x coordinate of the location of the tree.

Returns

Number - The x coordinate

Sample

elements.customer_id.getLocationX();
 

getLocationY

Number getLocationY ()
Get the y coordinate of the location of the tree.

Returns

Number - The y coordinate

Sample

elements.customer_id.getLocationY();
 

getName

String getName ()
Returns the name of the tree.

Returns

Sample

elements.customer_id.getName();
 

getWidth

Number getWidth ()
Returns the width of the tree.

Returns

Number - The width

Sample

elements.customer_id.getWidth();
 

isNodeExpanded

Boolean isNodeExpanded (nodePath)
Check the path (array with pk records values (only single pk key supported)) expanded status

Parameters

{Object[]} nodePath

Returns

Boolean - True if the node is expanded, False otherwise

Sample

var pathArray = new Array(14,24,45,67);
elements.customer_id.isNodeExpanded(pathArray);
 

refresh

void refresh ()
Refresh the tree display

Returns

void

Sample

elements.customer_id.refresh();
 

removeAllRoots

void removeAllRoots ()
Remove all root foundsets

Returns

void

Sample

elements.customer_id.removeAllRoots();
 

setExpandNode

void setExpandNode (nodePath, expand_collapse)
Expand/collapse the path, array with pk records values (only single pk key supported)

Parameters

{Object[]} nodePath
{Boolean} expand_collapse

Returns

void

Sample

var pathArray = new Array(14,24,45,67);
elements.customer_id.setExpandNode(pathArray, true);
 

setFont

void setFont (font)
Sets the specified font as the font of the tree.

Parameters

{String} font

Returns

void

Sample

elements.customer_id.setFont('Times New Roman, 1, 22');
 

setLocation

void setLocation (x, y)
Sets the location of the tree.

Parameters

{Number} x
{Number} y

Returns

void

Sample

elements.customer_id.setLocation(120,80);
 

setNodeLevelVisible

void setNodeLevelVisible (level, visible)
Set the level of visible nodes (expand or collapse to certain level)

Parameters

{Number} level
{Boolean} visible

Returns

void

Sample

elements.customer_id.setNodeLevelVisible(scopes.globals.g_treeview_level, (scopes.globals.g_treeview_expand == 1 ? true : false));
 

setOnDrag

void setOnDrag (fOnDrag)
Set method to be called when a drag is started on the tree. For more details about the method arguments and return value check the same property of a form

Parameters

{Function} fOnDrag

Returns

void

Sample

elements.customer_id.setOnDrag(onDrag);
 

setOnDragEnd

void setOnDragEnd (fOnDragEnd)
Set method to be called when a drag of on the tree is ended. For more details about the method arguments and return value check the same property of a form

Parameters

{Function} fOnDragEnd

Returns

void

Sample

elements.customer_id.setOnDragEnd(onDragEnd);
 

setOnDragOver

void setOnDragOver (fOnDragOver)
Set method to be called during a drag over the tree. For more details about the method arguments and return value check the same property of a form

Parameters

{Function} fOnDragOver

Returns

void

Sample

elements.customer_id.setOnDragOver(onDragOver);
 

setOnDrop

void setOnDrop (fOnDrop)
Set method to be called on a drop on the tree. For more details about the method arguments and return value check the same property of a form

Parameters

{Function} fOnDrop

Returns

void

Sample

elements.customer_id.setOnDrop(onDrop);
 

setRowHeight

void setRowHeight (height)
Set row height

Parameters

{Number} height

Returns

void

Sample

elements.customer_id.setRowHeight(40);
 

setSize

void setSize (w, h)
Sets the size of the tree.

Parameters

{Number} w
{Number} h

Returns

void

Sample

elements.customer_id.setSize(400,300);
 



  • No labels