(incubating) | The Free and Open Productivity Suite

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous

Content for OpenOffice.org version 3.3.
Overview Module Use Devguide Index
Methods' Summary Attributes' Summary Methods' Details Attributes' Details

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

unpublished interface XTreeNode
Usage Restrictions
not published
Description
An instance implementing this interface represents the model data for an entry in a XTreeDataModel.

The TreeControl uses this interface to retrieve the model information needed to display a hierarchical outline

Each XTreeNode in a XTreeDataModel must be unique.

Methods' Summary
getChildAt Returns the child tree node at Index.  
getChildCount Returns the number of child nodes.  
getParent Returns the parent node of this node.  
getIndex Returns the index of Node in this instances children.  
hasChildrenOnDemand Returns true if the children of this node are created on demand.  
getDisplayValue If not empty, the textual representation of this any is used as the text part of this node.  
getNodeGraphicURL The URL for a graphic that is rendered before the text part of this node.  
getExpandedGraphicURL The URL for a graphic that is rendered to visualize expanded non leaf nodes.  
getCollapsedGraphicURL The URL for a graphic that is rendered to visualize collapsed non leaf nodes.  
Methods' Details
getChildAt
XTreeNode
getChildAt( [in] long  Index )
raises( ::com::sun::star::lang::IndexOutOfBoundsException );
Description
Returns the child tree node at Index.
Throws
::com::sun::star::lang::IndexOutOfBoundsException if Index is less than 0 or equal or greater then getChildCount.
getChildCount
long
getChildCount();
Description
Returns the number of child nodes.
getParent
XTreeNode
getParent();
Description
Returns the parent node of this node.
getIndex
long
getIndex( [in] XTreeNode  Node );
Description
Returns the index of Node in this instances children.
Returns
The child index of Node , or -1 if Node is no child of this instance.
hasChildrenOnDemand
boolean
hasChildrenOnDemand();
Description
Returns true if the children of this node are created on demand.

A TreeControl will handle a node that returns true always like a node that has child nodes, even if getChildCount returns 0.

See also
TreeExpansionListener;
getDisplayValue
any
getDisplayValue();
Description
If not empty, the textual representation of this any is used as the text part of this node.
getNodeGraphicURL
string
getNodeGraphicURL();
Description
The URL for a graphic that is rendered before the text part of this node.

If this URL is empty, no graphic is rendered.

getExpandedGraphicURL
string
getExpandedGraphicURL();
Description
The URL for a graphic that is rendered to visualize expanded non leaf nodes.

If URL is empty, XTreeControl::DefaultExpandedGraphicURL is used.

getCollapsedGraphicURL
string
getCollapsedGraphicURL();
Description
The URL for a graphic that is rendered to visualize collapsed non leaf nodes.

If URL is empty, XTreeControl::DefaultCollapsedGraphicURL is used.

Top of Page

Copyright © 1995, 2010, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

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.