Sophie

Sophie

distrib > Mandriva > 2008.1 > x86_64 > media > main-testing > by-pkgid > 2c50825dd66d0497b96a67f7fab2ee84 > files > 1354

openoffice.org64-devel-doc-2.4.1.10-1mdv2008.1.x86_64.rpm

<html>
<head>
<title>Interface XTreeControl</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="XTreeControl-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"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td>
<td class="navisub"><a href="#AttributesSummary" class="navisub">Attributes' Summary</a></td>
<td class="navisub"><a href="#AttributesDetails" class="navisub">Attributes' Details</a></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 XTreeControl</td>
<td width="*"/></tr>
</table>
</td>
</tr>
<tr>
<td><dl>
<dt><b>Base Interfaces</b></dt>
<dd><pre style="font-family:monospace;"><strong>XTreeControl</strong>
&#x2517 ::com::sun::star::<a href="../../view/module-ix.html">view</a>::<a href="../../view/XMultiSelectionSupplier.html">XMultiSelectionSupplier</a>
   &#x2517 ::com::sun::star::<a href="../../view/module-ix.html">view</a>::<a href="../../view/XSelectionSupplier.html">XSelectionSupplier</a>

</pre></dd>
<dd><a name/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="crosstitle">
<tr>
<td class="imsum_left">::com::sun::star::<a href="../../view/module-ix.html">view</a>::<a href="../../view/XMultiSelectionSupplier.html">XMultiSelectionSupplier</a></td>
<td class="imsum_right"><dl>
<dt><b>Description</b></dt>
<dd>This interfaces provides access to the selection of tree nodes for this control.
 
 </dd>
<dd><p>valid selection values for this interface are
 <a href="XTreeNode.html">XTreeNode</a> or sequence&lt;<a href="XTreeNode.html">XTreeNode</a>&gt;.</p>

 <method scope="::com::sun::star::view">XSelectionSupplier::getSelection()</method>
 returns an emtpy any for no selection, an any with <a href="XTreeNode.html">XTreeNode</a> for
 a single selection and a sequence&lt;<a href="XTreeNode.html">XTreeNode</a>&gt; for a multiselection.
 </dd>
</dl>
</td>
</tr>
</table>
</dd>
</dl>
</td>
</tr>
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>An interface to a control that displays a set of hierarchical data as an outline.

 </dd>
<dt><b>See also</b></dt>
<dd><a href="TreeControl.html">TreeControl</a></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="#isNodeExpanded">isNodeExpanded</a></td>
<td class="imsum_right">Returns <b>true</b> if <var>Node</var> is currently expanded.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#isNodeCollapsed">isNodeCollapsed</a></td>
<td class="imsum_right">Returns <b>true</b> if <var>Node</var> is currently collapsed.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#makeNodeVisible">makeNodeVisible</a></td>
<td class="imsum_right">Ensures that <var>Node</var> is currently visible.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#isNodeVisible">isNodeVisible</a></td>
<td class="imsum_right">Returns <b>true</b> if <var>Node</var> is currently visible.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#expandNode">expandNode</a></td>
<td class="imsum_right">Ensures that <var>Node</var> is expanded and visible.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#collapseNode">collapseNode</a></td>
<td class="imsum_right">Ensures that <var>Node</var> is collapsed.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#addTreeExpansionListener">addTreeExpansionListener</a></td>
<td class="imsum_right">Adds a listener for ::TreeExpansion events.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#removeTreeExpansionListener">removeTreeExpansionListener</a></td>
<td class="imsum_right">Removes a listener for ::TreeExpansion events.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getNodeForLocation">getNodeForLocation</a></td>
<td class="imsum_right">Returns the node at the specified location.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getClosestNodeForLocation">getClosestNodeForLocation</a></td>
<td class="imsum_right">Returns the node that is closest to x,y.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#isEditing">isEditing</a></td>
<td class="imsum_right">Returns <b>true</b> if one of tree's nodes is being currently edited.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#stopEditing">stopEditing</a></td>
<td class="imsum_right">Ends the current editing session.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#cancelEditing">cancelEditing</a></td>
<td class="imsum_right">Cancels the current editing session.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#startEditingAtNode">startEditingAtNode</a></td>
<td class="imsum_right">Selects <var>Node</var> and initiates editing.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#addTreeEditListener">addTreeEditListener</a></td>
<td class="imsum_right">Adds a <a href="XTreeEditListener.html">XTreeEditListener</a>.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#removeTreeEditListener">removeTreeEditListener</a></td>
<td class="imsum_right">Removes a <a href="XTreeEditListener.html">XTreeEditListener</a>.

 &nbsp;</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="isNodeExpanded" class="membertitle">isNodeExpanded</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>isNodeExpanded</b>(</td>
<td valign="top">[in] <a href="XTreeNode.html">XTreeNode</a></td>
<td valign="bottom">&nbsp;Node )</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/IllegalArgumentException.html">IllegalArgumentException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Returns <b>true</b> if <var>Node</var> is currently expanded.

 </dd>
<dt><b>Parameter Node</b></dt>
<dd>the <a href="XTreeNode.html">XTreeNode</a> specifying the node to check.

 </dd>
<dt><b>Returns</b></dt>
<dd><b>false</b> if <var>Node</var> or at least one of its parent nodes are collapsed,
 <b>true</b> if <var>Node</var> and all of its parent nodes are expanded.

 </dd>
<dt><b>Throws</b></dt>
<dd>::com::sun::star::lang::IllegalArgumentException
 if <var>Node</var> is not a valid node of the corresponding <a href="XTreeDataModel.html">XTreeDataModel</a>.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="isNodeCollapsed" class="membertitle">isNodeCollapsed</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>isNodeCollapsed</b>(</td>
<td valign="top">[in] <a href="XTreeNode.html">XTreeNode</a></td>
<td valign="bottom">&nbsp;Node )</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/IllegalArgumentException.html">IllegalArgumentException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Returns <b>true</b> if <var>Node</var> is currently collapsed.

 </dd>
<dt><b>Parameter Node</b></dt>
<dd>the <a href="XTreeNode.html">XTreeNode</a> specifying the node to check 

 </dd>
<dt><b>Returns</b></dt>
<dd><b>true</b> if <var>Node</var> or at least one of its parent nodes are collapsed,
 <b>false</b> if <var>Node</var> and all of its parent nodes are expanded

 </dd>
<dt><b>Throws</b></dt>
<dd>::com::sun::star::lang::IllegalArgumentException
 if <var>Node</var> is not a valid node of the corresponding <a href="XTreeDataModel.html">XTreeDataModel</a>.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="makeNodeVisible" class="membertitle">makeNodeVisible</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">void</td>
</tr>
<tr>
<td valign="top"><b>makeNodeVisible</b>(</td>
<td valign="top">[in] <a href="XTreeNode.html">XTreeNode</a></td>
<td valign="bottom">&nbsp;Node )</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/IllegalArgumentException.html">IllegalArgumentException</a>,<br>
<a href="ExpandVetoException.html">ExpandVetoException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Ensures that <var>Node</var> is currently visible.
 </dd>
<dd><p>This includes expanding all parent nodes and scroll the control so this
 node is visible in the controls display area.</p>

 </dd>
<dt><b>Parameter Node</b></dt>
<dd>the <a href="XTreeNode.html">XTreeNode</a> specifying the node to make visible.

 </dd>
<dt><b>Throws</b></dt>
<dd>::com::sun::star::lang::IllegalArgumentException
 if <var>Node</var> is not a valid node of the corresponding <a href="XTreeDataModel.html">XTreeDataModel</a>.

 </dd>
<dt><b>Throws</b></dt>
<dd>ExpandVetoException
 if <var>Node</var>can't be made visible since at least one of the parent nodes are
 collapsed and expanding failed because at least one of the registered
 <a href="XTreeExpansionListener.html">XTreeExpansionListener</a> raised a <a href="ExpandVetoException.html">ExpandVetoException</a>.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="isNodeVisible" class="membertitle">isNodeVisible</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>isNodeVisible</b>(</td>
<td valign="top">[in] <a href="XTreeNode.html">XTreeNode</a></td>
<td valign="bottom">&nbsp;Node )</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/IllegalArgumentException.html">IllegalArgumentException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Returns <b>true</b> if <var>Node</var> is currently visible.
 </dd>
<dd><p>Visible means it is either the root or all of its parents are expanded.</p>

 </dd>
<dt><b>Returns</b></dt>
<dd><b>true</b> if <var>Node</var> is visible, otherwise <b>false</b>

 </dd>
<dt><b>Throws</b></dt>
<dd>::com::sun::star::lang::IllegalArgumentException
 if <var>Node</var> is not a valid node of the corresponding <a href="XTreeDataModel.html">XTreeDataModel</a>.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="expandNode" class="membertitle">expandNode</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">void</td>
</tr>
<tr>
<td valign="top"><b>expandNode</b>(</td>
<td valign="top">[in] <a href="XTreeNode.html">XTreeNode</a></td>
<td valign="bottom">&nbsp;Node )</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/IllegalArgumentException.html">IllegalArgumentException</a>,<br>
<a href="ExpandVetoException.html">ExpandVetoException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Ensures that <var>Node</var> is expanded and visible.
 </dd>
<dd><p>If <var>Node</var> is a leaf node, this will have no effect.</p>

 </dd>
<dt><b>Parameter Node</b></dt>
<dd>the <a href="XTreeNode.html">XTreeNode</a> identifying a node.

 </dd>
<dt><b>Throws</b></dt>
<dd>::com::sun::star::lang::IllegalArgumentException
 if <var>Node</var> is not a valid node of the corresponding <a href="XTreeDataModel.html">XTreeDataModel</a>.

 </dd>
<dt><b>Throws</b></dt>
<dd>ExpandVetoException
 if expanding <var>Node</var> failed because at least one of the registered
 <a href="XTreeExpansionListener.html">XTreeExpansionListener</a> raised a <a href="ExpandVetoException.html">ExpandVetoException</a>.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="collapseNode" class="membertitle">collapseNode</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">void</td>
</tr>
<tr>
<td valign="top"><b>collapseNode</b>(</td>
<td valign="top">[in] <a href="XTreeNode.html">XTreeNode</a></td>
<td valign="bottom">&nbsp;Node )</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/IllegalArgumentException.html">IllegalArgumentException</a>,<br>
<a href="ExpandVetoException.html">ExpandVetoException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Ensures that <var>Node</var> is collapsed.

 </dd>
<dt><b>Parameter Node</b></dt>
<dd>the <a href="XTreeNode.html">XTreeNode</a> identifying a node

 </dd>
<dt><b>Throws</b></dt>
<dd>::com::sun::star::lang::IllegalArgumentException
 if <var>Node</var> is not a valid node of the corresponding <a href="XTreeDataModel.html">XTreeDataModel</a>.

 @raises ExpandVetoException
 if collapsing <var>Node</var> failed because at least one of the registered
 <a href="XTreeExpansionListener.html">XTreeExpansionListener</a> raised a <a href="ExpandVetoException.html">ExpandVetoException</a>.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="addTreeExpansionListener" class="membertitle">addTreeExpansionListener</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">void</td>
</tr>
<tr>
<td valign="top"><b>addTreeExpansionListener</b>(</td>
<td valign="top">[in] <a href="XTreeExpansionListener.html">XTreeExpansionListener</a></td>
<td valign="bottom">&nbsp;Listener );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Adds a listener for ::TreeExpansion events.

 </dd>
<dt><b>Parameter Listener</b></dt>
<dd>a <a href="XTreeExpansionListener.html">XTreeExpansionListener</a> that will be notified when a tree
 node is expanded or collapsed.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="removeTreeExpansionListener" class="membertitle">removeTreeExpansionListener</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">void</td>
</tr>
<tr>
<td valign="top"><b>removeTreeExpansionListener</b>(</td>
<td valign="top">[in] <a href="XTreeExpansionListener.html">XTreeExpansionListener</a></td>
<td valign="bottom">&nbsp;Listener );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Removes a listener for ::TreeExpansion events.

 </dd>
<dt><b>Parameter Listener</b></dt>
<dd>the <a href="XTreeExpansionListener.html">XTreeExpansionListener</a> to remove.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getNodeForLocation" class="membertitle">getNodeForLocation</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>getNodeForLocation</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom">&nbsp;x,</td>
</tr>
<tr>
<td/><td valign="top">[in] long</td>
<td valign="bottom">&nbsp;y );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Returns the node at the specified location.

 </dd>
<dt><b>Parameter x</b></dt>
<dd>an integer giving the number of pixels horizontally from the left edge of the controls display area
 </dd>
<dt><b>Parameter y</b></dt>
<dd>an integer giving the number of pixels vertically from the top edge of the controls display area
 </dd>
<dt><b>Returns</b></dt>
<dd>the <a href="XTreeNode.html">XTreeNode</a> for the node at that location, or 0 if there is no node at the given position
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getClosestNodeForLocation" class="membertitle">getClosestNodeForLocation</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>getClosestNodeForLocation</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom">&nbsp;x,</td>
</tr>
<tr>
<td/><td valign="top">[in] long</td>
<td valign="bottom">&nbsp;y );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Returns the node that is closest to x,y.
 </dd>
<dd><p>If no nodes are currently viewable, or there is no model, returns null,
 otherwise it always returns a valid node. To test if the node is exactly
 at x, y, use <a href="#getNodeForLocation()">getNodeForLocation()</a>.

 </dd>
<dt><b>Parameter x</b></dt>
<dd>an integer giving the number of pixels horizontally from the left edge of the controls display area
 @para y
 an integer giving the number of pixels vertically from the top edge of the controls display area
 </dd>
<dt><b>Returns</b></dt>
<dd>the <a href="XTreeNode.html">XTreeNode</a> for the node closest to that location, null if nothing is viewable or there is no model
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="isEditing" class="membertitle">isEditing</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>isEditing</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Returns <b>true</b> if one of tree's nodes is being currently edited.
 </dd>
<dd><p>The node that is being edited can be obtained using <method scope="com::sun::star::view">XSelectionSupplier::getSelection()</method>.

 </dd>
<dt><b>Returns</b></dt>
<dd><b>true</b> if the user is currently editing a node
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="stopEditing" class="membertitle">stopEditing</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>stopEditing</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Ends the current editing session.
 </dd>
<dd><p>All registered <a href="XTreeEditListener.html">XTreeEditListener</a> are notified if an editing session was in progress</p>
 <p>Has no effect if the tree isn't being edited.</p>

 </dd>
<dt><b>Returns</b></dt>
<dd><b>true</b> if editing was in progress and is now stopped, <b>false</b> if editing was not in progress
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="cancelEditing" class="membertitle">cancelEditing</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">void</td>
</tr>
<tr>
<td valign="top"><b>cancelEditing</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Cancels the current editing session.
 </dd>
<dd><p>Has no effect if the tree isn't being edited.</p>
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="startEditingAtNode" class="membertitle">startEditingAtNode</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">void</td>
</tr>
<tr>
<td valign="top"><b>startEditingAtNode</b>(</td>
<td valign="top">[in] <a href="XTreeNode.html">XTreeNode</a></td>
<td valign="bottom">&nbsp;Node )</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/IllegalArgumentException.html">IllegalArgumentException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Selects <var>Node</var> and initiates editing.

 </dd>
<dd><p>If <a href="TreeControlModel.html">TreeControlModel</a>::<a href="TreeControlModel.html#Editable">Editable</a> is <b>false</b> or if there are no
 registered <a href="XTreeEditListener.html">XTreeEditListener</a>, this call has no effect.</p>

 <p>Calling this method also ensures that <var>Node</var> will become visible.</p>

 </dd>
<dt><b>Parameter Node</b></dt>
<dd>the <a href="XTreeNode.html">XTreeNode</a> identifying a node.

 </dd>
<dt><b>Throws</b></dt>
<dd>::com::sun::star::lang::IllegalArgumentException
 if <var>Node</var> is not a valid node of the corresponding <a href="XTreeDataModel.html">XTreeDataModel</a>.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="addTreeEditListener" class="membertitle">addTreeEditListener</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">void</td>
</tr>
<tr>
<td valign="top"><b>addTreeEditListener</b>(</td>
<td valign="top">[in] <a href="XTreeEditListener.html">XTreeEditListener</a></td>
<td valign="bottom">&nbsp;Listener );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Adds a <a href="XTreeEditListener.html">XTreeEditListener</a>.

 </dd>
<dt><b>Parameter xListener</b></dt>
<dd>a <a href="XTreeEditListener.html">XTreeEditListener</a> that will be notified 
 before and after a tree node is edited.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="removeTreeEditListener" class="membertitle">removeTreeEditListener</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">void</td>
</tr>
<tr>
<td valign="top"><b>removeTreeEditListener</b>(</td>
<td valign="top">[in] <a href="XTreeEditListener.html">XTreeEditListener</a></td>
<td valign="bottom">&nbsp;Listener );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Removes a <a href="XTreeEditListener.html">XTreeEditListener</a>.

 </dd>
<dt><b>Parameter xListener</b></dt>
<dd>the <a href="XTreeEditListener.html">XTreeEditListener</a> to remove
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
</table>
<a name="AttributesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle" colspan="2">Attributes' Summary</td>
</tr>
<tr>
<td class="imsum_left"><a href="#DefaultExpandedGraphicURL">DefaultExpandedGraphicURL</a></td>
<td class="imsum_right">If the given URL points to a loadable graphic, the graphic is rendered
 before expanded non leaf nodes.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#DefaultCollapsedGraphicURL">DefaultCollapsedGraphicURL</a></td>
<td class="imsum_right">If the given URL points to a loadable graphic, the graphic is rendered
 before collapsed non leaf nodes.

 &nbsp;</td>
</tr>
</table>
<a name="AttributesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle">Attributes' Details</td>
</tr>
<tr>
<td class="imdetail"><a name="DefaultExpandedGraphicURL" class="membertitle">DefaultExpandedGraphicURL</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>string <b>DefaultExpandedGraphicURL</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>If the given URL points to a loadable graphic, the graphic is rendered
 before expanded non leaf nodes.

 </dd>
<dd><p>This can be overriden for individual nodes by <a href="XTreeNode.html">XTreeNode</a>::<a href="XTreeNode.html#getExpandedGraphicURL">getExpandedGraphicURL()</a></p>
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="DefaultCollapsedGraphicURL" class="membertitle">DefaultCollapsedGraphicURL</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>string <b>DefaultCollapsedGraphicURL</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>If the given URL points to a loadable graphic, the graphic is rendered
 before collapsed non leaf nodes.

 </dd>
<dd><p>This can be overriden for individual nodes by <a href="XTreeNode.html">XTreeNode</a>::<a href="XTreeNode.html#getCollapsedGraphicURL">getCollapsedGraphicURL()</a></p>
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
</table>
<a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright &copy; 2008 Sun Microsystems, Inc.</p>

</div> <!-- id="adc-idlref" -->
</body>

</html>