Methods' Details |
isNodeExpanded
- Description
- Returns true if Node is currently expanded.
- Parameter Node
- the XTreeNode specifying the node to check.
- Returns
- false if Node or at least one of its parent nodes are collapsed,
true if Node and all of its parent nodes are expanded.
- Throws
- ::com::sun::star::lang::IllegalArgumentException
if Node is not a valid node of the corresponding XTreeDataModel.
|
|
isNodeCollapsed
- Description
- Returns true if Node is currently collapsed.
- Parameter Node
- the XTreeNode specifying the node to check
- Returns
- true if Node or at least one of its parent nodes are collapsed,
false if Node and all of its parent nodes are expanded
- Throws
- ::com::sun::star::lang::IllegalArgumentException
if Node is not a valid node of the corresponding XTreeDataModel.
|
|
makeNodeVisible
- Description
- Ensures that Node is currently visible.
This includes expanding all parent nodes and scroll the control so this
node is visible in the controls display area.
- Parameter Node
- the XTreeNode specifying the node to make visible.
- Throws
- ::com::sun::star::lang::IllegalArgumentException
if Node is not a valid node of the corresponding XTreeDataModel.
- Throws
- ExpandVetoException
if Nodecan't be made visible since at least one of the parent nodes are
collapsed and expanding failed because at least one of the registered
XTreeExpansionListener raised a ExpandVetoException.
|
|
isNodeVisible
- Description
- Returns true if Node is currently visible.
Visible means it is either the root or all of its parents are expanded.
- Returns
- true if Node is visible, otherwise false
- Throws
- ::com::sun::star::lang::IllegalArgumentException
if Node is not a valid node of the corresponding XTreeDataModel.
|
|
expandNode
- Description
- Ensures that Node is expanded and visible.
If Node is a leaf node, this will have no effect.
- Parameter Node
- the XTreeNode identifying a node.
- Throws
- ::com::sun::star::lang::IllegalArgumentException
if Node is not a valid node of the corresponding XTreeDataModel.
- Throws
- ExpandVetoException
if expanding Node failed because at least one of the registered
XTreeExpansionListener raised a ExpandVetoException.
|
|
collapseNode
- Description
- Ensures that Node is collapsed.
- Parameter Node
- the XTreeNode identifying a node
- Throws
- ::com::sun::star::lang::IllegalArgumentException
if Node is not a valid node of the corresponding XTreeDataModel.
- Throws
- ExpandVetoException
if collapsing Node failed because at least one of the registered
XTreeExpansionListener raised a ExpandVetoException.
|
|
addTreeExpansionListener
- Description
- Adds a listener for ::TreeExpansion events.
- Parameter Listener
- a XTreeExpansionListener that will be notified when a tree
node is expanded or collapsed.
|
|
removeTreeExpansionListener
- Description
- Removes a listener for ::TreeExpansion events.
- Parameter Listener
- the XTreeExpansionListener to remove.
|
|
getNodeForLocation
XTreeNode |
getNodeForLocation( |
[in] long |
x, |
| [in] long |
y ); |
- Description
- Returns the node at the specified location.
- Parameter x
- an integer giving the number of pixels horizontally from the left edge of the controls display area
- Parameter y
- an integer giving the number of pixels vertically from the top edge of the controls display area
- Returns
- the XTreeNode for the node at that location, or 0 if there is no node at the given position
|
|
getClosestNodeForLocation
XTreeNode |
getClosestNodeForLocation( |
[in] long |
x, |
| [in] long |
y ); |
- Description
- Returns the node that is closest to x,y.
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 getNodeForLocation().
- Parameter x
- 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
- Returns
- the XTreeNode for the node closest to that location, null if nothing is viewable or there is no model
|
|
getNodeRect
- Description
- returns the rectangle occupied by the visual representation of the given node
- Parameter Node
- the node whose geometry should be obtained
- Throws
- ::com::sun::star::lang::IllegalArgumentException
if the given node is NULL, or does not belong to the tree's data model
|
|
isEditing
- Description
- Returns true if one of tree's nodes is being currently edited.
The node that is being edited can be obtained using XSelectionSupplier::getSelection().
- Returns
- true if the user is currently editing a node
|
|
stopEditing
- Description
- Ends the current editing session.
All registered XTreeEditListener are notified if an editing session was in progress
Has no effect if the tree isn't being edited.
- Returns
- true if editing was in progress and is now stopped, false if editing was not in progress
|
|
cancelEditing
- Description
- Cancels the current editing session.
Has no effect if the tree isn't being edited.
|
|
startEditingAtNode
- Description
- Selects Node and initiates editing.
If TreeControlModel::Editable is false or if there are no
registered XTreeEditListener, this call has no effect.
Calling this method also ensures that Node will become visible.
- Parameter Node
- the XTreeNode identifying a node.
- Throws
- ::com::sun::star::lang::IllegalArgumentException
if Node is not a valid node of the corresponding XTreeDataModel.
|
|
addTreeEditListener
|
removeTreeEditListener
|
Copyright © 2000, 2013 LibreOffice contributors and/or their affiliates. All rights reserved.
LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.
The Document Foundation acknowledges all community members, please find more info at our website.