Treeitem

Treeitem contains a row of data (treerow), and an optional treechildren.

If the component doesn't contain a treechildren, it is a leaf node that doesn't accept any child items.

If it contains a treechildren, it is a branch node that might contain other items.

For a branch node, an +/- button will appear at the beginning of the row, such that user could open and close the item by clicking on the +/- button.

<window title="tree demo" border="normal" width="400px">
    <tree id="tree" width="90%" >    
        <treecols sizable="true">        
            <treecol label="Name"/>            
            <treecol label="Description"/>            
        </treecols>        
        <treechildren>        
            <treeitem>            
                <treerow>                
                    <treecell>                    
                        <image src="/img/folder.gif"/>Item 1                        
                    </treecell>                    
                    <treecell>                    
                        <textbox value="Item 1 description"/>                        
                    </treecell>                    
                </treerow>                
            </treeitem>            
            <treeitem>            
                <treerow>                
                    <treecell label="Item 2"/>                    
                    <treecell label="Item 2 description"/>                    
                </treerow>                
                <treechildren>                
                    <treeitem open="false">                    
                        <treerow>                        
                            <treecell label="Item 2.1">                            
                                <image src="/img/folder.gif"/>                                
                            </treecell>                            
                        </treerow>                        
                        <treechildren>                        
                            <treeitem>                            
                                <treerow>                                
                                    <treecell label="Item 2.1.1"/>                                    
                                </treerow>                                
                            </treeitem>                            
                        </treechildren>                        
                    </treeitem>                    
                </treechildren>                
            </treeitem>            
            <treeitem label="Item 3"/>            
        </treechildren>        
    </tree>    
</window>

Class Name

org.zkoss.zul.Treeitem

Supported Child Components

Treerow, Treechildren

Supported Events

Event Name

Event Type

onRightClick

org.zkoss.zk.ui.event.MouseEvent

Description:

Denotes user has right-clicked the component.

onDoubleClick

org.zkoss.zk.ui.event.MouseEvent

Description:

Denotes user has double-clicked the component.

onOpen

org.zkoss.zk.ui.event.OpenEvent

Description:

Denotes user has opened or closed a component.

It is useful to implement load-on-demand by listening to the onOpen event, and creating components when the first time the component is opened.

Properties

Property

Description

Data Type

Default Value

image

Sets the image of the Treecell it contains. If it is not created, we automatically create it.

Same as setSrc

String

label

Sets the label of the Treecell it contains. If it is not created, we automatically create it.

String

open

Sets whether this container is open.

Values : true|false

boolean

true

sel ected

Sets whether this item is selected.

Values : true|false

boolean

false

src

Sets the src of the Treecell it contains. If it is not created, we automatically create it.

The same as setImage.

String

value

Sets the value.

Note: the value is not sent to the browser, so it is OK to be anything.

Object

null

Methods

Name

Description

Data Type

Values

getTreechildren

Returns the treechildren that this tree item owns, or null if doesn't have any child.

Treechildren

getTreerow

Returns the treerow that this tree item owns (might null).

Treerow

indexOf

return the index of this container

int

isContainer

Returns whether the element is to act as a container which can have child elements.

boolean

isEmpty

Returns whether this element contains no child elements.

boolean

isLoaded

Return true whether this container is loaded

boolean

Inherited From