TreeWidgetBase (P2J - Progress 4GL to Java Conversion and Runtime)

java.lang.Object
- com.goldencode.p2j.util.HandleResource
- - com.goldencode.p2j.util.HandleChain
  - - com.goldencode.p2j.ui.GenericWidget<T>
    - - com.goldencode.p2j.ui.BaseEntity<T>
      - com.goldencode.p2j.ui.ControlEntity<T>
        
        com.goldencode.p2j.ui.ControlEntityExt<TreeConfig>
        
        com.goldencode.p2j.ui.TreeWidgetBase

All Implemented Interfaces:

AutoResizableWidget, Checkable, ComData, CommonWidget, ConfigOwner<TreeConfig>, CustomFont, DisableRedraw, Droppable, ImageSupport, ImageWidgetSupport, IndexedInterface, Nodes, OcxDragDrop, OcxMouse, RemoveNode, TreeFace, WidgetExtension, WidgetTree, CommonField, CommonHandle, CommonHandleChain, Coordinates, DatabaseInfo, Deletable, DynamicResource, Enabled, HasVisible, InstantiatingProcedure, Nameable, Sensitive, Sizeable, WrappedResource, Printable

Direct Known Subclasses:

TreeListWidget, TreeViewWidget
```
public abstract class TreeWidgetBase
extends ControlEntityExt<TreeConfig>
implements TreeFace
```
Server side Tree widget base implementation.

Nested Class Summary
- Nested classes/interfaces inherited from class com.goldencode.p2j.ui.BaseEntity
  BaseEntity.CharsPixels

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`buildingTree` The backed field for BUILDING-TREE attribute.
`protected static java.util.logging.Logger`	`LOG` Logger
`private int`	`nextId` Last used node id.
`private handle`	`nodeImageListHandle` Assigned imagelist for node images.
`private java.util.HashMap<java.lang.Integer,TreeNodeResource>`	`nodesById` Map of nodes by ids.
`private java.util.LinkedList<TreeNodeResource>`	`nodesByIndices` The list of all tree nodes.
`private java.util.HashMap<java.lang.String,TreeNodeResource>`	`nodesByKey` Map of nodes by keys.
`private java.util.List<java.lang.String>`	`pendingAttrs` Widget attributes pending to be sent to the client
`private java.util.List<java.lang.Object>`	`pendingAttrValues` Widget attribute values pending to be sent to the client
`private boolean`	`pendingPushNodes` Flag marking pushNodes call pending
`private TreeNodeResource`	`rootNode` The root node.

Fields inherited from class com.goldencode.p2j.ui.ControlEntityExt
comData

Fields inherited from class com.goldencode.p2j.ui.ControlEntity
ALIGN_COLON, ALIGN_LEFT, ALIGN_RIGHT

Fields inherited from class com.goldencode.p2j.ui.BaseEntity
group

Fields inherited from class com.goldencode.p2j.ui.GenericWidget
config, deleted, frame, internalScreenValueUsage, realizeOnAttributeAccess

Fields inherited from class com.goldencode.p2j.util.HandleChain
name, nextSibling, prevSibling

Fields inherited from class com.goldencode.p2j.util.HandleResource
instProc

Constructor Summary

Constructors
Constructor and Description

TreeWidgetBase(boolean dynamic, TreeConfig ctrl)
Default constructor.

Constructors
Constructor and Description
`TreeWidgetBase(boolean dynamic, TreeConfig ctrl)` Default constructor.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected TreeNodeResource`	`_getSelectedNode()` Get selected node by node ID helper method.
`private int`	`_getSelecteNodeId()` Get selected node ID helper method.
`private int`	`_getTopVisibleNodeId()` Returns the ID of the top visible node or -1 if this tree is empty.
`(package private) void`	`_setSelectedNode(int nodeId)` Convenient method for setting the selected node just by its id.
`(package private) void`	`_setSelectedNode(int nodeId, boolean trigger)` Convenient method for setting the selected node just by its id.
`protected void`	`addNode(TreeNodeResource node, boolean pushNodes)` Adds new node to the tree internal structures.
`void`	`afterConfigUpdate(TreeConfig beforeUpdate)` The method is called after the configuration associated with the implementor changes.
`protected abstract boolean`	`allowDuplicateKeys()` Test if this tree allows duplicate node key values.
`protected static boolean`	`assertKnown(BaseDataType... values)` Returns `false` if any of the supplied values is `null` or `unknown`, `true` otherwise.
`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 `TreeFace.createSubNode(NumberType, character, character, logical, NumberType, NumberType, integer)`.
`integer`	`createMergedImage(integer imgIndex, character imgFile)` Implements legacy method CREATE-MERGED-IMAGE.
`protected abstract TreeNodeResource`	`createNode(java.lang.String key, java.lang.String text, TreeNodeResource parent)` Creates new node.
`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.
`void`	`delete()` Perform actual delete of an resource.
`void`	`deleteChildNodes(NumberType nodeId)` Recursively delete all node children.
`protected void`	`doWithNode(character nodeKey, BaseDataType[] mandatoryArgs, java.util.function.Consumer<TreeNodeResource> body)` Validates the supplied array of mandatory arguments and node key, finds the node nodeKey and executes the supplied consumer with the found node.
`protected <T extends BaseDataType> T`	`doWithNode(character nodeKey, BaseDataType[] mandatoryArgs, T failResult, java.util.function.Function<TreeNodeResource,T> body)` Validates the supplied array of mandatory arguments and node key, finds the node nodeKey and executes the supplied function with the found node.
`protected void`	`doWithNode(NumberType nodeId, BaseDataType[] mandatoryArgs, java.util.function.Consumer<TreeNodeResource> body)` Validates the supplied array of mandatory arguments and node id, finds the node nodeId and executes the supplied consumer with the found node.
`protected <T extends BaseDataType> T`	`doWithNode(NumberType nodeId, BaseDataType[] mandatoryArgs, T failResult, java.util.function.Function<TreeNodeResource,T> body)` Validates the supplied array of mandatory arguments and node id, finds the node nodeId and executes the supplied function with the found node.
`protected static <T extends BaseDataType> T`	`doWithNodeImpl(BaseDataType nodeId, BaseDataType[] mandatoryArgs, T failResult, java.util.function.Function<TreeNodeResource,T> body, java.util.function.Function<BaseDataType,TreeNodeResource> findNode)` Validates the supplied array of mandatory arguments and node id, finds the node nodeId and executes the supplied function with the found node.
`protected void`	`ensureNodeVisible(character nodeKey, boolean trigger)` Assure the supplied node is visible in the tree viewport
`protected void`	`ensureNodeVisible(TreeNodeResource node, boolean select, boolean trigger)` Assure the supplied node is visible in the tree viewport, and optionally select the node.
`void`	`expandAll()` Expands all the nodes.
`void`	`expandNode(NumberType nodeId)` Expands a node.
`handle`	`findNode(character nodeKey)` Finds a node in the tree.
`(package private) TreeNodeResource`	`findNode(int nodeId)` Finds a node based on a node id.
`handle`	`findNode(NumberType nodeId)` Finds a node in the tree.
`(package private) TreeNodeResource`	`findNode(java.lang.String key)` Finds a node based on a node key.
`handle`	`getDraggedNode()` Getter for DRAGGED-NODE attribute.
`handle`	`getDraggedOverNode()` Getter for DRAGGED-OVER-NODE attribute.
`handle`	`getDropHighlight()` Returns a reference to a node object that is highlighted with the system highlight color when the cursor moves over it.
`int`	`getDropHighlightNodeId()` Returns the drophighlight node id.
`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.
`handle`	`getImageList()` Returns the assigned imagelist or unknown.
`integer`	`getIndentation()` Getter for the INDENTATION attribute.
`integer`	`getLineStyle()` Gets the LINE-STYLE attribute value.
`character`	`getNewNodeLabel()` Returns the new label for the trigger node.
`integer`	`getNextNode(NumberType nodeId)` Returns the next visible node from the specified node.
`protected int`	`getNextNodeId()` Allocates and returns next node id.
`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.
`boolean`	`getNodeBold(character nodeKey)` Getter for the NODE-BOLD attribute.
`private TreeNodeResource`	`getNodeByCoordinates(int x, int y)` Gets a node by the given pixel coordinates relative to the owner window.
`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.
`private static int`	`getNodeIdFrom(handle value)` Retrieves the node id from the provided tree node handle.
`integer`	`getNodeLevel(character nodeKey)` Returns tree level of the specified node.
`handle`	`getNodes()` Returns the collection of all the root nodes, a wrapped resource of the type `TreeNodeCollection`.
`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.
`protected TreeNodeResource`	`getRootNode()` Get the tree root node.
`integer`	`getRowHeight()` Returns row height for tree based widget.
`character`	`getScreenValue()` Obtain the current value in the screen buffer of the backing data for this widget and return it as a `character` type.
`(package private) character`	`getScreenValue(boolean initialized, BaseDataType bdt, java.lang.String fmt, boolean ignoreFormat)` Internal worker for getting the SCREEN-VALUE on a per-widget basis.
`integer`	`getScrollNodeCount()` Getter for SCROLL-NODE-COUNT attribute.
`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.
`(package private) TreeNodeResource`	`getTreeNodeByIndex(int index)` Gets a node based on its index within all nodes list.
`(package private) int`	`getTreeNodeIndex(TreeNodeResource node)` Finds an index of the target 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 COM object.
`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.
`protected void`	`pushNodes()` Pushes the tree node model to the client.
`void`	`pushWidgetAttr(java.lang.String[] fnames, java.lang.Object[] values)` Push the specified widget attribute changes to the client-side.
`void`	`pushWidgetAttr(java.lang.String fname, java.lang.Object value)` Push the specified widget attribute change to the client-side.
`void`	`removeNode(NumberType nodeId)` Removes an existing node from the tree.
`(package private) void`	`removeNode(TreeNodeResource node, boolean pushNodes)` Removes the node from the tree internal structures.
`protected void`	`requestNodeExpand(int nodeId, boolean expand)` This method is called by a client to notify server that a node expansion status was changed.
`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).
`private void`	`setAllNodesExpanded(boolean expanded, TreeNodeResource exceptNode)` Expands or collapses all nodes.
`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`	`setMultiSelect(logical extended, logical value)` SET-MULTI-SELECT method.
`void`	`setNewNodeLabel(character newLabel)` Sets the new label for the trigger node.
`void`	`setNodeBold(character nodeKey, logical value)` Setter for the NODE-BOLD attribute.
`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 nodeKey)` Setter for the SELECTED-NODE 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.
`(package private) void`	`updateNode(TreeNodeResource node, java.lang.String oldKeyValue, boolean pushNodes)` Updates the tree internal structures for the given node.

Methods inherited from class com.goldencode.p2j.ui.ControlEntityExt
getAllowedEffects, getComData, getDataFormat, getEffect, getMouseButton, getMouseIcon, getMousePointerNum, getMouseShift, getMouseX, getMouseY, getOleDragMode, getOleDropMode, getOleX, getOleY, getState, isDefaultCursors, isEnabled, oleDrag, refreshUI, setAllowedEffects, setAllowedEffects, setComData, setDataFormat, setDataFormat, setDefaultCursors, setDefaultCursors, setEffect, setEffect, setEnabled, setEnabled, setMouseIcon, setMouseIcon, setMousePointerNum, setMousePointerNum, setOleDragMode, setOleDragMode, setOleDropMode, setOleDropMode, setOleX, setOleX, setOleY, setOleY, setState, setState

Methods inherited from class com.goldencode.p2j.ui.BaseEntity
_getHeightChars, _getHeightPixels, _getWidthChars, _getWidthPixels, canSetPixelPositionInChui, emit4084Warning, emitUnableToAssignUnknownAttributeWarning, getBgColor, getBgColorRgb, getColumn, getDColor, getFgColor, getFgColorRgb, getFont, getFontInfo, getFontName, getFontSize, getFrameColumn, getFrameRow, getFrameX, getFrameY, getHeightChars, getHeightPixels, getNextSibling, getParent, getParent, getPfColor, getRow, getTooltip, getValidParentTypes, getWidthChars, getWidthPixels, getX, getY, isFontBold, isFontItalic, isFontUnderline, isMovable, isResizable, isSelected, isTabStop, prepareSizeChars, prepareSizePixels, pushLocAttrs, pushSizeAttrs, setAlign, setBgColor, setBgColor, setBgColor, setBgColorRgb, setBgColorRgb, setColon, setColon, setColumn, setColumn, setColumnOrRow, setColumnOrRowWorker, setDColor, setDColor, setDColor, setFgColor, setFgColor, setFgColor, setFgColorRgb, setFgColorRgb, setFont, setFontBold, setFontItalic, setFontName, setFontSize, setFontUnderline, setGroup, setHeightChars, setHeightChars, setHeightImpl, setHeightPixels, setHeightPixels, setMaxHeightCharsWorker, setMaxHeightPixelsWorker, setMaxWidthCharsWorker, setMaxWidthPixelsWorker, setMinHeightCharsWorker, setMinHeightPixelsWorker, setMinWidthCharsWorker, setMinWidthPixelsWorker, setMovable, setMovable, setParent, setPfColor, setPfColor, setPfColor, setResizable, setResizable, setRow, setRow, setSelected, setSelected, setSizeChars, setSizePixels, setSystemParent, setTabStop, setTabStop, setTooltip, setTooltip, setVirtHeightCharsWorker, setVirtHeightPixelsWorker, setVirtWidthCharsWorker, setVirtWidthPixelsWorker, setWidthChars, setWidthChars, setWidthImpl, setWidthPixels, setWidthPixels, setX, setX, setXorY, setXOrYWorker, setY, setY, useHandleChainSiblings, validateParent, validateSize, validColumnOrRow

Methods inherited from class com.goldencode.p2j.ui.GenericWidget
_dynamic, _getDbName, _getFormat, _getTable, _isEntered, _isHidden, _isNotEntered, _isRealized, _isVisible, _setDynamic, _setVisible, apply, apply, apply, apply, asWidgetHandle, canAccess, canDelete, canPushWidgetAttr, cleanup, colorDisplay, colorPrompt, config, deselectRows, detachMenu, disable, dynamic, editUndo, enable, finishConfigProcessing, finishSetup, flushWidgetAttrs, genAssignUnknownWarning, getAttr, getAttr, getAttr, getAttr, getAttr, getAttr, getAttr, getAttr, getAttr, getAttr, getAttr, getAttr, getColumnFont, getColumnLabel, getContextHelpId, getConvert3D, getCursorOffset, getDbName, getFormat, getFrame, getFrameHandle, getFrameName, getHeight, getHelp, getHWND, getId, getImage, getLabel, getLabelFont, getLabelStr, getLogicalTerminal, getMaxHeightChars, getMaxWidthChars, getMenuKey, getMenuMouse, getMousePointer, getMousePosition, getNumColumns, getNumSelectedRows, getParentHandle, getPopupMenu, getQuery, getRetainShape, getSideLabelHandle, getStretchToFit, getTable, getTabPosition, getTitleFont, getTransparent, getValidationExpression, getValidationMessage, getVirtHeight, getVirtHeightPixels, getVirtWidth, getVirtWidthPixels, getWidgetId, getWidth, getWindow, getZOrderClass, hasFormat, hasNameReadOnly, hasParent, hide, hide, implicitDeletion, inputValue, isAutoCompletion, isAutoReturn, isChained, isChecked, isDisableRedraw, isEntered, isExpandLabel, isFocusedRowSelected, isHidden, isKeepFrameZOrder, isManualHighlight, isMultiple, isNotEntered, isScrollable, isSelectable, isSelected, isSelected, isSensitive, isTabWidget, isTextSelected, isThreeD, isValidatable, isVisible, labelSizeCheck, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadMousePointer, loadMousePointer, moveAfterTab, moveAfterTab, moveBeforeTabItem, moveBeforeTabItem, moveToBottom, moveToTop, moveToWorker, name, notQueryable, notQueryable, notSettable, notSettable, notWorker, openPopup, preRealizeCheck, pushScreenDefinition, readOnlyError, readOnlyError, realize, refresh, resourceDelete, restoreSharedState, saveSharedState, selectAll, selectFocusedRow, setAtFormatLength, setAttr, setAttr, setAttr, setAttr, setAttr, setAttr, setAttr, setAttr, setAttr, setAttrs, setAutoCompletion, setAutoCompletion, setAutoReturn, setAutoReturn, setBlank, setChecked, setChecked, setColumnFont, setColumnFont, setContextHelpId, setContextHelpId, setConvert3D, setConvert3D, setCursorOffset, setCursorOffset, setDbname, setDeblank, setDisableAutoZap, setDisableRedraw, setFont, setFormat, setFormat, setFrame, setFrame, setFrame, setFrameHandle, setFrameHandle, setFrameHandle, setHeader, setHeight, setHelp, setHelp, setHelpDefault, setHelpStatic, setHidden, setHidden, setId, setKeepFrameZOrder, setKeepFrameZOrder, setLabel, setLabel, setLabel, setLabelFont, setLabelFont, setLabelInt, setManualHighlight, setManualHighlight, setMaxHeightChars, setMaxWidthChars, setMenuKey, setMenuKey, setMenuMouse, setMenuMouse, setMultiple, setMultiple, setNextTabItem, setNoAutoValidate, setNumSelectedRows, setParentHandle, setParentHandle, setPopupMenu, setPopupMenu, setQuery, setReadOnly, setReadOnly, setRetainShape, setRetainShape, setScreenLock, setScreenValue, setScreenValue, setScreenValue, setScreenValueInt, setScreenValueNoErrorHandling, setScrollable, setScrollable, setSelectable, setSelectable, setSensitive, setSensitive, setSensitive, setSensitive, setSideLabelHandle, setStretchToFit, setStretchToFit, setTable, setThreeD, setThreeD, setTitleFont, setTitleFont, setTransparent, setTransparent, setValidation, setValidation, setVertical, setVirtHeight, setVirtHeightPixels, setVirtWidth, setVirtWidthPixels, setVisible, setVisible, setWidgetId, setWidgetId, setWidth, truncatePixelSize, underline, underline, valid, validate, validateFields, validateFields, validateFields, validateLabelAssignment, view, warningAlreadyRealized, widgetName

Methods inherited from class com.goldencode.p2j.util.HandleChain
firstResource, firstResource, getHead, getNextSibling, getPrevSibling, getPrivateData, getTail, hasName, hasNameConstraints, hasNextSibling, hasPrevSibling, hasPrivateData, interlink, lastResource, lastResource, moveInChain, name, name, setHead, setNextSibling, setNextSibling, setPrevSibling, setPrevSibling, setPrivateData, setPrivateData, setPrivateData, validateName

Methods inherited from class com.goldencode.p2j.util.HandleResource
doDelete, getResourceType, id, id, incrementTrigger, instantiatingProcedure, invalidAttribute, processResource, registerResource, setInstantiatingProcedure, toString, type, unableToAssignUnknown, unknown

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.goldencode.p2j.ui.TreeFace
createSubNode, ensureNodeVisible, getHWND, getMousePointerNum, getNodeBgColor, setMousePointerNum, setNodeBgColor, setNodeFgColor

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

Methods inherited from interface com.goldencode.p2j.ui.Droppable
endFileDrop, getDroppedFile, getDroppedFile, getNumDroppedFiles, setDropTarget

Methods inherited from interface com.goldencode.p2j.ui.CommonWidget
getIdEx, getListItems, isEditCanUndo, setListItems, setListItems, setScreenValue

Methods inherited from interface com.goldencode.p2j.util.CommonHandleChain
getPrivateData, setPrivateData, setPrivateData

Methods inherited from interface com.goldencode.p2j.util.CommonHandle
getResourceType

Methods inherited from interface com.goldencode.p2j.util.WrappedResource
id, id, unknown

Methods inherited from interface com.goldencode.p2j.util.Nameable
name, name

Methods inherited from interface com.goldencode.p2j.ui.DisableRedraw
setDisableRedraw

Methods inherited from interface com.goldencode.util.Printable
asString, print

- Field Detail
  - LOG
```
protected static final java.util.logging.Logger LOG
```
    Logger
  - buildingTree
```
protected int buildingTree
```
    The backed field for BUILDING-TREE attribute.
  - nextId
```
private int nextId
```
    Last used node id.
  - nodeImageListHandle
```
private handle nodeImageListHandle
```
    Assigned imagelist for node images.
  - nodesById
```
private java.util.HashMap<java.lang.Integer,TreeNodeResource> nodesById
```
    Map of nodes by ids.
  - nodesByIndices
```
private java.util.LinkedList<TreeNodeResource> nodesByIndices
```
    The list of all tree nodes.
  - nodesByKey
```
private java.util.HashMap<java.lang.String,TreeNodeResource> nodesByKey
```
    Map of nodes by keys.
  - pendingAttrs
```
private java.util.List<java.lang.String> pendingAttrs
```
    Widget attributes pending to be sent to the client
  - pendingAttrValues
```
private java.util.List<java.lang.Object> pendingAttrValues
```
    Widget attribute values pending to be sent to the client
  - pendingPushNodes
```
private boolean pendingPushNodes
```
    Flag marking pushNodes call pending
  - rootNode
```
private TreeNodeResource rootNode
```
    The root node.
- Constructor Detail
  - TreeWidgetBase
```
public TreeWidgetBase(boolean dynamic,
                      TreeConfig ctrl)
```
    Default constructor.
    
    Parameters:
    
    dynamic - Flag indicating if this is a static or dynamic resource.
    
    ctrl - Configuration container.
- Method Detail
  - assertKnown
```
protected static boolean assertKnown(BaseDataType... values)
```
    Returns false if any of the supplied values is null or unknown, true otherwise.
    
    Parameters:
    
    values - Values to check.
    
    Returns:
    
    see above.
  - doWithNodeImpl
```
protected static <T extends BaseDataType> T doWithNodeImpl(BaseDataType nodeId,
                                                           BaseDataType[] mandatoryArgs,
                                                           T failResult,
                                                           java.util.function.Function<TreeNodeResource,T> body,
                                                           java.util.function.Function<BaseDataType,TreeNodeResource> findNode)
```
    Validates the supplied array of mandatory arguments and node id, finds the node nodeId and executes the supplied function with the found node. If any of the supplied arguments is null or unknown or if the supplied node id is null or unknown or if the node is not found, the function will not be invoked and the method returns failResult.
    
    Type Parameters:
    
    T - The value to be supplied to the supplied function.
    
    Parameters:
    
    nodeId - Node id.
    
    mandatoryArgs - Array of mandatory arguments, may be null.
    
    failResult - Value to return when the method fails.
    
    body - The function to execute.
    
    findNode - Provides the node based on the supplied node id or node key.
    
    Returns:
    
    see above
  - getNodeIdFrom
```
private static int getNodeIdFrom(handle value)
```
    Retrieves the node id from the provided tree node handle.
    
    Parameters:
    
    value - The tree node handle
    
    Returns:
    
    The node id if the provided value represents a valid node, otherwise Integer.MIN_VALUE.
  - afterConfigUpdate
```
public void afterConfigUpdate(TreeConfig beforeUpdate)
```
    The method is called after the configuration associated with the implementor changes. The parameter points to a reference representing the original configuration state. This reference can be used to detect what configuration fields changed and so optimize any processing related to the configuration change.
    
    Specified by:
    
    afterConfigUpdate in interface ConfigOwner<TreeConfig>
    
    Overrides:
    
    afterConfigUpdate in class GenericWidget<TreeConfig>
    
    Parameters:
    
    beforeUpdate - Config reference capturing the config state before the owner's config was modified.
  - clearAll
```
public void clearAll()
```
    Unconditionally removes all the nodes from the tree.
    
    Specified by:
    
    clearAll in interface TreeFace
  - clearNodesImageList
```
public void clearNodesImageList()
```
    Clears all images used as node images.
    
    Specified by:
    
    clearNodesImageList in interface TreeFace
  - collapseAll
```
public void collapseAll()
```
    Collapses all the nodes.
    
    Specified by:
    
    collapseAll in interface TreeFace
  - collapseAllExcept
```
public void collapseAllExcept(handle node)
```
    Collapses all the nodes, except the one specified.
    
    Specified by:
    
    collapseAllExcept in interface TreeFace
    
    Parameters:
    
    node - The node to exclude from collapsing, if unknown all nodes will be collapsed.
  - collapseNode
```
public void collapseNode(NumberType nodeId)
```
    Collapses a node.
    
    Specified by:
    
    collapseNode in interface TreeFace
    
    Parameters:
    
    nodeId - Id of the node to be collapsed.
  - createImage
```
public integer createImage(character path)
```
    Creates an image that can be later used in setTreeNodeIcons(NumberType, NumberType, NumberType) and TreeFace.createSubNode(NumberType, character, character, logical, NumberType, NumberType, integer). The returned integer value is the index into the local node image list. The start index depends on the concrete tree subtype:
  - for TREEVIES the index starts from the number of built-in stock images
  - for TREELIST the index is 0-based

Specified by:: createImage in interface TreeFace
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

createMergedImage
```
public integer createMergedImage(integer imgIndex,
                                 character imgFile)
```
Implements legacy method CREATE-MERGED-IMAGE.

Specified by:

createMergedImage in interface TreeFace

Parameters:

imgIndex - Index of the target image.

imgFile - Image file of the source image.

Returns:

image index of the resulting merged image.

createSubNode

public 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. Note: the exact meaning of node image indices depends on the concrete tree subclass:

For TREELISTSs these indices are the values returned by createImage(character).

For TREEVIEWs also a few fixed built-in index values can be used:

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

protected abstract TreeNodeResource createNode(java.lang.String key, java.lang.String text, TreeNodeResource parent)

protected <T extends BaseDataType> T doWithNode(character nodeKey, BaseDataType[] mandatoryArgs, T failResult, java.util.function.Function<TreeNodeResource,T> body)

protected <T extends BaseDataType> T doWithNode(NumberType nodeId, BaseDataType[] mandatoryArgs, T failResult, java.util.function.Function<TreeNodeResource,T> body)

Class TreeWidgetBase

Nested Class Summary

Nested classes/interfaces inherited from class com.goldencode.p2j.ui.BaseEntity

Field Summary

Fields inherited from class com.goldencode.p2j.ui.ControlEntityExt

Fields inherited from class com.goldencode.p2j.ui.ControlEntity

Fields inherited from class com.goldencode.p2j.ui.BaseEntity

Fields inherited from class com.goldencode.p2j.ui.GenericWidget

Fields inherited from class com.goldencode.p2j.util.HandleChain

Fields inherited from class com.goldencode.p2j.util.HandleResource

Constructor Summary

Method Summary

Methods inherited from class com.goldencode.p2j.ui.ControlEntityExt

Methods inherited from class com.goldencode.p2j.ui.ControlEntity

Methods inherited from class com.goldencode.p2j.ui.BaseEntity

Methods inherited from class com.goldencode.p2j.ui.GenericWidget

Methods inherited from class com.goldencode.p2j.util.HandleChain

Methods inherited from class com.goldencode.p2j.util.HandleResource

Methods inherited from class java.lang.Object

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

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

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

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

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

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

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

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

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

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

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

Methods inherited from interface com.goldencode.util.Printable

Field Detail

LOG

buildingTree

nextId

nodeImageListHandle

nodesById

nodesByIndices

nodesByKey

pendingAttrs

pendingAttrValues

pendingPushNodes

rootNode

Constructor Detail

TreeWidgetBase

Method Detail

assertKnown

doWithNodeImpl

getNodeIdFrom

afterConfigUpdate

clearAll

clearNodesImageList

collapseAll

collapseAllExcept

collapseNode

createImage

createMergedImage

createSubNode

delete

deleteChildNodes

expandAll

expandNode

findNode

findNode

getDraggedNode

getDraggedOverNode

getDropHighlight

getDropHighlightNodeId

getFirstChildNode

getFirstNode

getFirstVisibleNode

getFocusedAndSelectedNode

getFocusedAndSelectedNodeKey

getFocusedNode

getFocusedNodeKey

getImageList

getIndentation

getLineStyle

getNewNodeLabel

getNextNode