Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous


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

interface XTreeEditListener
Base Interfaces
XTreeEditListener
┗ ::com::sun::star::lang::XEventListener

::com::sun::star::lang::XEventListener
(referenced interface's summary:)
base interface for all event listeners interfaces.
Description
You can implement this interface and register with addTreeEditListener to get notifcaitons when editing of a node starts and ends.

You have to set the TreeControlModel::Editable property to true before a tree supports editing.


Methods' Summary
nodeEditing This method is called from the TreeControl implementation when editing of Node is requested by calling XTreeControl::startEditingAtNode().  
nodeEdited This method is called from the TreeControl implementation when editing of Node is finished and was not canceled.  
Methods' Details
nodeEditing
void
nodeEditing( [in] XTreeNode  Node )
raises( ::com::sun::star::util::VetoException );

Description
This method is called from the TreeControl implementation when editing of Node is requested by calling XTreeControl::startEditingAtNode().
Parameter Node
the XTreeNode for that an edit request was fired by calling startEditingAtNode
Throws
VetoException if thrown the editing will not start.
nodeEdited
void
nodeEdited( [in] XTreeNode  Node,
[in] string  NewText );

Description
This method is called from the TreeControl implementation when editing of Node is finished and was not canceled.

Implementations that register a XTreeEditListener must update the display value at the Node.

Parameter Node
the XTreeNode for that an edit request was fired by calling startEditingAtNode
Parameter NewText
the text that was entered by the user.
Top of Page

Apache Software Foundation

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

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