<html> <head> <title>Interface XTreeNode</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="XTreeNode-xref.html" class="navimain">Use</a></td> <td class="navimainnone">Devguide</td> <td class="navimain"><a href="../../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td> <td class="navisub">Attributes' Summary</td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' Details</td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../../module-ix.html" class="namechain">::</a> <a href="../../../../module-ix.html" class="namechain">com</a> :: <a href="../../../module-ix.html" class="namechain">sun</a> :: <a href="../../module-ix.html" class="namechain">star</a> :: <a href="../module-ix.html" class="namechain">awt</a> :: <a href="module-ix.html" class="namechain">tree</a> :: </p> </td> </tr> <tr> <td class="title"><table class="title-table" width="99%"> <tr> <td width="25%" class="title2">unpublished </td> <td width="50%" class="title">interface XTreeNode</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>not published</i></dd> <dt><b>Description</b></dt> <dd>An instance implementing this interface represents the model data for an entry in a <a href="XTreeDataModel.html">XTreeDataModel</a>. </dd> <dd><p>The <a href="TreeControl.html">TreeControl</a> uses this interface to retrieve the model information needed to display a hierarchical outline</p> <p>Each XTreeNode in a <a href="XTreeDataModel.html">XTreeDataModel</a> must be unique. </dd> </dl> </td> </tr> </table> <hr> <a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Methods' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#getChildAt">getChildAt</a></td> <td class="imsum_right">Returns the child tree node at <var>Index</var>. </td> </tr> <tr> <td class="imsum_left"><a href="#getChildCount">getChildCount</a></td> <td class="imsum_right">Returns the number of child nodes. </td> </tr> <tr> <td class="imsum_left"><a href="#getParent">getParent</a></td> <td class="imsum_right">Returns the parent node of this node. </td> </tr> <tr> <td class="imsum_left"><a href="#getIndex">getIndex</a></td> <td class="imsum_right">Returns the index of <var>Node</Node> in this instances children. </td> </tr> <tr> <td class="imsum_left"><a href="#hasChildrenOnDemand">hasChildrenOnDemand</a></td> <td class="imsum_right">Returns <b>true</b> if the children of this node are created on demand. </td> </tr> <tr> <td class="imsum_left"><a href="#getDisplayValue">getDisplayValue</a></td> <td class="imsum_right">If not empty, the textual representation of this any is used as the text part of this node. </td> </tr> <tr> <td class="imsum_left"><a href="#getNodeGraphicURL">getNodeGraphicURL</a></td> <td class="imsum_right">The URL for a graphic that is rendered before the text part of this node. </td> </tr> <tr> <td class="imsum_left"><a href="#getExpandedGraphicURL">getExpandedGraphicURL</a></td> <td class="imsum_right">The URL for a graphic that is rendered to visualize expanded non leaf nodes. </td> </tr> <tr> <td class="imsum_left"><a href="#getCollapsedGraphicURL">getCollapsedGraphicURL</a></td> <td class="imsum_right">The URL for a graphic that is rendered to visualize collapsed non leaf nodes. </td> </tr> </table> <a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Methods' Details</td> </tr> <tr> <td class="imdetail"><a name="getChildAt" class="membertitle">getChildAt</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3"><a href="XTreeNode.html">XTreeNode</a></td> </tr> <tr> <td valign="top"><b>getChildAt</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> Index )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/IndexOutOfBoundsException.html">IndexOutOfBoundsException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Returns the child tree node at <var>Index</var>. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::lang::IndexOutOfBoundsException if <var>Index</var> is less than 0 or equal or greater then <a href="#getChildCount">getChildCount</a>. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getChildCount" class="membertitle">getChildCount</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">long</td> </tr> <tr> <td valign="top"><b>getChildCount</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Returns the number of child nodes. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getParent" class="membertitle">getParent</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3"><a href="XTreeNode.html">XTreeNode</a></td> </tr> <tr> <td valign="top"><b>getParent</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Returns the parent node of this node. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getIndex" class="membertitle">getIndex</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">long</td> </tr> <tr> <td valign="top"><b>getIndex</b>(</td> <td valign="top">[in] <a href="XTreeNode.html">XTreeNode</a></td> <td valign="bottom"> Node );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Returns the index of <var>Node</Node> in this instances children. </dd> <dt><b>Returns</b></dt> <dd>The child index of <var>Node</Node> , or -1 if <var>Node</Node> is no child of this instance. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="hasChildrenOnDemand" class="membertitle">hasChildrenOnDemand</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">boolean</td> </tr> <tr> <td valign="top"><b>hasChildrenOnDemand</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Returns <b>true</b> if the children of this node are created on demand. </dd> <dd><p>A <a href="TreeControl.html">TreeControl</a> will handle a node that returns <b>true</b> always like a node that has child nodes, even if <a href="#getChildCount">getChildCount</a> returns 0.</p> </dd> <dt><b>See also</b></dt> <dd><a href="#TreeExpansionListener;">TreeExpansionListener;</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getDisplayValue" class="membertitle">getDisplayValue</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">any</td> </tr> <tr> <td valign="top"><b>getDisplayValue</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>If not empty, the textual representation of this any is used as the text part of this node. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getNodeGraphicURL" class="membertitle">getNodeGraphicURL</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">string</td> </tr> <tr> <td valign="top"><b>getNodeGraphicURL</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>The URL for a graphic that is rendered before the text part of this node. </dd> <dd><p>If this URL is empty, no graphic is rendered. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getExpandedGraphicURL" class="membertitle">getExpandedGraphicURL</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">string</td> </tr> <tr> <td valign="top"><b>getExpandedGraphicURL</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>The URL for a graphic that is rendered to visualize expanded non leaf nodes. </dd> <dd><p>If <var>URL</var> is empty, <a href="XTreeControl.html">XTreeControl</a>::<a href="XTreeControl.html#DefaultExpandedGraphicURL">DefaultExpandedGraphicURL</a> is used. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getCollapsedGraphicURL" class="membertitle">getCollapsedGraphicURL</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">string</td> </tr> <tr> <td valign="top"><b>getCollapsedGraphicURL</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>The URL for a graphic that is rendered to visualize collapsed non leaf nodes. </dd> <dd><p>If <var>URL</var> is empty, <a href="XTreeControl.html">XTreeControl</a>::<a href="XTreeControl.html#DefaultCollapsedGraphicURL">DefaultCollapsedGraphicURL</a> is used. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2011, 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.</p> </div> <!-- id="adc-idlref" --> </body> </html>