expand collaps
addRow(parentId,itemId,data,itemActionHandler,image1,image2,image3)
add row to grid
Object: dhtmlXTreeGridObject
Topic(s): Add/delete;
- parentId - parent node id
- itemId - new node id
- data - array of row data
- itemActionHandler - function fired on node select event (optional)
- image1 - image for node without childrens; (optional)
- image2 - image for closed node; (optional)
- image3 - image for opened node (optional)
changeItemId(itemId,newItemId)
change item id
Object: dhtmlXTreeObject
Topic(s): Node/level control;
- itemId - old node id
- newItemId - new node id
clearCut()
clear cut
Object: dhtmlXTreeObject
Topic(s): Add/delete;
closeAllItems(itemId)
collapse target node and all child nodes
Object: dhtmlXTreeObject
Topic(s): Node/level control;
- itemId - node id
closeItem(itemId)
collapse node
Object: dhtmlXTreeObject
Topic(s): Node/level control;
- itemId - identificator of node
deleteChildItems(itemId)
delete all child of node
Object: dhtmlXTreeObject
Topic(s): Add/delete;
- itemId - node identificator
deleteItem(itemId,selectParent)
delete node
Object: dhtmlXTreeObject
Topic(s): Add/delete;
- itemId - node identificator
- selectParent - If true parent of deleted item get selection, else no selected items leaving in tree.
deleteRow(itemId)
delete row of grid
Object: dhtmlXTreeGridObject
Topic(s): Add/delete;
- itemId - item id
doCut()
mark selected item as cutted
Object: dhtmlXTreeObject
Topic(s): Add/delete;
doPaste(itemId)
insert previously cutted branch
Object: dhtmlXTreeObject
Topic(s): Add/delete;
- itemId - id of new parent node
enableCheckBoxes(mode)
hide checkboxes
Object: dhtmlXTreeObject
Topic(s): Initialization;
enableDragAndDrop(mode)
enable/disable drag-and-drop
Object: dhtmlXTreeObject
Topic(s): Initialization;
enableTreeLines(mode)
enableTreeLines(mode);
Object: dhtmlXTreeObject
Topic(s): Appearence control;
- mode - enable/disable tree lines
getAllChecked()
return list of identificators of nodes with checked checkboxes
Object: dhtmlXTreeObject
Topic(s): Checkboxes/user data manipulation;
getAllCheckedBranches()
return list of identificators of nodes with checked checkboxes, and parent of that checkboxes
Object: dhtmlXTreeObject
Topic(s): Checkboxes/user data manipulation;
getAllSubItems(itemId)
Returns the list of all children items from all next levels of tree, separated by commas.
Object: dhtmlXTreeObject
Topic(s): Appearence control;
- itemId - identificator of node
getChildItemIdByIndex(itemId,index)
retun child node identificator by index
Object: dhtmlXTreeObject
Topic(s): Selection control;
- itemId - parent node identificator
- index - index of child node
getGridData(itemId,index)
get data from specefied row by index
Object: dhtmlXTreeGridObject
Topic(s): Data manipulation;
- itemId - item id
- index - column index
getItemColor(itemId)
get node color
Object: dhtmlXTreeObject
Topic(s): Appearence control;
- itemId - identificator of node
getItemIdByIndex(itemId,index)
retun node identificator by index
Object: dhtmlXTreeObject
Topic(s): Selection control;
- itemId - node identificator
- index - index of node
getItemText(itemId)
return node text
Object: dhtmlXTreeObject
Topic(s): Appearence control;
- itemId - identificator of node
getLevel(itemId)
return node level
Object: dhtmlXTreeObject
Topic(s): Node/level control;
- itemId - identificator of node
getParentId(itemId)
return parent node identificator
Object: dhtmlXTreeObject
Topic(s): Node/level control;
- itemId - identificator of node
getSelectedItemId()
retun selected node identificator
Object: dhtmlXTreeObject
Topic(s): Selection control;
getSelectedItemText()
retun selected node text
Object: dhtmlXTreeObject
Topic(s): Selection control;
getSubItems(itemId)
Returns the list of all children items from the next level of tree, separated by commas.
Object: dhtmlXTreeObject
Topic(s): Appearence control;
- itemId - identificator of node
getUserData(itemId,name)
return user data from target node
Object: dhtmlXTreeObject
Topic(s): Checkboxes/user data manipulation;
- itemId - target node identificator
- name - key for user data
hasChildren(itemId)
return count of childrens
Object: dhtmlXTreeObject
Topic(s): Node/level control;
- itemId - identificator of node
insertNewItem(parentId,itemId,itemText,itemActionHandler,image1,image2,image3,optionStr,childs)
create new child node
Object: dhtmlXTreeObject
Topic(s): Add/delete;
- parentId - parent node id
- itemId - new node id
- itemText - new node text
- itemActionHandler - function fired on node select event (optional)
- image1 - image for node without childrens; (optional)
- image2 - image for closed node; (optional)
- image3 - image for opened node (optional)
- optionStr - options string (optional)
- childs - node childs flag (for dynamical trees) (optional)
insertNewNext(parentItemId,itemId,itemName,itemActionHandler,image1,image2,image3,optionStr,childs)
create new node next to specified
Object: dhtmlXTreeObject
Topic(s): Add/delete;
- parentItemId - node id
- itemId - new node id
- itemName - new node text
- itemActionHandler - function fired on node select event (optional)
- image1 - image for node without childrens; (optional)
- image2 - image for closed node; (optional)
- image3 - image for opened node (optional)
- optionStr - options string (optional)
- childs - node childs flag (for dynamical trees) (optional)
isItemChecked(itemId)
return state of nodes's checkbox
Object: dhtmlXTreeObject
Topic(s): Checkboxes/user data manipulation;
- itemId - target node identificator
loadXML(file)
load tree from xml file
Object: dhtmlXTreeGridObject
Topic(s): Initialization;
- file - link to XML file
loadXMLString(xmlString)
load tree from xml string
Object: dhtmlXTreeGridObject
Topic(s): Initialization;
- xmlString - XML string
loadXMLString(xmlString)
load tree from xml string
Object: dhtmlXTreeObject
Topic(s): Private;
- xmlString - XML string
openAllItems(itemId)
expand target node and all child nodes
Object: dhtmlXTreeObject
Topic(s): Node/level control;
- itemId - node id
openItem(itemId)
expand node
Object: dhtmlXTreeObject
Topic(s): Node/level control;
- itemId - identificator of node
refreshItem(itemId)
refresh tree branch from xml
Object: dhtmlXTreeObject
Topic(s): Appearence control;
- itemId - identificator of node, if not defined tree super root used.
selectItem(itemId,mode)
select node ( and optionaly fire onselect event)
Object: dhtmlXTreeObject
Topic(s): Selection control;
- itemId - node identificator
- mode - If true, script function for selected node will be called.
setCheck(itemId,state)
change state of node's checkbox
Object: dhtmlXTreeObject
Topic(s): Checkboxes/user data manipulation;
- itemId - target node identificator
- state - checkbox state
setDragHandler(func)
set function called when drag-and-drap event occured
Object: dhtmlXTreeObject
Topic(s): Initialization;
- aFunc - event handling function
setGridData(itemId,index,newValue)
set data in specefied row by index
Object: dhtmlXTreeGridObject
Topic(s): Data manipulation;
- itemId - item id
- index - column index
- newValue - new grid value
setImageArrays(arrayName,image1,image2,image3,image4,image5)
enableTreeLines(mode);
Object: dhtmlXTreeObject
Topic(s): Appearence control;
- arrayName - name of array: plus, minus
- image1 - line crossed image
- image2 - image with top line
- image3 - image with bottom line
- image4 - image without line
- image5 - single root image
setImagePath( newPath )
set path to image directory
Object: dhtmlXTreeObject
Topic(s): Initialization;
- newPath - path to image directory
setItemCloseable(itemId,flag)
prevent node from closing
Object: dhtmlXTreeObject
Topic(s): Node/level control;
- itemId - identificator of node
- flag - if 0 - node can't be closed, else node can be closed
setItemColor(itemId,defaultColor,selectedColor)
set node color
Object: dhtmlXTreeObject
Topic(s): Appearence control;
- itemId - identificator of node
- defaultColor - node color
- selectedColor - selected node color
setItemImage(itemId,image1,image2)
set node images
Object: dhtmlXTreeObject
Topic(s): Appearence control;
- itemId - identificator of node
- image1 - node without childrens image or closed node image (if image2 specified)
- image2 - open node image (optional)
setItemImage2(itemId, image1,image2,image3)
set node images
Object: dhtmlXTreeObject
Topic(s): Appearence control;
- itemId - identificator of node
- image1 - node without childrens image
- image2 - closed node image
- image3 - open node image
setItemText(itemId,newLabel)
set new node text (HTML allowed)
Object: dhtmlXTreeObject
Topic(s): Appearence control;
- itemId - identificator of node
- newLabel - node text
setOnCheckHandler(func)
set function called before checkbox checked/unchecked
Object: dhtmlXTreeObject
Topic(s): Initialization;
- func - event handling function
setOnClickHandler(func)
set function called when tree node selected
Object: dhtmlXTreeObject
Topic(s): Initialization;
- func - event handling function
setOnDblClickHandler(func)
set function called when tree node double clicked
Object: dhtmlXTreeObject
Topic(s): Initialization;
- func - event handling function
setOnOpenHandler(func)
set function called before tree node opened/closed
Object: dhtmlXTreeObject
Topic(s): Initialization;
- func - event handling function
setStdImages(image1,image2,image3)
set default images for nodes
Object: dhtmlXTreeObject
Topic(s): Appearence control;
- a0 - image for node without childrens;
- a1 - image for closed node;
- a2 - image for opened node
setSubChecked(itemId,state)
change state of node's checkbox and all childnodes checkboxes
Object: dhtmlXTreeObject
Topic(s): Checkboxes/user data manipulation;
- itemId - target node identificator
- state - checkbox state
setUserData(itemId,name,value)
set user data for target node
Object: dhtmlXTreeObject
Topic(s): Checkboxes/user data manipulation;
- itemId - target node identificator
- name - key for user data
- value - user data
setXMLAutoLoading(filePath)
enables dinamic loading from XML mode
Object: dhtmlXTreeGridObject
Topic(s): Initialization;
- filePath - name of script returning XML;
setXMLAutoLoading(filePath)
enables dinamic loading from XML mode
Object: dhtmlXTreeObject
Topic(s): Initialization;
- filePath - name of script returning XML;