Tree Applet

Parameters and interface functions description

You can find full documentation for advanced version here.

 
Tree applet can load content in two modes:

• initialize it from PARAM tags, present in HTML that contain the applet (these tags are descirbed below in section "Tree parameters")

• load items located on sub-levels dynamically from the server where the applet is loaded from

In both cases it is possible to manage items of the tree applet using public methods of it. This can be done as from another Java applet that uses Tree applet, so from browser using JavaScript. The public methods are described below in the section "Tree methods".

Initializing of tree items.

 Example 1. Possible item definition.

<PARAM NANE='ITEM0' VALUE='0'>
<PARAM NANE='NAME0' VALUE='Root item'>
<PARAM NANE='ACTION0' VALUE='r13'>
<PARAM NANE='LEVEL0' VALUE='0'>
<PARAM NANE='SELECT0' VALUE='1'>

This set of parameters describes the color model of the tree applet.

Name	Description
BG_COLOR	Background color.
FG_COLOR	Color of non-selected item's label.
BGSEL_COLOR	Background of selected item.
FGSEL_COLOR	Color of selected item's label.

 

Other parameters.

If this parameter has non-empty value, non-terminal items will be marked with "+" on the left side

Creates tree with checkboxes for all nodes. Images for checkboxes has size 11x11 pt and can be specified with followed parameters:

This parameter can be signed with AutoCheckBoxes and SHOW_IMAGES flags:

AutoCheckBoxes

Processing of checks is automatic - if item checked, all subnodes becomes to checked state too and all parents came into shadow mode. Default value is "1".

SHOW_IMAGES

Shows checkboxes with images. Default value is "1".

IMAGE

ICONS_PERMANENT

Important: If this parameter specified, minimum one of images (IM0 or IM1) must be specified for each node. Otherwise the tree will not be initialized.

The name of script function, which will be called when any item in tree is selected. Values specified in ACTION parameter will be passed to this function.

Example 2. Function with single argument.

function foo( s ) { }

<PARAM name="EVAL" VALUE="f">
<PARAM name="ACTION0" VALUE="0">  // foo(0) will be called
<PARAM name="ACTION1" VALUE="'test'"> // foo('test') will be called

function foo( s1, s2 ) { }

<PARAM name="EVAL" VALUE="f">
<PARAM name="ACTION0" VALUE="0,0">  // foo(0,0) will be called
<PARAM name="ACTION0" VALUE="'test',28"> // foo('test',28) will be called
<PARAM name="ACTION0" VALUE="28"> // Invalid, function does't take one argument.

Hierarchical selection flag. By default you cannot select node item and its child simultaneously. To enable child selection you should set this parameter to any nonempty value.

Allows you to collapse root nodes with LEVEL=0. Disabled by default. 

Used in dynamical trees. It means the name of document, which will load the data from server. Loading happens when:
    1. This parameter is not null,
    2. Node hasn't child subnodes
    3. Parameter CHILD for this node is not null.
The document can get identifier of called node through id parameter and must return the list of strings, ended by empty string. Every string contains information about single child node in the next format:
    "Name","id","action",hasChildren,im0,im1
Where id - identifier of the node, name - its name, action - the same meaning as ACTION parameter, hasChildren - CHILD parameter, im0,im1 - IM0,IM1 parameters.

<%
id = request("id")
sqlStr ="select KeyField, NameField from DataTable where ParentKeyFied=" & id
set ResultSet = DBConnection.execute(sqlStr)
while not ResultSet.eof
          Key = ResultSet("KeyField")
          Name = ResultSet("NameField")
          response.writeln("""" & Name & """,""" & Key & """,""" & Key & """,0,1,2" )
          ResultSet.moveNext
wend
response.writeln("")
%>

ON_LOAD

The name of script function, which will be called when all items have been loaded into the tree and you can call any tree applet's method.

ON_DBLCLICK

The name of script function, which will be called after doubleclicking on node. Function takes single parameter - the identifier of node.

ON_MENU

The name of script function, which will be called after changing of checked state of item. It has two parameters - identifier of item and boolean value of current checked state.

MULTISELECT

Enabling (1) or disabling (0) multiple selection mode of tree. Default it's enabled.

NODE_HEIGHT

The height of node. All nodes in tree has the same height. Default value is 18.

IMAGE_WIDTH / IMAGE_HEIGHT

Size of icons in tree. If real size of any image differs from this value, image will be resized. Default value is 16x16.

FONT_NAME / FONT_SIZE / FONT_STYLE

Font for nodes text. Default value is "Verdana", size 13, style PLAIN.

FONT_STYLE is a composition of the next string values: PLAIN, BOLD, ITALIC, separated by commas.

MENU

Enabling menu in tree applet. It will be called after right-button clicking on node. The value of this parameter is the name of script function, wich will be called after selection in menu. It must have two parameters - the identifier of node and number of selected item in menu (started from 0). If this parameter specified, next parameters will be processed:

MENUi

Specifies the name of menu item. Can has any string values or 'SEPARATOR' for inserting menu separator between menu items.

ON_MENU_PRE

Specifies menu initialization script function. This function should be used for customizing popup menu and is called directly before displaying menu and takes two parameters: identifier of node and TreeMenu object. Initially this object contains parameters defined with MENUi parameters. This object has next set of methods:

void addString(String txt)

Adds new item with specified label into menu.

void addSeparator()

Adds seperator into menu.

void remove(int index)

Removes item from menu.

void removeAll(int index)

Removes all items from menu.

String getLabel(int index)

Sets label of specified item.

void setLabel(int index, String txt)

Gets label of specified item.

void setEnable(int index, boolean isEnable)

Sets specified item to enabled or disabled state.

Below is described a list of tree applet methods available from client side scripts to access and manipulate tree data.

Retrieving of selected items.

boolean hasData()

Returns true if there are some selected items in tree.

String getSelectedItems()

String getSelectedItemsId(<int sortOrder>)

String getLastSelectedId()

boolean isLastItemSelected()

Retrieving of item properties.

String getLabel(String id)

String getAction(String id)

String getParentId(String id)

String getSubItems(String id)

String getAllSubItems(String id)

String findRef(String act)

Selecting of items. 

void selectItem(String id [, boolean isCall])

Tree manipulation functions. 

void deleteSelectedItem()

void deleteItem(String id [, boolean isSel])

void deleteAllNext(String id)

void setLabel( String id, String label)

void insertChild( String id, String label, String action
   [, int String, String im1] )

void insertNewChild( String pId, String id, String label, String action
   [, int im0, int im1] [, String options])

SELECT - new item becomes selected
CALL - action function for new item will be called after insertion
CHILD - new item has children (for dynamical tree)
CHECKED - new item is checked (for tree with checkboxes)
TOP - inserts new node at first child position

Default value for options is "SELECT,CALL,CHILD"

void insertNewNext( String pId, String id, String label, String action
   [, int im0, int im1] [, String options])

void insertNewRoot( String id, String label, String action
   [, int im0, int im1] [, String options] )

void reloadTree(String docName)

Forces a full reload of tree by reading of specified document from the server.
The document should be in the format specified in GET_DOC section.

void setItemColor(String id, String strNormColor, String strSelColor)

Sets the color of specified item.

void setItemFont(String id [,String fName] ,String fStyle)

Sets the font of specified item

void setUnderline(String id, boolean isUnderline)

Sets Underline flag for specified item

void setItemImage(String id, String im1 [, String im2] )

Sets image for specified item.

Expanding/collapsing functions. 

void expandAllChildren( String id )

void expandAllSelectedChildren( String id )

void collapseAllChildren( String id )

void openItem( String id )

Cut & Paste functions. 

int doCut()

int doPaste(String id)

0 - successful
1 - no items was cut
2 - One of cut item is root of the tree
3 - specified item not found
4 - Parent - to - child inserting

Miscellaneous functions. 

String getSubItems(String id)

String getAllSubItems(String id)

String getLevel(String id)

Returns zero-based level of item.

String findRefByLabel(String lbl)

?? Returns separated by comas list of items with specified label

String getLastAllSubItems(String id)

Similar to the getAllSubItems except we only want the last descendant.

String getNextItem(String id)

Return the id of the item that appears next sequentially in the tree.

String getNextSibling(String id)

Return the id of the next sibling after parameter id.

void traceTree()

User specified data manipulation functions. 

boolean setUserData(String id, String key, String value)

Sets user-specified data to node. Returns true if node was found.

String getUserData(String id, String key)

Returns user-specified data from node. Returns null value if node or data key not found.

Checkboxes operation functions

boolean isItemChecked(String id)

Returns true if specified item was checked.

void setCheck(String id, boolean isCheck)

Sets check state for specified item

String getAllChecked(boolean isSubitems)

Returns list of checked items, separated by commas. If isSubitems parameter is set to true, all items will be returned, else only first checked item without it's children.

void setSubChecked(String id, boolean isCheck)

Sets all subitems to checked (isCheck=true) or unchecked (isCheck=false) state. If id=null applying for all items in tree.

String getAboveChecked(String id)

Gets identifiers of all checked items above specified in top-down order.

String getBelowChecked(String id)

Gets identifiers of all checked items below specified in top-down order.