The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide



Tips 'n' Tricks


:: com :: sun :: star :: awt :: tree ::

unpublished service TreeControl
Supported Interface
Usage Restrictions
not published
A control that displays a set of hierarchical data as an outline.

The Data Model

A specific node in a tree is identified by a XTreeNode. A leaf node is a node without any children and that returns false when calling XTreeNode::hasChildrenOnDemand(). An expanded node is a non-leaf node that will displays its children when all its ancestors are expanded. A collapsed node is one which hides them. A node is visible when all parent nodes are expanded and the node itself is in the display area.

The nodes are retrieved from a XTreeDataModel. You can implement it yourself or use the MutableTreeDataModel which uses XMutableTreeNode and XMutableTreeDataModel for a simple and mutable data model.

The data model must be set at the TreeControlModel::TreeDataModel property.


If you are interested in knowing when the selection changes implement a ::com::sun::star::view::XSelectionChangeListener and add the instance with the method ::com::sun::star::view::XSelectionSupplier::addSelectionChangeListener(). You than will be notified for any selection change.

If you are interested in detecting either double-click events or when a user clicks on a node, regardless of whether or not it was selected, you can get the ::com::sun::star::awt::XWindow and add yourself as a ::com::sun::star::awt::XMouseClickHandler. You can use the method XTreeControl::getNodeForLocation() to retrieve the node that was under the mouse at the time the event was fired.

Adding child nodes on demand

If you want to add child nodes to your tree on demand you can do the following.

Now you get called when the node will become expanded or collapsed. So on XTreeExpansionListener::treeExpanding() you can check the TreeExpansionEvent if the parent node with children on demand is going to be expanded and in that case add the missing child nodes. You can also veto the expansion or collapsing of a parent node by using the ExpandVetoException.

 Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.