4 The entries parameter

This is a database table parameter. Please refer to 2.2 for a detailed explanation of database tables layout. In all the following examples we assume that the recordseparator is ^ and the fieldseparator is | .

Columns 5,6,7 and 8 are external keys who point to rows in other database tables. Column 5 is an external key for the links parameter, columns 6 and 7 are external keys for the images parameter and column 8 is an external key for the fonts parameter.

The entries table defines the hierarchical structure of your tree.

Column Name Type Default Range
0 Key String No default, obligatory field  
1 Name String No default, obligatory field  
2 Parent’s key String No default, obligatory field  
3 Type Character ‘c’ ‘c’ = container, ‘n’ = non container
4 State Character ‘c’ ‘c’ = closed, ‘o’ = open
5 List of linksprofiles Space separated string(s)    
6 Name of the icon in the images parameter for closed/non-selected String "closedfolder" where type is c , "closeddocument" where type is n  
7 Name of the icon in the images parameter for openened/selected String "openedfolder" where type is c , "openeddocument" where type is n  
8 Font profile String "defaultfont"  
9 Font alignment (relative to its icon) String "middle" "top", "middle", "bottom"
10 Tip/expansion (when state is closed) String   "auto" will enable auto expansion of containers
11 Tip/contraction (when state is opened) String   ‘auto’ will enable auto contraction of containers
12 Status message (will be displayed on the browser’s status bar) String    

 

Column 0 is the (primary) key. This key will be used when referring to this record.

Column 1 is the name that will be displayed in your tree.

Column 2 points to the key of the parent of this entry. The hierarchy starts with the entry that has "-start-" as its parent. Every other entry must be a child or a grandchild from this entry. Only container entries can have children.

Column 3 defines the type of the entry. A container can contain other containers or noncontainers, noncontainers are final and can not have any children.

Column 4 defines the state of the entry. It defines if the container’s contents is visible (opened) or not visible (closed). For a noncontainer it defines which icon should be displayed.

Column 5 defines the linkprofiles that should be activated when the user clicks on the entry. Multiple linkprofiles are supported and should be separated with a space character.
So clicking on an entry can trigger multiple links to different frames.

You can define your own icons. Column 6 contains the icon for the opened state, column 7 for the closed state.

Column 8 and 9 define the font and alignment used for the displayed name.

Column 10 and 11 define the contents of the tip that should be displayed if the pointing device is located above this entry and is inactive for a given period of time. Column 10 will be displayed if the state is closed, column 11 when the state is opened.

If column 10 or 11 contains the string "auto" then automatic expansion of containers is activated.

Column 12 defines the contents of the status message that should be displayed if the pointing device is moved above this entry.

Some examples

<PARAM name=entries value="
^root|a simple tree|-start-
">


<PARAM name=entries value="
^root|a tree with 3 children|-start-|c|o
^child1|child 1|root|n
^child2|child 2|roott|n
^child3|child 3|root|n
">

<PARAM name=entries value="
^root|a tree with 1 child and 2 grandchildren|-start-|c|o
^child1|child (container)|root|c|o
^grandchild1|grandchild 1|child1|n
^grandchild2|grandchild 2|child1|n
">

(using pop up tips)

<PARAM name=entries value="
^root|a tree with 1 child and 2 grandchildren|-start-
^child1|child (container)|root|c|c|||||Click here to view grandchildren
^grandchild1|grandchild 1|child1|n
^grandchild2|grandchild 2|child1|n
">