(incubating) | The Free and Open Productivity Suite

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous

Content for OpenOffice.org version 3.3.

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

unpublished interface XMutableTreeDataModel
Base Interfaces
XMutableTreeDataModelXTreeDataModel
   ┗ ::com::sun::star::lang::XComponent

XTreeDataModel
(referenced interface's summary:)
An instance of this interface is used by the TreeControl to retrieve the hierarchical outline data that is displayed in the actual control.
Usage Restrictions
not published
Description
This is the editable version of the XTreeDataModel.

Note that only XTreeNode created from the same instance with createNode are valids nodes for this instance.


Methods' Summary
createNode creates a new tree node with the given value and given settings.  
setRoot changes the root node of this model to RootNode.  
Methods' Details
createNode
XMutableTreeNode
createNode( [in] any  DisplayValue,
[in] boolean  ChildrenOnDemand );

Description
creates a new tree node with the given value and given settings.
Parameter DisplayValue
should be convertable to a string and is used by the XTreeControl as a textual represenation of the created node.
Parameter ChildrenOnDemand
if true is used as a parameter, the created node will be treated as a non-leaf node by the XTreeControl, even when it has no child nodes.
Returns
a new XMutableTreeNode that can be used for this model.
See also
XTreeNode::getDisplayValue(), XTreeNode::hasChildrenOnDemand()
setRoot
void
setRoot( [in] XMutableTreeNode  RootNode )
raises( ::com::sun::star::lang::IllegalArgumentException );

Description
changes the root node of this model to RootNode.
Parameter RootNode
the XMutableTreeNode that becomes the new root node of this model.
Throws
::com::sun::star::lang::IllegalArgumentException if RootNode is not a valid node of this XTreeDataModel.
Top of Page

Apache OpenOffice is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.

Copyright & License
Apache and the Apache feather logos are trademarks of The Apache Software Foundation. OpenOffice.org 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.