com.goldencode.p2j.ui

Interface TreeFace

All Superinterfaces:

CustomFont, HasVisible, Nodes, OcxDragDrop, RemoveNode

All Known Subinterfaces:

HandleCommon, TreeList, TreeView

All Known Implementing Classes:

TreeListWidget, TreeViewWidget, TreeWidgetBase

public interface TreeFace
extends Nodes, RemoveNode, CustomFont, OcxDragDrop, HasVisible

Interface for the server side tree widget implementations.

Method Summary

Modifier and Type	Method and Description
void	clearAll() Unconditionally removes all the nodes from the tree.
void	clearNodesImageList() Clears all images used as node images.
void	collapseAll() Collapses all the nodes.
void	collapseAllExcept(handle node) Collapses all the nodes, except the one specified.
void	collapseNode(NumberType nodeId) Collapses a node.
integer	createImage(character path) Creates an image that can be later used in setTreeNodeIcons(NumberType, NumberType, NumberType) and createSubNode(NumberType, character, character, logical, NumberType, NumberType, integer).
integer	createMergedImage(integer imgIndex, character imgFile) Implements legacy method CREATE-MERGED-IMAGE.
void	createSubNode(NumberType parentNodeId, character nodeText, character nodeKey, logical hasChildren, NumberType collapseIcon, NumberType expandIcon, character tooltip, integer newNodeId) Creates a new node for the supplied parent node.
default void	createSubNode(NumberType parentNodeId, character nodeText, character nodeKey, logical hasChildren, NumberType collapseIcon, NumberType expandIcon, integer newNodeId) Creates a new node for the supplied parent node.
void	deleteChildNodes(NumberType nodeId) Recursively delete all node children.
void	ensureNodeVisible(character nodeKey) Makes the supplied node the first visible node (at the top of the view if possible).
void	expandAll() Expands all the nodes.
void	expandNode(NumberType nodeId) Expands a node.
handle	findNode(character nodeKey) Finds a node in the tree.
handle	findNode(NumberType nodeId) Finds a node in the tree.
handle	getDraggedNode() The attribute holds the dragged node that is the target of the current trigger.
handle	getDraggedOverNode() The attribute holds the dragged over node that is the target of the current trigger.
handle	getDropHighlight() Returns a reference to a node object that is highlighted with the system highlight color when the cursor moves over it.
void	getFirstChildNode(NumberType nodeId, integer outChildId, character outChildKey) Returns the first child node of the specified parent node.
integer	getFirstNode() Getter for the FIRST-NODE attribute.
handle	getFirstVisibleNode() Getter for the FIRST-VISIBLE-NODE attribute.
handle	getFocusedAndSelectedNode() Getter for the FOCUSED-AND-SELECTED-NODE attribute.
character	getFocusedAndSelectedNodeKey() Getter for the FOCUSED-AND-SELECTED-NODE-KEY attribute.
handle	getFocusedNode() Getter for the FOCUSED-NODE attribute.
character	getFocusedNodeKey() Getter for the FOCUSED-NODE-KEY attribute.
integer	getHWND() Returns its widget identifier.
handle	getImageList() Returns the assigned imagelist or unknown.
integer	getIndentation() Getter for the INDENTATION attribute.
integer	getLineStyle() Gets the LINE-STYLE attribute value.
integer	getMousePointerNum() Gets the type of mouse pointer displayed when over part of an object.
character	getNewNodeLabel() Returns the new label for the trigger node.
integer	getNextNode(NumberType nodeId) Returns the next visible node from the specified node.
void	getNextSiblingNode(NumberType nodeId, integer outSiblingId, character outSiblingKey) Returns the next sibling node of the specified node.
character	getNodeAt(NumberType x, NumberType y) Returns key of the node at the specified location relative to the tree's top-left corner.
integer	getNodeBgColor(NumberType nodeId) Returns background color of the supplied node.
boolean	getNodeBold(character nodeKey) Getter for the NODE-BOLD attribute.
integer	getNodeFgColor(NumberType nodeId) Returns foreground color of the supplied node.
logical	getNodeHasChildren(NumberType nodeId) Returns true if the node represented by the supplied node id is allowed to have child nodes.
integer	getNodeHeight() Getter for the NODE-HEIGHT attribute.
integer	getNodeLevel(character nodeKey) Returns tree level of the specified node.
character	getNodeText(character nodeKey) Implements legacy method GET-NODE-TEXT.
logical	getNodeVisibleInViewPort(character nodeKey) The method returns true if the specified node is visible in the current view port.
void	getParentNode(NumberType nodeId, integer outParentId, character outParentKey) Returns the parent node of the specified node.
void	getPrevSiblingNode(NumberType nodeId, integer outSiblingId, character outSiblingKey) Returns the previous sibling node of the specified node.
java.lang.String	getPrivateData(character nodeKey) Getter for the PRIVATE-DATA attribute.
logical	getRemoveNodeOnCollapse() Getter for the REMOVE-NODE-ON-COLLAPSE attribute.
integer	getRowHeight() Returns row height for tree based widget.
integer	getScrollNodeCount() The attribute holds the number of scrolled nodes before firing the current trigger.
integer	getScrollWheelLines() Getter for the SCROLL-WHEEL-LINES attribute.
handle	getSelectedNode() Getter for the SELECTED-NODE attribute.
void	getSelectedNodeColors(integer outBg, integer outFg) Returns background and foreground colors for selected nodes.
integer	getSelectedNodeId() Getter for the SELECTED-NODE-ID attribute.
character	getSelectedNodeKey() Getter for the SELECTED-NODE-KEY attribute.
integer	getStyle() Gets the STYLE attribute value.
integer	getTopVisibleNodeId() Returns node id of the top visible node.
handle	getTriggerNode() The attribute holds the node that is the target of the current trigger.
integer	getVisibleNodeCount() Getter for the VISIBLE-NODE-COUNT attribute.
comhandle	hitTest(NumberType x, NumberType y) Get the TreeView node under mouse cursor as a node handle.
handle	hitTestFwd(NumberType x, NumberType y) Get the TreeView node under mouse cursor as a node handle.
logical	isBuildingTree() Getter for the BUILDING-TREE attribute.
logical	isCheckBoxes() Returns true if a check box is displayed next to each tree node in the tree view; otherwise, false.
logical	isDblClickExpanding() Getter for the DBL-CLICK-EXPANDING attribute.
logical	isDragDrop() Getter for the DRAG-DROP attribute.
logical	isDragDropOtherTree() Getter for the ALLOW-DRAG-DROP-OTHER-TREE attribute.
logical	isExpandOnEnter() Getter for the EXPAND-ON-ENTER attribute.
logical	isExpandOnSingleClick() Getter for the EXPAND-ON-SINGLE-CLICK attribute.
logical	isMultiSelect(logical extended) IS-MULTI-SELECT method.
logical	isNodeExpanded(NumberType nodeId) Returns true when the node of the supplied id is expanded.
logical	isShowButtons() Getter for the SHOW-BUTTONS attribute.
logical	isTextEdit() Getter for the TEXT-EDIT attribute.
integer	nodeKeyToId(character nodeKey) Implement legacy method NODE-KEY-TO-ID.
void	scrollNodeToTop(character nodeKey) Makes the supplied node the first visible (at the top of the view if possible) node.
void	scrollVertical(NumberType lines) Scrolls the tree view the specified number of lines.
void	selectSetFirstVisibleNode(NumberType nodeId) Makes the supplied node the first visible node (at the top of the view if possible).
void	setBuildingTree(logical value) Setter for the BUILDING-TREE attribute.
void	setCheckBoxes(logical value) Set to true to display a check box next to each tree node in the tree view; otherwise, false.
void	setDblClickExpanding(logical value) Setter for the DBL-CLICK-EXPANDING attribute.
void	setDragDrop(logical value) Setter for the DRAG-DROP attribute.
void	setDragDropOtherTree(logical value) Setter for the ALLOW-DRAG-DROP-OTHER-TREE attribute.
void	setDropHighlight(handle node) Sets a reference to a node object that is highlighted with the system highlight color when the cursor moves over it.
void	setExpandOnEnter(logical value) Setter for the EXPAND-ON-ENTER attribute.
void	setExpandOnSingleClick(logical value) Setter for the EXPAND-ON-SINGLE-CLICK attribute.
void	setImageList(handle imgList) Assigns an imagelist resource to the tree.
void	setImageList(ImageList imgList) Assigns an imagelist resource to the tree.
void	setIndentation(NumberType value) Setter for the INDENTATION attribute.
void	setLineStyle(integer value) Sets the LINE-STYLE attribute value.
void	setMousePointerNum(integer value) Sets the type of mouse pointer displayed when over part of an object.
void	setMultiSelect(logical extended, logical value) SET-MULTI-SELECT method.
void	setNewNodeLabel(character newLabel) Sets the new label for the trigger node.
void	setNodeBgColor(NumberType nodeId, NumberType bgrValue) Sets background color for the supplied node.
void	setNodeBold(character nodeKey, logical value) Setter for the NODE-BOLD attribute.
void	setNodeFgColor(NumberType nodeId, NumberType fgrValue) Sets foreground color for the supplied node.
void	setNodeHasChildren(NumberType nodeId, logical value) Set the child node allowance on the node represented by the supplied node.
void	setNodeHeight(NumberType value) Setter for the NODE-HEIGHT attribute.
void	setNodeText(character nodeKey, character text) Implements legacy method SET-NODE-TEXT.
void	setPrivateData(character nodeKey, character value) Setter for the PRIVATE-DATA attribute.
void	setRemoveNodeOnCollapse(logical value) Setter for the REMOVE-NODE-ON-COLLAPSE attribute.
void	setRowHeight(NumberType heightValue) Sets row height for tree based widget.
void	setScrollWheelLines(NumberType value) Setter for the SCROLL-WHEEL-LINES attribute.
void	setSelectedNode(handle value) Setter for the SELECTED-NODE attribute.
void	setSelectedNodeColors(NumberType bg, NumberType fg) Sets background and foreground colors for selected nodes.
void	setSelectedNodeKey(character value) Setter for the SELECTED-NODE-KEY attribute.
void	setShowButtons(logical value) Setter for the SHOW-BUTTONS attribute.
void	setStyle(integer value) Sets the STYLE attribute value.
void	setTextEdit(logical value) Setter for the TEXT-EDIT attribute.
void	setTreeNodeIcons(NumberType nodeId, NumberType icon, NumberType expandIcon) Sets leaf, collapse and expand icons for the specified node.
void	startLabelEdit() Begins a label editing operation for the current node.

Methods inherited from interface com.goldencode.p2j.ui.Nodes

getNodes

Methods inherited from interface com.goldencode.p2j.ui.RemoveNode

removeNode

Methods inherited from interface com.goldencode.p2j.ui.CustomFont

getFontInfo, getFontName, getFontSize, isFontBold, isFontItalic, isFontUnderline, setFontBold, setFontItalic, setFontName, setFontSize, setFontUnderline

Methods inherited from interface com.goldencode.p2j.ui.OcxDragDrop

getAllowedEffects, getDataFormat, getEffect, getOleDragMode, getOleDropMode, getOleX, getOleY, getState, isDefaultCursors, oleDrag, setAllowedEffects, setDataFormat, setDefaultCursors, setEffect, setOleDragMode, setOleDropMode, setOleX, setOleY, setState

Methods inherited from interface com.goldencode.p2j.util.HasVisible

isVisible, setVisible, setVisible

Method Detail

isTextEdit

logical isTextEdit()

Getter for the TEXT-EDIT attribute. When TEXT-EDIT is set to true the widget allows to edit the node text by the end user. Note that currently this feature is not supported..

Returns:

the attribute value.

setTextEdit

void setTextEdit(logical value)

Setter for the TEXT-EDIT attribute. When TEXT-EDIT is set to true the widget allows to edit the node text by the end user. Note that currently this feature is not supported..

Parameters:

value - the attribute value

getIndentation

integer getIndentation()

Getter for the INDENTATION attribute. The indentation value sets the pixel size of the indentation for one tree level. Note that currently this feature is not supported..

Returns:

the attribute value.

setIndentation

void setIndentation(NumberType value)

Setter for the INDENTATION attribute. The indentation value sets the pixel size of the indentation for one tree level. Note that currently this feature is not supported..

Parameters:

value - the attribute value

isDragDrop

logical isDragDrop()

Getter for the DRAG-DROP attribute. When DRAG-DROP set to true the tree nodes can be dragged by the end user. Note that currently this feature is not supported..

Returns:

the attribute value.

setDragDrop

void setDragDrop(logical value)

Setter for the DRAG-DROP attribute. When DRAG-DROP set to true the tree nodes can be dragged by the end user. Note that currently this feature is not supported.

Parameters:

value - the attribute value

getDraggedNode

handle getDraggedNode()

The attribute holds the dragged node that is the target of the current trigger. The value is valid only during the following triggers: TREE-DRAG-START, TREE-DRAG-OVER, TREE-DRAG-DROP.

Returns:

A handle for the dragged node.

getDraggedOverNode

handle getDraggedOverNode()

The attribute holds the dragged over node that is the target of the current trigger. The value is valid only during the following triggers: TREE-DRAG-OVER: represents the node over which the dragging is done TREE-DRAG-DROP: represents the node over which the dragging dropped

Returns:

A handle for the dragged over node.

getScrollNodeCount

integer getScrollNodeCount()

The attribute holds the number of scrolled nodes before firing the current trigger. The value is valid only during the following trigger: CHANGE-TOP-VISIBLE-NODE.

Returns:

The index of the trigger column.

getDropHighlight

handle getDropHighlight()

Returns a reference to a node object that is highlighted with the system highlight color when the cursor moves over it.

Returns:

The reference to a node

setDropHighlight

void setDropHighlight(handle node)

Sets a reference to a node object that is highlighted with the system highlight color when the cursor moves over it.

Parameters:

node - The reference to a node

getSelectedNode

handle getSelectedNode()

Getter for the SELECTED-NODE attribute. The method returns a handle the currently selected node or unknown handle when no node is currently selected. The handle will wrap an instance of TreeViewNode.

Returns:

the attribute value.

setSelectedNode

void setSelectedNode(handle value)

Setter for the SELECTED-NODE attribute. The method sets the node to be made visible and selected in the tree widget.

Parameters:

value - the attribute value

getSelectedNodeId

integer getSelectedNodeId()

Getter for the SELECTED-NODE-ID attribute. The method returns node id of the currently selected node or unknown when no node is currently selected.

Returns:

the attribute value.

getSelectedNodeKey

character getSelectedNodeKey()

Getter for the SELECTED-NODE-KEY attribute. The method returns keys of the currently selected nodes, delimited with the char(1), or an empty string when no node is currently selected.

Returns:

the attribute value.

setSelectedNodeKey

void setSelectedNodeKey(character value)

Setter for the SELECTED-NODE-KEY attribute. The method sets key of the node to be made visible and selected in the tree widget.

Parameters:

value - the attribute value

getFocusedNode

handle getFocusedNode()

Getter for the FOCUSED-NODE attribute. The method returns a handle of the currently focused node or unknown handle when no node is currently focused. The handle will wrap an instance of TreeViewNode. Note that the runtime behavior is the same as for the SELECTED-NODE attribute.

Returns:

the attribute value.

getFocusedNodeKey

character getFocusedNodeKey()

Getter for the FOCUSED-NODE-KEY attribute. The method returns a key of the currently focused node or unknown when no node is currently focused. Note that the runtime behavior is the same as for the SELECTED-NODE-KEY attribute.

Returns:

the attribute value.

getFocusedAndSelectedNode

handle getFocusedAndSelectedNode()

Getter for the FOCUSED-AND-SELECTED-NODE attribute. The method returns a handle of the currently focused node or unknown handle when no node is currently focused. The handle will wrap an instance of TreeViewNode. Note that the runtime behavior is the same as for the SELECTED-NODE attribute.

Returns:

the attribute value.

getFocusedAndSelectedNodeKey

character getFocusedAndSelectedNodeKey()

Getter for the FOCUSED-AND-SELECTED-NODE-KEY attribute. The method returns key of the currently focused node or unknown when no node is currently focused. Note that the runtime behavior is the same as for the SELECTED-NODE attribute.

Returns:

the attribute value.

getNodeHeight

integer getNodeHeight()

Getter for the NODE-HEIGHT attribute. The node height value returns the pixel height of every node displayed in the widget. Note that currently this feature is not supported.

Returns:

the attribute value.

setNodeHeight

void setNodeHeight(NumberType value)

Setter for the NODE-HEIGHT attribute. Use NODE-HEIGHT to customize the pixel node height. Note that currently this feature is not supported.

Parameters:

value - the attribute value

getVisibleNodeCount

integer getVisibleNodeCount()

Getter for the VISIBLE-NODE-COUNT attribute. The indentation value sets the pixel size of the indentation for one tree level. Note that currently text node editing is not supported.

Returns:

the attribute value.

getFirstVisibleNode

handle getFirstVisibleNode()

Getter for the FIRST-VISIBLE-NODE attribute.

Returns:

the node that is fully displayed as the first node in the current viewport, or unknown when the there are no nodes in the view.

getFirstNode

integer getFirstNode()

Getter for the FIRST-NODE attribute.

Returns:

the first node displayed in the tree, or unknown when the there are no nodes in the widget.

getNextNode

integer getNextNode(NumberType nodeId)

Returns the next visible node from the specified node. The method recursively traverses the visible and expanded nodes and returns the first node after the specified one or unknown if no such node is found.

Parameters:

nodeId - Id of the node for to start the search.

Returns:

see above.

selectSetFirstVisibleNode

void selectSetFirstVisibleNode(NumberType nodeId)

Makes the supplied node the first visible node (at the top of the view if possible).

Parameters:

nodeId - the node to make the top visible

getNodeFgColor

integer getNodeFgColor(NumberType nodeId)

Returns foreground color of the supplied node. Until the widget is realized the method returns undefined value. The returned color value is compatible with the P4GL color binary format, i.e. BGR encoding.

Parameters:

nodeId - a valid node id

Returns:

the color value or unknown if the node is not found or the widget has not been realized.

setNodeFgColor

void setNodeFgColor(NumberType nodeId,
                    NumberType fgrValue)

Sets foreground color for the supplied node.

Parameters:

nodeId - a valid node id

fgrValue - the new color

getNodeBgColor

integer getNodeBgColor(NumberType nodeId)

Returns background color of the supplied node. Until the widget is realized the method returns undefined value. The returned color value is compatible with the P4GL color binary format, i.e. BGR encoding.

Parameters:

nodeId - a valid node id

Returns:

the color value or unknown if the node is not found or the widget has not been realized.

setNodeBgColor

void setNodeBgColor(NumberType nodeId,
                    NumberType bgrValue)

Sets background color for the supplied node.

Parameters:

nodeId - a valid node id

bgrValue - the new color

getSelectedNodeColors

void getSelectedNodeColors(integer outBg,
                           integer outFg)

Returns background and foreground colors for selected nodes. Until the widget is realized the method returns undefined value. The returned color value is compatible with the P4GL color binary format, i.e. BGR (blue red green) encoding.

Parameters:

outBg - the out parameter that will be assigned the background color for selected nodes

outFg - the out parameter that will be assigned the foreground color for selected nodes

setSelectedNodeColors

void setSelectedNodeColors(NumberType bg,
                           NumberType fg)

Sets background and foreground colors for selected nodes. The expected color format is the P4GL compatible BRG (blue red green) encoding.

Parameters:

bg - the new background color

fg - the new foreground color

ensureNodeVisible

void ensureNodeVisible(character nodeKey)

Makes the supplied node the first visible node (at the top of the view if possible).

Parameters:

nodeKey - the node to make the top visible

createSubNode

default void createSubNode(NumberType parentNodeId,
                           character nodeText,
                           character nodeKey,
                           logical hasChildren,
                           NumberType collapseIcon,
                           NumberType expandIcon,
                           integer newNodeId)

Creates a new node for the supplied parent node. To create a node at the root level set parentNodeId to 0.

Parameters:

parentNodeId - Id of the parent node for the newly created node. Use 0 to create a root node.

nodeText - The node text.

nodeKey - The unique node key for the new node.

hasChildren - When set to false the node will be created as a leaf node without any children, use true for nodes that may hold child nodes.

collapseIcon - Optional collapse image. Use one of the built-in image ids or an id returned by createImage(character). For no image pass unknown or -1.

The built-in images are: Id Image 0 Default expanded icon. 1 Default collapsed icon. 2 Default leaf-node icon.

expandIcon - Optional expand image. Use one of the built-in image ids or an id returned by createImage(character). For no image pass unknown or -1.

The built-in images are: Id Image 0 Default expanded icon. 1 Default collapsed icon. 2 Default leaf-node icon.

newNodeId - Will be assigned node id of the created node if the operation succeeds.

createSubNode

void createSubNode(NumberType parentNodeId,
                   character nodeText,
                   character nodeKey,
                   logical hasChildren,
                   NumberType collapseIcon,
                   NumberType expandIcon,
                   character tooltip,
                   integer newNodeId)

Creates a new node for the supplied parent node. To create a node at the root level set parentNodeId to 0. Node image index is either the value returned by createImage(character) or one of the following fixed built-in values:

0 Default expanded icon. 1 Default collapsed icon. 2 Default leaf-node icon.

Parameters:

parentNodeId - Id of the parent node for the newly created node. Use 0 to create a root node.

nodeText - The node text.

nodeKey - The unique node key for the new node.

hasChildren - When set to false the node will be created as a leaf node without any children, use true for nodes that may hold child nodes.

collapseIcon - Optional collapse image index. See above for the value interpretation.

expandIcon - Optional collapse image index. See above for the value interpretation.

tooltip - The tooltip character string to be used with the new node.

newNodeId - Will be assigned node id of the created node if the operation succeeds.

isMultiSelect

logical isMultiSelect(logical extended)

IS-MULTI-SELECT method. Multi-selection is currently not supported.

Parameters:

extended - extended selection (TODO: find out semantics of this attribute)

Returns:

the multiselect value.

setMultiSelect

void setMultiSelect(logical extended,
                    logical value)

SET-MULTI-SELECT method. Multi-selection is currently not supported.

Parameters:

extended - extended selection (TODO: find out semantics of this attribute)

value - the new multiselect value

isNodeExpanded

logical isNodeExpanded(NumberType nodeId)

Returns true when the node of the supplied id is expanded.

Parameters:

nodeId - Id of the node to be checked.

Returns:

see above.

expandNode

void expandNode(NumberType nodeId)

Expands a node.

Parameters:

nodeId - Id of the node to be expanded.

collapseNode

void collapseNode(NumberType nodeId)

Collapses a node.

Parameters:

nodeId - Id of the node to be collapsed.

clearAll

void clearAll()

Unconditionally removes all the nodes from the tree.

isExpandOnSingleClick

logical isExpandOnSingleClick()

Getter for the EXPAND-ON-SINGLE-CLICK attribute.

Returns:

the attribute value.

setExpandOnSingleClick

void setExpandOnSingleClick(logical value)

Setter for the EXPAND-ON-SINGLE-CLICK attribute. When set to true nodes will be expanded/collapsed on single-click, when false nodes will be expanded/collapsed on double-click. The default is the double-click expansion.

Parameters:

value - the attribute value

isExpandOnEnter

logical isExpandOnEnter()

Getter for the EXPAND-ON-ENTER attribute.

Returns:

the attribute value.

setExpandOnEnter

void setExpandOnEnter(logical value)

Setter for the EXPAND-ON-ENTER attribute. When set to true nodes will be expanded/collapsed on single-click, when false nodes will be expanded/collapsed on double-click. The default is the double-click expansion.

Parameters:

value - the attribute value

isDblClickExpanding

logical isDblClickExpanding()

Getter for the DBL-CLICK-EXPANDING attribute. The attribute contains negated value of the EXPAND-ON-SINGLE-CLICK attribute.

Returns:

the attribute value.

setDblClickExpanding

void setDblClickExpanding(logical value)

Setter for the DBL-CLICK-EXPANDING attribute. The attribute contains negated value of the EXPAND-ON-SINGLE-CLICK attribute.

Parameters:

value - the attribute value.

getFirstChildNode

void getFirstChildNode(NumberType nodeId,
                       integer outChildId,
                       character outChildKey)

Returns the first child node of the specified parent node.

Parameters:

nodeId - Id of the parent node.

outChildId - Upon return will hold id of the found node, 0 if no such node found.

outChildKey - Upon return will hold key of the found node, empty string if no such node found.

getHWND

integer getHWND()

Returns its widget identifier.

Returns:

its widget identifier

getNextSiblingNode

void getNextSiblingNode(NumberType nodeId,
                        integer outSiblingId,
                        character outSiblingKey)

Returns the next sibling node of the specified node.

Parameters:

nodeId - Id of the node where the search should start.

outSiblingId - Upon return will hold id of the found node, 0 if no such node found.

outSiblingKey - Upon return will hold key of the found node, unknown if no such node found.

getPrevSiblingNode

void getPrevSiblingNode(NumberType nodeId,
                        integer outSiblingId,
                        character outSiblingKey)

Returns the previous sibling node of the specified node.

Parameters:

nodeId - Id of the node where the search should start.

outSiblingId - Upon return will hold id of the found node, 0 if no such node found.

outSiblingKey - Upon return will hold key of the found node, unknown if no such node found.

getParentNode

void getParentNode(NumberType nodeId,
                   integer outParentId,
                   character outParentKey)

Returns the parent node of the specified node.

Parameters:

nodeId - Id of the node where the search should start.

outParentId - Upon return will hold id of the found node, 0 if no such node found.

outParentKey - Upon return will hold key of the found node, unknown if no such node found.

getNodeLevel

integer getNodeLevel(character nodeKey)

Returns tree level of the specified node. The root nodes are at level 0, children at level 1, etc. When the supplied node key doesn't resolve a valid node the method will return unknown. If the supplied node key is an empty string, return -1.

Parameters:

nodeKey - Node key.

Returns:

see above.

scrollNodeToTop

void scrollNodeToTop(character nodeKey)

Makes the supplied node the first visible (at the top of the view if possible) node.

Parameters:

nodeKey - the node to make the top visible

isShowButtons

logical isShowButtons()

Getter for the SHOW-BUTTONS attribute.

Returns:

the attribute value.

setShowButtons

void setShowButtons(logical value)

Setter for the SHOW-BUTTONS attribute. Set to true to make the node expand icons (+-) visible, false to make the expand icons invisible.

Parameters:

value - the attribute value

isBuildingTree

logical isBuildingTree()

Getter for the BUILDING-TREE attribute.

Returns:

the attribute value.

setBuildingTree

void setBuildingTree(logical value)

Setter for the BUILDING-TREE attribute. When set to true any model changes (nodes added or removed) won't be reflected until the attribute is set back to false.

Parameters:

value - the attribute value

scrollVertical

void scrollVertical(NumberType lines)

Scrolls the tree view the specified number of lines. This feature is currently not implemented.

Parameters:

lines - The number of lines to scroll.

createImage

integer createImage(character path)

Creates an image that can be later used in setTreeNodeIcons(NumberType, NumberType, NumberType) and createSubNode(NumberType, character, character, logical, NumberType, NumberType, integer). The returned integer value is the 0-based index into the local node image list.

Parameters:

path - The image file path. Can be an absolute name or relative. When relative, the Propath entries will be searched.

Returns:

the index of the created image or -1 if path is invalid or image can not be created

getNodeAt

character getNodeAt(NumberType x,
                    NumberType y)

Returns key of the node at the specified location relative to the tree's top-left corner. Returns unknown when no node is found. This feature is currently not supported.

Parameters:

x - The x pixel coordinate.

y - The y pixel coordinate.

Returns:

key of the found key or unknown.

getNodeVisibleInViewPort

logical getNodeVisibleInViewPort(character nodeKey)

The method returns true if the specified node is visible in the current view port.

Parameters:

nodeKey - Node key of the node to check.

Returns:

see above.

setTreeNodeIcons

void setTreeNodeIcons(NumberType nodeId,
                      NumberType icon,
                      NumberType expandIcon)

Sets leaf, collapse and expand icons for the specified node.

Parameters:

nodeId - Id of the node to modify.

icon - Id of the image resource to be used as leaf icon (when the node has no children) or collapse icon (when the node has children). The image must be first created with the call to createImage(character).

expandIcon - Id of the image resource to be used as expand icon. The image must be first created with the call to createImage(character).

startLabelEdit

void startLabelEdit()

Begins a label editing operation for the current node.

clearNodesImageList

void clearNodesImageList()

Clears all images used as node images.

findNode

handle findNode(NumberType nodeId)

Finds a node in the tree.

Parameters:

nodeId - Node id of the node to find.

Returns:

the handle wrapped resource of type TreeViewNode or unknown.

findNode

handle findNode(character nodeKey)

Finds a node in the tree.

Parameters:

nodeKey - Node key of the node to find.

Returns:

the handle wrapped resource of type TreeViewNode or unknown.

getTriggerNode

handle getTriggerNode()

The attribute holds the node that is the target of the current trigger. The value is valid only during the following triggers: Trigger Attribute value -------------------------------- VALUE-CHANGED The previously selected node, or unknown if no node was selected. NODE-EXPANDING The node being expanded. NODE-EXPANDED The expanded node. NODE-COLLAPSING The node being collapsed. NODE-COLLAPSED The collapsed node. NODE-CLICK The node click event BEFORE-LABEL-EDIT The before node edit event AFTER-LABEL-EDIT The after node edit event

Returns:

see above

getNewNodeLabel

character getNewNodeLabel()

Returns the new label for the trigger node.

Returns:

The new label for the trigger node

setNewNodeLabel

void setNewNodeLabel(character newLabel)

Sets the new label for the trigger node.

Parameters:

newLabel - The new label for the trigger node

getTopVisibleNodeId

integer getTopVisibleNodeId()

Returns node id of the top visible node.

Returns:

see above.

getScrollWheelLines

integer getScrollWheelLines()

Getter for the SCROLL-WHEEL-LINES attribute.

Returns:

the attribute value.

setScrollWheelLines

void setScrollWheelLines(NumberType value)

Setter for the SCROLL-WHEEL-LINES attribute. Sets the number of lines to scroll for one scroll wheel step.

Parameters:

value - the attribute value

expandAll

void expandAll()

Expands all the nodes.

collapseAll

void collapseAll()

Collapses all the nodes.

collapseAllExcept

void collapseAllExcept(handle node)

Collapses all the nodes, except the one specified.

Parameters:

node - The node to exclude from collapsing, if unknown all nodes will be collapsed.

getNodeHasChildren

logical getNodeHasChildren(NumberType nodeId)

Returns true if the node represented by the supplied node id is allowed to have child nodes.

Parameters:

nodeId - The node to query.

Returns:

see above.

setNodeHasChildren

void setNodeHasChildren(NumberType nodeId,
                        logical value)

Set the child node allowance on the node represented by the supplied node.

Parameters:

nodeId - The node to modify.

value - true to set the node to allow to have child nodes, false otherwise.

getRemoveNodeOnCollapse

logical getRemoveNodeOnCollapse()

Getter for the REMOVE-NODE-ON-COLLAPSE attribute.

Returns:

the attribute value

setRemoveNodeOnCollapse

void setRemoveNodeOnCollapse(logical value)

Setter for the REMOVE-NODE-ON-COLLAPSE attribute. When set to true collapsing a node will cause all the node's children to be deleted.

Parameters:

value - the attribute value

getNodeBold

boolean getNodeBold(character nodeKey)

Getter for the NODE-BOLD attribute.

Parameters:

nodeKey - the node key

Returns:

the attribute value

setNodeBold

void setNodeBold(character nodeKey,
                 logical value)

Setter for the NODE-BOLD attribute.

Parameters:

nodeKey - the node key

value - the attribute value

getNodeText

character getNodeText(character nodeKey)

Implements legacy method GET-NODE-TEXT. Returns text of the specified node.

Parameters:

nodeKey - Key of the node for which the text should be returned.

Returns:

node text or unknown char when the node is not found.

setNodeText

void setNodeText(character nodeKey,
                 character text)

Implements legacy method SET-NODE-TEXT. Assigns text to a specified node.

Parameters:

nodeKey - Key of the node for which the text should be set.

text - The text to set.

isDragDropOtherTree

logical isDragDropOtherTree()

Getter for the ALLOW-DRAG-DROP-OTHER-TREE attribute.

Returns:

the attribute value.

setDragDropOtherTree

void setDragDropOtherTree(logical value)

Setter for the ALLOW-DRAG-DROP-OTHER-TREE attribute.

Parameters:

value - the attribute value

createMergedImage

integer createMergedImage(integer imgIndex,
                          character imgFile)

Implements legacy method CREATE-MERGED-IMAGE.

Parameters:

imgIndex - Index of the target image.

imgFile - Image file of the source image.

Returns:

image index of the resulting merged image.

nodeKeyToId

integer nodeKeyToId(character nodeKey)

Implement legacy method NODE-KEY-TO-ID. Returns numeric node id for a node represented by a node key. Or unknown when no such node exists.

Parameters:

nodeKey - A node key.

Returns:

node id or unknown.

getImageList

handle getImageList()

Returns the assigned imagelist or unknown.

Returns:

see above.

setImageList

void setImageList(handle imgList)

Assigns an imagelist resource to the tree. When an imagelist is assigned, all images set to the tree are taken from the imagelist.

Parameters:

imgList - The image list to assign.

setImageList

void setImageList(ImageList imgList)

Assigns an imagelist resource to the tree. When an imagelist is assigned, all images set to the tree are taken from the imagelist.

Parameters:

imgList - The image list to assign.

hitTestFwd

handle hitTestFwd(NumberType x,
                  NumberType y)

Get the TreeView node under mouse cursor as a node handle. If no node under cursor return unknown value.

Parameters:

x - Mouse cursor x position.

y - Mouse cursor y position.

Returns:

TreeView node under cursor as a handle.

hitTest

comhandle hitTest(NumberType x,
                  NumberType y)

Get the TreeView node under mouse cursor as a node handle. If no node under cursor return unknown value.

Parameters:

x - Mouse cursor x position.

y - Mouse cursor y position.

Returns:

TreeView node under cursor as a handle.

getRowHeight

integer getRowHeight()

Returns row height for tree based widget. The units are pixels.

Returns:

the tree widget row height in pixels.

setRowHeight

void setRowHeight(NumberType heightValue)

Sets row height for tree based widget. The units are pixels.

Parameters:

heightValue - the new row height vale in pixels.

deleteChildNodes

void deleteChildNodes(NumberType nodeId)

Recursively delete all node children.

Parameters:

nodeId - the node ID

getPrivateData

java.lang.String getPrivateData(character nodeKey)

Getter for the PRIVATE-DATA attribute.

Parameters:

nodeKey - the node key value

Returns:

node private data string

setPrivateData

void setPrivateData(character nodeKey,
                    character value)

Setter for the PRIVATE-DATA attribute.

Parameters:

nodeKey - the node key value

value - new attribute value

getMousePointerNum

integer getMousePointerNum()

Gets the type of mouse pointer displayed when over part of an object.

Returns:

mouse pointer

setMousePointerNum

void setMousePointerNum(integer value)

Sets the type of mouse pointer displayed when over part of an object.

Parameters:

value - the new mouse pointer value

getLineStyle

integer getLineStyle()

Gets the LINE-STYLE attribute value.

Returns:

current line style value

setLineStyle

void setLineStyle(integer value)

Sets the LINE-STYLE attribute value.

Parameters:

value - the new line style value

getStyle

integer getStyle()

Gets the STYLE attribute value.

Returns:

current line style value

setStyle

void setStyle(integer value)

Sets the STYLE attribute value.

Parameters:

value - the new line style value

isCheckBoxes

logical isCheckBoxes()

Returns true if a check box is displayed next to each tree node in the tree view; otherwise, false. The default is false.

Returns:

See above.

setCheckBoxes

void setCheckBoxes(logical value)

Set to true to display a check box next to each tree node in the tree view; otherwise, false. The default is false.