Interface XMutableTreeNode

Devguide

Index

Methods' Summary

Attributes' Summary

Methods' Details

Attributes' Details

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

interface XMutableTreeNode

Base Interfaces

XMutableTreeNode
┗ XTreeNode

XTreeNode

(referenced interface's summary:): An instance implementing this interface represents the model data for an entry in a XTreeDataModel.

Description: Represents a mutable tree node as used by the MutableTreeDataModel

Methods' Summary
appendChild	appends `ChildNode` to this instance.
insertChildByIndex	inserts `ChildNode` to this instance at the given index.
removeChildByIndex	removes the node from this instance at the specified index.
setHasChildrenOnDemand	Changes if the children of this node are created on demand.
setDisplayValue	sets the display value of this node
setNodeGraphicURL	The URL for a graphic that is rendered before the text part of this node.
setExpandedGraphicURL	The URL for a graphic that is rendered to visualize expanded non leaf nodes.
setCollapsedGraphicURL	The URL for a graphic that is rendered to visualize collapsed non leaf nodes.

Attributes' Summary
DataValue	Stores an implementation dependend value.

Methods' Details

appendChild

void
appendChild(	[in] XMutableTreeNode	ChildNode )
raises(	::com::sun::star::lang::IllegalArgumentException );

Description: appends ChildNode to this instance.
Throws: ::com::sun::star::lang::IllegalArgumentException if ChildNode is not a valid node of the corresponding XTreeDataModel.

insertChildByIndex

void
insertChildByIndex(	[in] long	Index,
	[in] XMutableTreeNode	ChildNode )
raises(	::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::lang::IndexOutOfBoundsException );

Description: inserts ChildNode to this instance at the given index.
Parameter Index: the index where the node will be inserted to this instance.
Throws: ::com::sun::star::lang::IllegalArgumentException if ChildNode is not a valid node of the corresponding XTreeDataModel.
Throws: ::com::sun::star::lang::IndexOutOfBoundsException if Index is less than 0 or greater then XTreeNode::getChildCount().

removeChildByIndex

void
removeChildByIndex(	[in] long	Index )
raises(	::com::sun::star::lang::IndexOutOfBoundsException );

Description: removes the node from this instance at the specified index.
Parameter Index: the index of the node to be removed from this instance.
Throws: ::com::sun::star::lang::IndexOutOfBoundsException if Index is less than 0 or greater then XTreeNode::getChildCount().

setHasChildrenOnDemand

void
setHasChildrenOnDemand(	[in] boolean	ChildrenOnDemand );

Description: Changes if the children of this node are created on demand.
See also: XTreeNode::hasChildrenOnDemand()

setDisplayValue

void
setDisplayValue(	[in] any	Value );

Description: sets the display value of this node

setNodeGraphicURL

void
setNodeGraphicURL(	[in] string	URL );

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.

setExpandedGraphicURL

void
setExpandedGraphicURL(	[in] string	URL );

Description: The URL for a graphic that is rendered to visualize expanded non leaf nodes.; If URL is empty, XTreeControl::DefaultExpandedGraphicURL is used.

setCollapsedGraphicURL

void
setCollapsedGraphicURL(	[in] string	URL );

Description: The URL for a graphic that is rendered to visualize collapsed non leaf nodes.; If URL is empty, XTreeControl::DefaultCollapsedGraphicURL is used.

Attributes' Details

DataValue

any DataValue; Description Stores an implementation dependend value. You can use this attribute to store data for this node that is independend of the display value

Top of Page

Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.

API

SDK

Tips ‘n’ Tricks

Miscellaneous