TreeDataItem Class Reference

Inheritance diagram for TreeDataItem:

DataItem

List of all members.

Public Member Functions

 __construct ($id, $data, $name, $index, $parent_id)
 get_parent_id ()
 get_check_state ()
 set_check_state ($value)
 set_image ($img_folder_closed, $img_folder_open=false, $img_leaf=false)
 to_xml_start ()
 to_xml ()

Private Attributes

 $parent_id
 id of parent record
 $im0
 image of closed folder
 $im1
 image of opened folder
 $im2
 image of leaf item
 $check
 checked state


Detailed Description

DataItem class for Tree component

Constructor & Destructor Documentation

__construct ( id,
data,
name,
index,
parent_id 
)

constructor

Parameters:
id record id
data hash of data
name names of fields
index index of current record
parent_id id of parent record


Member Function Documentation

get_check_state (  ) 

get state of items checkbox

Returns:
state of item's checkbox as int value, false if state was not defined

get_parent_id (  ) 

get id of parent record

Returns:
id of parent record

set_check_state ( value  ) 

set state of item's checkbox

Parameters:
value int value, 1 - checked, 0 - unchecked, -1 - third state

set_image ( img_folder_closed,
img_folder_open = false,
img_leaf = false 
)

assign image for tree's item

Parameters:
img_folder_closed image for item, which represents folder in closed state
img_folder_open image for item, which represents folder in opened state, optional
img_leaf image for item, which represents leaf item, optional

to_xml (  ) 

return self as XML string

to_xml_start (  ) 

return self as XML string without ending tag


Member Data Documentation

$check [private]

checked state

$im0 [private]

image of closed folder

$im1 [private]

image of opened folder

$im2 [private]

image of leaf item

$parent_id [private]

id of parent record


The documentation for this class was generated from the following file:

Generated on Tue Mar 3 20:06:24 2009 for dhxmlXConnector by  doxygen 1.5.8