Package com.hp.lft.sdk.winforms
Interface TreeViewNode
- All Superinterfaces:
SupportDragAndDrop
A tree view node of a .NET Windows Forms tree-view object.
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Clicks the state icon.void
collapse()
Hides sub-nodes of this node in the expanded tree-view control.void
Double-clicks the state icon.void
Activates the edit mode for the node in the tree-view control to enable renaming.void
expand()
Displays direct sub-nodes of this node in the tree-view control.void
Displays all nodes of the sub-tree that has this node as the root.Returns the full path of the node's first child node as a semi-colon delimited String.int
Returns the image index of the node.Returns the full path of the node's next sibling node as a semi-colon delimited String.int
Returns the index of the current overlay image.Returns the full path of the node's parent node as a semi-colon delimited string.getPath()
Returns the full path of the node as a semi-colon delimited string.int
getState()
Returns the state image index of the node.getText()
The text of this node.boolean
Indicates whether the node has children.boolean
Indicates whether this node is currently expanded.boolean
Indicates whether this node is selected.void
setNodeState
(int index) Sets the state of the check box icon of the specified node in the tree-view control.Methods inherited from interface com.hp.lft.sdk.SupportDragAndDrop
dragAndDropOn, dragAndDropOn
-
Method Details
-
isExpanded
Indicates whether this node is currently expanded.- Returns:
- true if expanded
- Throws:
GeneralLeanFtException
- if error occurs during execution
-
getFirstChildPath
Returns the full path of the node's first child node as a semi-colon delimited String.- Returns:
- the path
- Throws:
GeneralLeanFtException
- if error occurs during execution
-
hasChildren
Indicates whether the node has children.- Returns:
- true if the node has children.
- Throws:
GeneralLeanFtException
- if error occurs during execution
-
getImageIndex
Returns the image index of the node.- Returns:
- the image index
- Throws:
GeneralLeanFtException
- if error occurs during execution
-
getNextSiblingPath
Returns the full path of the node's next sibling node as a semi-colon delimited String.- Returns:
- the path
- Throws:
GeneralLeanFtException
- if error occurs during execution
-
getOverlayImageIndex
Returns the index of the current overlay image.- Returns:
- the index
- Throws:
GeneralLeanFtException
- if error occurs during execution
-
getParentPath
Returns the full path of the node's parent node as a semi-colon delimited string.- Returns:
- the parent's path
- Throws:
GeneralLeanFtException
- if error occurs during execution
-
getPath
Returns the full path of the node as a semi-colon delimited string.- Returns:
- the path
- Throws:
GeneralLeanFtException
- if error occurs during execution
-
isSelected
Indicates whether this node is selected.- Returns:
- true if selected
- Throws:
GeneralLeanFtException
- if error occurs during execution
-
getState
Returns the state image index of the node.- Returns:
- the index
- Throws:
GeneralLeanFtException
- if error occurs during execution
-
getText
The text of this node. Returns an empty string if the node does not contain any text.- Returns:
- the text
- Throws:
GeneralLeanFtException
- if error occurs during execution
-
setNodeState
Sets the state of the check box icon of the specified node in the tree-view control.- Parameters:
index
- the state index- Throws:
GeneralLeanFtException
- if error occurs during execution
-
clickState
Clicks the state icon.- Throws:
GeneralLeanFtException
- if error occurs during execution
-
doubleClickState
Double-clicks the state icon.- Throws:
GeneralLeanFtException
- if error occurs during execution
-
collapse
Hides sub-nodes of this node in the expanded tree-view control.- Throws:
GeneralLeanFtException
- if error occurs during execution
-
enableLabelEditing
Activates the edit mode for the node in the tree-view control to enable renaming.
This method only enables the node for renaming. To actually rename the node, you must set its value using theEditField
orEditor
test object, together with an applicable method.- Throws:
GeneralLeanFtException
- if error occurs during execution
-
expand
Displays direct sub-nodes of this node in the tree-view control.- Throws:
GeneralLeanFtException
- if error occurs during execution
-
expandAll
Displays all nodes of the sub-tree that has this node as the root.- Throws:
GeneralLeanFtException
- if error occurs during execution
-