TreeListWidget (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
        
        com.goldencode.p2j.ui.TreeListWidget

All Implemented Interfaces:

AutoResizableWidget, Checkable, ComData, CommonWidget, ConfigOwner<TreeConfig>, CustomFont, DisableRedraw, Droppable, ImageSupport, ImageWidgetSupport, IndexedInterface, Nodes, OcxDragDrop, OcxMouse, RemoveNode, TreeFace, TreeList, WidgetExtension, WidgetTree, WriteProtectable, CommonField, CommonHandle, CommonHandleChain, Coordinates, DatabaseInfo, Deletable, DynamicResource, Enabled, HasVisible, InstantiatingProcedure, Nameable, Sensitive, Sizeable, WrappedResource, Printable
```
public class TreeListWidget
extends TreeWidgetBase
implements TreeList
```
Server side TreeList widget 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 java.util.List<TreeListConfig.Column>`	`columns` List of columns.
`private java.time.format.DateTimeFormatter`	`dateTimeParser` Parser to parse strings passed from application for columns of DATETIME data type to use for sorting dates.
`protected boolean`	`pendingPushColumns` Flag marking columns or column position changes are pending
`private java.util.List<java.lang.Integer>`	`selectedNodesIds` List of ids for the selected nodes.
`private static integer`	`WHITE` Convenience constant for white color value

Fields inherited from class com.goldencode.p2j.ui.TreeWidgetBase
buildingTree, LOG

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, wa

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

Constructor Summary

Constructors
Constructor and Description
`TreeListWidget()` Default constructor.
`TreeListWidget(boolean dynamic)` Default constructor.
`TreeListWidget(boolean dynamic, TreeListConfig config)` Custom constructor to simplify subclassing.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected TreeNodeResource`	`_getSelectedNode()` Get selected node by node ID helper method.
`private java.util.List<java.lang.Integer>`	`_getSelectedNodesIds()` Get the ids of the selected nodes
`(package private) void`	`_setSelectedNode(int nodeId, boolean trigger)` Convenient method for setting the selected node just by its id.
`protected void`	`addColumn(TreeListConfig.Column column)` Append a newly-created column to the end of column list.
`void`	`afterConfigUpdate(TreeConfig beforeUpdate)` The method is called after the configuration associated with the implementor changes.
`protected boolean`	`allowDuplicateKeys()` Test if this tree allows duplicate node key values.
`void`	`clearAll()` This methods calls super, then clear all columns.
`private void`	`columnUpdate(int index, TreeListConfig.Column column)` Update a column at the given index.
`private static <T extends java.lang.Comparable<T>> java.util.Comparator<TreeNodeResource>`	`convertCompare(int index, java.util.function.Function<java.lang.String,T> parser, boolean descending, T defaultValue)` Create a comparator suitable for comparing cell values in the sorting column with datatypes other than STRING or ICON.
`integer`	`createCellImage(character path)` Creates an image that can be later used in `setCellIcon(NumberType, NumberType, NumberType)`
`integer`	`createColumn(character caption, NumberType dataType, NumberType width, NumberType align, NumberType bgColor, NumberType fgColor)` Create a new column and append to the tree-list columns.
`protected TreeListNodeResource`	`createNode(java.lang.String key, java.lang.String text, TreeNodeResource parent)` Creates new node.
`private static <T extends java.lang.Comparable<T>> java.util.Comparator<TreeNodeResource>`	`directCompare(int index, java.util.function.Function<java.lang.Object,T> parser, boolean descending)` Create a comparator suitable for comparing cell values in the sorting column with datatypes STRING and ICON.
`void`	`ensureNodeVisible(character nodeKey)` Assure the supplied node is visible in the tree viewport
`private TreeListConfig.Column`	`findColumn(int colIndex)` Finds column configuration entry from column index.
`private TreeListConfig.Column`	`findColumn(NumberType colIndex)` Finds column configuration entry from column index.
`protected boolean`	`firesNodeExpandOnLeaf()` Test if this tree triggers a node expand type event when expanding leaf nodes.
`void`	`fixColumnsLeft(NumberType colIndex)` Fixes the columns to the left starting at the provided column index.
`integer`	`getCellBgColor(NumberType nodeId, NumberType colIndex)` Returns background color of the supplied cell.
`integer`	`getCellFgColor(NumberType nodeId, NumberType colIndex)` Returns foreground color of the supplied cell.
`void`	`getCellString(NumberType nodeId, NumberType colIndex, character outValue)` Retrieve cell value as a string.
`private <T> T`	`getCellValue(NumberType nodeId, NumberType colIndex, java.util.function.Function<TreeNodeResource,java.util.List<T>> getValues)` Helper method to set indexed field values, like cell colors and values.
`integer`	`getColumnPosition(NumberType index)` Returns column position, based on the column index.
`integer`	`getColumnWidth(NumberType index)` Returns column width of a specified column.
`character`	`getDateSeparator()` Getter for the DATE-SEPARATOR attribute.
`private java.time.format.DateTimeFormatter`	`getDateTimeParser()` Get datetime parser to use when sorting columns of DATETIME type.
`character`	`getDecimalSeparator()` Getter for the DECIMAL-SEPARATOR attribute.
`handle`	`getFocusedAndSelectedNode()` Getter for the FOCUSED-AND-SELECTED-NODE attribute.
`integer`	`getNodeBgColor(NumberType nodeId)` Returns background color of the supplied node.
`integer`	`getNodeFgColor(NumberType nodeId)` Returns foreground color of the supplied node.
`integer`	`getSelectedNodeId()` Getter for the SELECTED-NODE-ID attribute.
`character`	`getSelectedNodeKey()` Getter for the SELECTED-NODE-KEY attribute.
`character`	`getShortDateFormat()` Getter for the SHORT-DATE-FORMAT attribute.
`integer`	`getSortedColumnCount()` Getter for the SORTED-COLUMN-COUNT attribute.
`integer`	`getSortedColumns()` Getter for the SORTED-COLUMNS attribute.
`character`	`getThousandSeparator()` Getter for the THOUSAND-SEPARATOR attribute.
`integer`	`getTriggerColumn()` Getter for TRIGGER-COLUMN attribute.
`logical`	`isAsteriskActive()` Getter for the ASTERISK-ACTIVE attribute.
`logical`	`isColumnVisible(NumberType index)` IS-COLUMN-VISIBLE method.
`logical`	`isEventsActive()` Getter for the EVENTS-ACTIVE attribute.
`logical`	`isMultiSelect(logical extended)` Getter for the IS-MULTI-SELECT attribute.
`logical`	`isShowHeader()` Getter for the SHOW-HEADER attribute.
`void`	`moveDownInParent()` This should move the currently selected node after its next sibling.
`void`	`moveUpInParent()` This should move the currently selected node before its previous sibling.
`private java.util.Comparator<TreeNodeResource>`	`nodeComparator()` Create a comparator capable to compare nodes based on current sorting column.
`private double`	`parseDecimal(java.lang.String s)` Parse a decimal number, honor the group and decimal separators.
`private int`	`parseInteger(java.lang.String s)` Parse an integer number, honor the group separator.
`(package private) void`	`removeNode(TreeNodeResource node, boolean pushNodes)` Removes the node from the tree internal structures.
`void`	`resort()` Resorts the list according to current settings.
`void`	`setAsteriskActive(logical value)` Setter for the ASTERISK-ACTIVE attribute.
`void`	`setBuildingTree(logical value)` Setter for the BUILDING-TREE attribute.
`void`	`setCellBgColor(NumberType nodeId, NumberType colIndex, NumberType color)` Sets background color for the supplied cell.
`void`	`setCellFgColor(NumberType nodeId, NumberType colIndex, NumberType color)` Sets foreground color for the supplied cell.
`void`	`setCellIcon(NumberType nodeId, NumberType colIndex, NumberType imgId)` SET-CELL-ICON-VALUE method.
`void`	`setCellString(NumberType nodeId, NumberType colIndex, character value)` Sets string value to a specified cell.
`private <T> void`	`setCellValue(int nodeId, int colIndex, java.util.function.Function<TreeNodeResource,java.util.List<T>> getValues, T newValue)` Helper method to set indexed field values, like cell colors and values.
`void`	`setColumnCaption(NumberType index, character caption)` Sets column caption.
`void`	`setColumnVisible(NumberType colIndex, logical visible)` SET-COLUMN-VISIBLE method.
`void`	`setColumnWidth(NumberType colIndex, NumberType width)` Sets column width of a specified column.
`void`	`setDateSeparator(character value)` Setter for the DATE-SEPARATOR attribute.
`void`	`setDecimalSeparator(character value)` Setter for the DECIMAL-SEPARATOR attribute.
`void`	`setEventsActive(logical value)` Setter for the EVENTS-ACTIVE attribute.
`void`	`setMultiSelect(logical extended, logical value)` SET-MULTI-SELECT options.
`void`	`setNodeBgColor(NumberType nodeId, NumberType bgrValue)` Sets background color for the supplied node.
`void`	`setNodeFgColor(NumberType nodeId, NumberType fgrValue)` Sets foreground color for the supplied node.
`void`	`setShortDateFormat(character value)` Setter for the SHORT-DATE-FORMAT attribute.
`void`	`setShowHeader(logical value)` Setter for the SHOW-HEADER attribute.
`void`	`setSortedColumns(NumberType colIndex)` Setter for the SORTED-COLUMNS attribute.
`void`	`setThousandSeparator(character value)` Setter for the THOUSAND-SEPARATOR attribute.
`private void`	`sortNodes(java.util.List<TreeNodeResource> nodes, java.util.Comparator<TreeNodeResource> comparator)` Sort nodes recursively using the provided comparator.
`void`	`sortTreeList(int index, boolean resetSorting)` Sorts a tree list widget by a column.
`private void`	`swapNodes(java.util.function.Function<TreeNodeResource,handle> getOtherNode)` If a node is selected in the tree, try to swap it with the given node.
`private TreeListConfig`	`treeListConfig()` Get widget config casted to the real type.

Methods inherited from class com.goldencode.p2j.ui.TreeWidgetBase
_getFocusedNode, _getFocusedNodeId, _setSelectedNode, addNode, assertKnown, clearNodesImageList, collapseAll, collapseAllExcept, collapseNode, createImage, createMergedImage, createSubNode, delete, deleteChildNodes, doWithNode, doWithNode, doWithNode, doWithNode, doWithNodeImpl, ensureNodeVisible, ensureNodeVisible, expandAll, expandNode, findNode, findNode, findNode, findNode, getDraggedNode, getDraggedOverNode, getDropHighlight, getDropHighlightNodeId, getFirstChildNode, getFirstNode, getFirstVisibleNode, getFocusedAndSelectedNodeKey, getFocusedNode, getFocusedNodeKey, getImageList, getIndentation, getLineStyle, getNewNodeLabel, getNextNode, getNextNodeId, getNextSiblingNode, getNodeAt, getNodeBold, getNodeHasChildren, getNodeHeight, getNodeLevel, getNodes, getNodeText, getNodeVisibleInViewPort, getParentNode, getPrevSiblingNode, getPrivateData, getRemoveNodeOnCollapse, getRootNode, getRowHeight, getScreenValue, getScreenValue, getScrollNodeCount, getScrollWheelLines, getSelectedNode, getSelectedNodeColors, getStyle, getTopVisibleNodeId, getTreeNodeByIndex, getTreeNodeIndex, getTriggerNode, getVisibleNodeCount, getVisibleRowCount, hitTest, hitTestFwd, isBuildingTree, isCheckBoxes, isDblClickExpanding, isDragDrop, isDragDropOtherTree, isExpandOnEnter, isExpandOnSingleClick, isNodeExpanded, isShowButtons, isTextEdit, nodeKeyToId, pushNodes, pushWidgetAttr, pushWidgetAttr, removeNode, requestNodeExpand, scrollNodeToTop, scrollVertical, selectSetFirstVisibleNode, setCheckBoxes, setDblClickExpanding, setDragDrop, setDragDropOtherTree, setDropHighlight, setExpandOnEnter, setExpandOnSingleClick, setImageList, setImageList, setIndentation, setLineStyle, setNewNodeLabel, setNodeBold, setNodeHasChildren, setNodeHeight, setNodeText, setPrivateData, setRemoveNodeOnCollapse, setRowHeight, setScrollWheelLines, setSelectedNode, setSelectedNodeColors, setSelectedNodeKey, setShowButtons, setStyle, setTextEdit, setTreeNodeIcons, startLabelEdit, updateNode

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, _name, _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, isReadOnly, isScrollable, isSelectable, isSelected, isSelected, isSensitive, isTabWidget, isTextSelected, isThreeD, isValidatable, isVisible, labelSizeCheck, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadMousePointer, loadMousePointer, moveAfterTabItem, moveAfterTabItem, 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, setFromOCX, 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, setRetainShape, setRetainShape, setScreenLock, setScreenValue, 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, type, 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, resolveChainType, setHead, setNextSibling, setNextSibling, setPrevSibling, setPrevSibling, setPrivateData, setPrivateData, setPrivateData, validateName

Methods inherited from class com.goldencode.p2j.util.HandleResource
_instantiatingProcedure, addToPool, doDelete, equals, hashCode, id, id, incrementTrigger, instantiatingProcedure, invalidAttribute, processResource, registerResource, resourceType, setInstantiatingProcedure, toString, unableToAssignUnknown, unknown

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

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

Methods inherited from interface com.goldencode.p2j.ui.TreeFace
clearNodesImageList, collapseAll, collapseAllExcept, collapseNode, createImage, createMergedImage, createSubNode, createSubNode, deleteChildNodes, expandAll, expandNode, findNode, findNode, getDraggedNode, getDraggedOverNode, getDropHighlight, getFirstChildNode, getFirstNode, getFirstVisibleNode, getFocusedAndSelectedNodeKey, getFocusedNode, getFocusedNodeKey, getHWND, getImageList, getIndentation, getLineStyle, getMousePointerNum, getNewNodeLabel, getNextNode, getNextSiblingNode, getNodeAt, getNodeBold, getNodeHasChildren, getNodeHeight, getNodeLevel, getNodeText, getNodeVisibleInViewPort, getParentNode, getPrevSiblingNode, getPrivateData, getRemoveNodeOnCollapse, getRowHeight, getScrollNodeCount, getScrollWheelLines, getSelectedNode, getSelectedNodeColors, getStyle, getTopVisibleNodeId, getTriggerNode, getVisibleNodeCount, getVisibleRowCount, hitTest, hitTestFwd, isBuildingTree, isCheckBoxes, isDblClickExpanding, isDragDrop, isDragDropOtherTree, isExpandOnEnter, isExpandOnSingleClick, isNodeExpanded, isShowButtons, isTextEdit, nodeKeyToId, scrollNodeToTop, scrollVertical, selectSetFirstVisibleNode, setCheckBoxes, setDblClickExpanding, setDragDrop, setDragDropOtherTree, setDropHighlight, setExpandOnEnter, setExpandOnSingleClick, setImageList, setImageList, setIndentation, setLineStyle, setMousePointerNum, setNewNodeLabel, setNodeBold, setNodeHasChildren, setNodeHeight, setNodeText, setPrivateData, setRemoveNodeOnCollapse, setRowHeight, setScrollWheelLines, setSelectedNode, setSelectedNodeColors, setSelectedNodeKey, setShowButtons, setStyle, setTextEdit, setTreeNodeIcons, startLabelEdit

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

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
resourceType

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.p2j.ui.WriteProtectable
setReadOnly

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

Methods inherited from interface com.goldencode.p2j.util.Deletable
allowDelete

- Field Detail
  - columns
```
protected final java.util.List<TreeListConfig.Column> columns
```
    List of columns. In BUILDING-TREE mode, the changes in column list are reflected in this field value only, and they are flushed to the client and config.columns when BUILD-TREE mode is switched off.
    WHen BUILDING-TREE mode of off, this list contains same entries as config.columns
  - pendingPushColumns
```
protected boolean pendingPushColumns
```
    Flag marking columns or column position changes are pending
  - selectedNodesIds
```
private java.util.List<java.lang.Integer> selectedNodesIds
```
    List of ids for the selected nodes.
  - WHITE
```
private static final integer WHITE
```
    Convenience constant for white color value
  - dateTimeParser
```
private java.time.format.DateTimeFormatter dateTimeParser
```
    Parser to parse strings passed from application for columns of DATETIME data type to use for sorting dates. The string value is passed in TreeListConfig.shortDateFormat. If no value was parsed from the application before this field is user, the default 4gl date format "99/99/99" is used, with the component order used in date.getDateComponentOrder().
- Constructor Detail
  - TreeListWidget
```
public TreeListWidget()
```
    Default constructor.
  - TreeListWidget
```
public TreeListWidget(boolean dynamic)
```
    Default constructor.
    
    Parameters:
    
    dynamic - Flag indicating if this is a static or dynamic resource.
  - TreeListWidget
```
public TreeListWidget(boolean dynamic,
                      TreeListConfig config)
```
    Custom constructor to simplify subclassing.
    
    Parameters:
    
    dynamic - Flag indicating if this is a static or dynamic resource.
    
    config - The config to use to create widget.
- Method Detail
  - 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 TreeWidgetBase
    
    Parameters:
    
    beforeUpdate - Config reference capturing the config state before the owner's config was modified.
  - clearAll
```
public void clearAll()
```
    This methods calls super, then clear all columns.
    
    Specified by:
    
    clearAll in interface TreeFace
    
    Overrides:
    
    clearAll in class TreeWidgetBase
  - createCellImage
```
public integer createCellImage(character path)
```
    Creates an image that can be later used in setCellIcon(NumberType, NumberType, NumberType)
    
    Specified by:
    
    createCellImage in interface TreeList
    
    Parameters:
    
    path - The image file path. Can be an absolute name or relative. When relative the Propath entries will be searched.
    
    Returns:
    
    the 0-based index into the cell image list for the newly created image or unknown if image can not be created
  - createColumn
```
public integer createColumn(character caption,
                            NumberType dataType,
                            NumberType width,
                            NumberType align,
                            NumberType bgColor,
                            NumberType fgColor)
```
    Create a new column and append to the tree-list columns.
    
    Specified by:
    
    createColumn in interface TreeList
    
    Parameters:
    
    caption - Column caption.
    
    dataType - Data type, where: 0... character, 1... decimal, 2... date/datetime (TODO), 3... integer, 4... icon (TODO)
    
    width - Pixel width of the column.
    
    align - Horizontal value alignment, where: 0... TODO, 1... right, 2... middle, 3... left
    
    bgColor - Background color. The value is binary compatible with the result of RGB-VALUE function.
    
    fgColor - Foreground color. The value is binary compatible with the result of RGB-VALUE function. TODO: is this parameter really foreground color?
    
    Returns:
    
    the column index.
  - ensureNodeVisible
```
public void ensureNodeVisible(character nodeKey)
```
    Assure the supplied node is visible in the tree viewport
    
    Specified by:
    
    ensureNodeVisible in interface TreeFace
    
    Parameters:
    
    nodeKey - the node to make visible
  - fixColumnsLeft
```
public void fixColumnsLeft(NumberType colIndex)
```
    Fixes the columns to the left starting at the provided column index. Fixed columns stay static during horizontal scrolling.
    
    Specified by:
    
    fixColumnsLeft in interface TreeList
    
    Parameters:
    
    colIndex - Column index. Set negative value or unknown to unfix all columns.
  - getCellBgColor
```
public integer getCellBgColor(NumberType nodeId,
                              NumberType colIndex)
```
    Returns background color of the supplied cell. 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.
    
    Specified by:
    
    getCellBgColor in interface TreeList
    
    Parameters:
    
    nodeId - A valid node id.
    
    colIndex - Column index.
    
    Returns:
    
    the color value or unknown if the node is not found or the widget has not been realized.
  - getCellFgColor
```
public integer getCellFgColor(NumberType nodeId,
                              NumberType colIndex)
```
    Returns foreground color of the supplied cell. The returned color value is compatible with the P4GL color binary format, i.e. BGR encoding.
    
    Specified by:
    
    getCellFgColor in interface TreeList
    
    Parameters:
    
    nodeId - A valid node id.
    
    colIndex - Column index.
    
    Returns:
    
    the color value or unknown if the node is not found or the widget has not been realized.
  - getCellString
```
public void getCellString(NumberType nodeId,
                          NumberType colIndex,
                          character outValue)
```
    Retrieve cell value as a string.
    
    Specified by:
    
    getCellString in interface TreeList
    
    Parameters:
    
    nodeId - Node id.
    
    colIndex - 0-based column index
    
    outValue - If the method succeeds, it will assign the cell string value.
  - getColumnPosition
```
public integer getColumnPosition(NumberType index)
```
    Returns column position, based on the column index.
    
    Specified by:
    
    getColumnPosition in interface TreeList
    
    Parameters:
    
    index - Column index.
    
    Returns:
    
    column position.
  - getColumnWidth
```
public integer getColumnWidth(NumberType index)
```
    Returns column width of a specified column.
    
    Specified by:
    
    getColumnWidth in interface TreeList
    
    Parameters:
    
    index - Column index.
    
    Returns:
    
    column width in pixels.
  - getDateSeparator
```
public character getDateSeparator()
```
    Getter for the DATE-SEPARATOR attribute.
    
    Specified by:
    
    getDateSeparator in interface TreeList
    
    Returns:
    
    the attribute value.
  - getDecimalSeparator
```
public character getDecimalSeparator()
```
    Getter for the DECIMAL-SEPARATOR attribute.
    
    Specified by:
    
    getDecimalSeparator in interface TreeList
    
    Returns:
    
    the attribute value.
  - getNodeBgColor
```
public 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.
    
    Specified by:
    
    getNodeBgColor in interface TreeFace
    
    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.
  - getNodeFgColor
```
public 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.
    
    Specified by:
    
    getNodeFgColor in interface TreeFace
    
    Overrides:
    
    getNodeFgColor in class TreeWidgetBase
    
    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.
  - getShortDateFormat
```
public character getShortDateFormat()
```
    Getter for the SHORT-DATE-FORMAT attribute.
    
    Specified by:
    
    getShortDateFormat in interface TreeList
    
    Returns:
    
    the attribute value.
  - getSortedColumnCount
```
public integer getSortedColumnCount()
```
    Getter for the SORTED-COLUMN-COUNT attribute. Returns number of tree columns used as the sort key.
    
    Specified by:
    
    getSortedColumnCount in interface TreeList
    
    Returns:
    
    see above.
  - getSortedColumns
```
public integer getSortedColumns()
```
    Getter for the SORTED-COLUMNS attribute. Returns the 0-based column index of the last sorted column or -1, if the tree has no sorted columns.
    
    Specified by:
    
    getSortedColumns in interface TreeList
    
    Returns:
    
    see above.
  - getThousandSeparator
```
public character getThousandSeparator()
```
    Getter for the THOUSAND-SEPARATOR attribute.
    
    Specified by:
    
    getThousandSeparator in interface TreeList
    
    Returns:
    
    the attribute value.
  - getTriggerColumn
```
public integer getTriggerColumn()
```
    Getter for TRIGGER-COLUMN attribute. Return the index of the column which triggered column sorting.
    
    Specified by:
    
    getTriggerColumn in interface TreeList
    
    Returns:
    
    The index of the trigger column.
  - isAsteriskActive
```
public logical isAsteriskActive()
```
    Getter for the ASTERISK-ACTIVE attribute.
    
    Specified by:
    
    isAsteriskActive in interface TreeList
    
    Returns:
    
    the attribute value.
  - isColumnVisible
```
public logical isColumnVisible(NumberType index)
```
    IS-COLUMN-VISIBLE method. Returns column visibility state.
    
    Specified by:
    
    isColumnVisible in interface TreeList
    
    Parameters:
    
    index - 0-based column index
    
    Returns:
    
    see above.
  - isEventsActive
```
public logical isEventsActive()
```
    Getter for the EVENTS-ACTIVE attribute.
    
    Specified by:
    
    isEventsActive in interface TreeList
    
    Returns:
    
    the attribute value.
  - isShowHeader
```
public logical isShowHeader()
```
    Getter for the SHOW-HEADER attribute.
    
    Specified by:
    
    isShowHeader in interface TreeList
    
    Returns:
    
    the attribute value.
  - moveDownInParent
```
public void moveDownInParent()
```
    This should move the currently selected node after its next sibling. If the selected node is the last child of its parent, this method is a no-op. The collapse/expand flags shouldn't be altered.
    
    Specified by:
    
    moveDownInParent in interface TreeList
  - moveUpInParent
```
public void moveUpInParent()
```
    This should move the currently selected node before its previous sibling. If the selected node is the first child of its parent, this method is a no-op. The collapse/expand flags shouldn't be altered.
    
    Specified by:
    
    moveUpInParent in interface TreeList
  - resort
```
public void resort()
```
    Resorts the list according to current settings.
    
    Specified by:
    
    resort in interface TreeList
  - setAsteriskActive
```
public void setAsteriskActive(logical value)
```
    Setter for the ASTERISK-ACTIVE attribute.
    
    Specified by:
    
    setAsteriskActive in interface TreeList
    
    Parameters:
    
    value - the attribute value
  - setBuildingTree
```
public void setBuildingTree(logical value)
```
    Setter for the BUILDING-TREE attribute. When set to true any model changes (columns added, nodes added or removed) won't be reflected until the attribute is set back to false.
    
    Specified by:
    
    setBuildingTree in interface TreeFace
    
    Overrides:
    
    setBuildingTree in class TreeWidgetBase
    
    Parameters:
    
    value - the attribute value
  - setCellBgColor
```
public void setCellBgColor(NumberType nodeId,
                           NumberType colIndex,
                           NumberType color)
```
    Sets background color for the supplied cell.
    
    Specified by:
    
    setCellBgColor in interface TreeList
    
    Parameters:
    
    nodeId - A valid node id.
    
    colIndex - Column index.
    
    color - The new color.
  - _getSelectedNodesIds
```
private java.util.List<java.lang.Integer> _getSelectedNodesIds()
```
    Get the ids of the selected nodes
    
    Returns:
    
    see above
  - getFocusedAndSelectedNode
```
public handle getFocusedAndSelectedNode()
```
    Getter for the FOCUSED-AND-SELECTED-NODE attribute. The method returns a handle the currently focused node or unknown handle when no node is currently focused. The handle will wrap an instance of TreeNodeResource. Note that the runtime behavior is the same as for the SELECTED-NODE attribute.
    
    Specified by:
    
    getFocusedAndSelectedNode in interface TreeFace
    
    Overrides:
    
    getFocusedAndSelectedNode in class TreeWidgetBase
    
    Returns:
    
    the attribute value.
  - getSelectedNodeId
```
public integer getSelectedNodeId()
```
    Getter for the SELECTED-NODE-ID attribute. The method returns node id of the currently selected node or integer value 0 when no node is currently selected.
    
    Specified by:
    
    getSelectedNodeId in interface TreeFace
    
    Overrides:
    
    getSelectedNodeId in class TreeWidgetBase
    
    Returns:
    
    the attribute value.
  - _getSelectedNode
```
protected TreeNodeResource _getSelectedNode()
```
    Get selected node by node ID helper method.
    
    Returns:
    
    the selected node
  - getSelectedNodeKey
```
public 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.
    
    Specified by:
    
    getSelectedNodeKey in interface TreeFace
    
    Overrides:
    
    getSelectedNodeKey in class TreeWidgetBase
    
    Returns:
    
    the attribute value.
  - removeNode
```
void removeNode(TreeNodeResource node,
                boolean pushNodes)
```
    Removes the node from the tree internal structures.
    
    Overrides:
    
    removeNode in class TreeWidgetBase
    
    Parameters:
    
    node - The node being removed.
    
    pushNodes - When set to true the model change will be pushed to the client.
  - _setSelectedNode
```
void _setSelectedNode(int nodeId,
                      boolean trigger)
```
    Convenient method for setting the selected node just by its id.
    
    Overrides:
    
    _setSelectedNode in class TreeWidgetBase
    
    Parameters:
    
    nodeId - The id of the tree node which should be selected.
    
    trigger - Flag to indicate if the VALUE-CHANGED trigger should be fired.
  - setCellFgColor
```
public void setCellFgColor(NumberType nodeId,
                           NumberType colIndex,
                           NumberType color)
```
    Sets foreground color for the supplied cell.
    
    Specified by:
    
    setCellFgColor in interface TreeList
    
    Parameters:
    
    nodeId - A valid node id.
    
    colIndex - Column index.
    
    color - The color value.
  - setCellIcon
```
public void setCellIcon(NumberType nodeId,
                        NumberType colIndex,
                        NumberType imgId)
```
    SET-CELL-ICON-VALUE method. Assigns image to a cell of the specified node.
    
    Specified by:
    
    setCellIcon in interface TreeList
    
    Parameters:
    
    nodeId - Node id.
    
    colIndex - 0-based column index
    
    imgId - Id of the image to assign. The image must be first created with TreeFace.createImage(character).
  - setCellString
```
public void setCellString(NumberType nodeId,
                          NumberType colIndex,
                          character value)
```
    Sets string value to a specified cell.
    
    Specified by:
    
    setCellString in interface TreeList
    
    Parameters:
    
    nodeId - Node id.
    
    colIndex - 0-based column index
    
    value - New string value.
  - setColumnCaption
```
public void setColumnCaption(NumberType index,
                             character caption)
```
    Sets column caption.
    
    Specified by:
    
    setColumnCaption in interface TreeList
    
    Parameters:
    
    index - Column index.
    
    caption - The new caption.
  - setColumnVisible
```
public void setColumnVisible(NumberType colIndex,
                             logical visible)
```
    SET-COLUMN-VISIBLE method. Sets column visibility state.
    
    Specified by:
    
    setColumnVisible in interface TreeList
    
    Parameters:
    
    colIndex - 0-based column index
    
    visible - New visibility state.
  - setColumnWidth
```
public void setColumnWidth(NumberType colIndex,
                           NumberType width)
```
    Sets column width of a specified column.
    
    Specified by:
    
    setColumnWidth in interface TreeList
    
    Parameters:
    
    colIndex - Column index.
    
    width - The new width.
  - setDateSeparator
```
public void setDateSeparator(character value)
```
    Setter for the DATE-SEPARATOR attribute.
    
    Specified by:
    
    setDateSeparator in interface TreeList
    
    Parameters:
    
    value - the attribute value
  - setDecimalSeparator
```
public void setDecimalSeparator(character value)
```
    Setter for the DECIMAL-SEPARATOR attribute.
    
    Specified by:
    
    setDecimalSeparator in interface TreeList
    
    Parameters:
    
    value - the attribute value
  - setEventsActive
```
public void setEventsActive(logical value)
```
    Setter for the EVENTS-ACTIVE attribute. TODO: find out what this does
    
    Specified by:
    
    setEventsActive in interface TreeList
    
    Parameters:
    
    value - the attribute value
  - setNodeBgColor
```
public void setNodeBgColor(NumberType nodeId,
                           NumberType bgrValue)
```
    Sets background color for the supplied node.
    
    Specified by:
    
    setNodeBgColor in interface TreeFace
    
    Parameters:
    
    nodeId - a valid node id
    
    bgrValue - the new color
  - setNodeFgColor
```
public void setNodeFgColor(NumberType nodeId,
                           NumberType fgrValue)
```
    Sets foreground color for the supplied node.
    
    Specified by:
    
    setNodeFgColor in interface TreeFace
    
    Parameters:
    
    nodeId - a valid node id
    
    fgrValue - the new color
  - setShortDateFormat
```
public void setShortDateFormat(character value)
```
    Setter for the SHORT-DATE-FORMAT attribute.
    
    Specified by:
    
    setShortDateFormat in interface TreeList
    
    Parameters:
    
    value - the attribute value
  - setShowHeader
```
public void setShowHeader(logical value)
```
    Setter for the SHOW-HEADER attribute. When set to true columns header will be shown at the top of the list.
    
    Specified by:
    
    setShowHeader in interface TreeList
    
    Parameters:
    
    value - the attribute value
  - setSortedColumns
```
public void setSortedColumns(NumberType colIndex)
```
    Setter for the SORTED-COLUMNS attribute. Make either a column the only sorting column in the tree, or no sorting column at all.
    
    Specified by:
    
    setSortedColumns in interface TreeList
    
    Parameters:
    
    colIndex - The index of the column to sort ascending by or a negative value to disable sorting.
  - setThousandSeparator
```
public void setThousandSeparator(character value)
```
    Setter for the THOUSAND-SEPARATOR attribute.
    
    Specified by:
    
    setThousandSeparator in interface TreeList
    
    Parameters:
    
    value - the attribute value
  - sortTreeList
```
public void sortTreeList(int index,
                         boolean resetSorting)
```
    Sorts a tree list widget by a column.
    
    Parameters:
    
    index - the index of the column being sorted
    
    resetSorting - if true, then reset column sorting
  - setMultiSelect
```
public void setMultiSelect(logical extended,
                           logical value)
```
    SET-MULTI-SELECT options.
    
    Specified by:
    
    setMultiSelect in interface TreeFace
    
    Overrides:
    
    setMultiSelect in class TreeWidgetBase
    
    Parameters:
    
    extended - extended selection, if false only sibling nodes can be multi-selected, otherwise any nodes can be selected.
    
    value - the new multiSelect value
  - isMultiSelect
```
public logical isMultiSelect(logical extended)
```
    Getter for the IS-MULTI-SELECT attribute. The method returns the multiselect mode value set.
    
    Specified by:
    
    isMultiSelect in interface TreeFace
    
    Overrides:
    
    isMultiSelect in class TreeWidgetBase
    
    Parameters:
    
    extended - extended selection mode.
    
    Returns:
    
    the multiselect value.
  - addColumn
```
protected final void addColumn(TreeListConfig.Column column)
```
    Append a newly-created column to the end of column list.
    
    Parameters:
    
    column - the column to append
  - allowDuplicateKeys
```
protected boolean allowDuplicateKeys()
```
    Test if this tree allows duplicate node key values.
    
    Specified by:
    
    allowDuplicateKeys in class TreeWidgetBase
    
    Returns:
    
    see above
  - createNode
```
protected TreeListNodeResource createNode(java.lang.String key,
                                          java.lang.String text,
                                          TreeNodeResource parent)
```
    Creates new node.
    
    Specified by:
    
    createNode in class TreeWidgetBase
    
    Parameters:
    
    key - Node key.
    
    text - Node text.
    
    parent - Node parent.
    
    Returns:
    
    new node instance.
  - firesNodeExpandOnLeaf
```
protected boolean firesNodeExpandOnLeaf()
```
    Test if this tree triggers a node expand type event when expanding leaf nodes.
    
    Specified by:
    
    firesNodeExpandOnLeaf in class TreeWidgetBase
    
    Returns:
    
    see above
  - columnUpdate
```
private void columnUpdate(int index,
                          TreeListConfig.Column column)
```
    Update a column at the given index.
    
    Parameters:
    
    index - valid column index
    
    column - the new column
  - findColumn
```
private TreeListConfig.Column findColumn(int colIndex)
```
    Finds column configuration entry from column index.
    
    Parameters:
    
    colIndex - A valid column index.
    
    Returns:
    
    Column reference or null if the index doesn't refer to a valid column.
  - findColumn
```
private TreeListConfig.Column findColumn(NumberType colIndex)
```
    Finds column configuration entry from column index.
    
    Parameters:
    
    colIndex - A valid column index.
    
    Returns:
    
    Column reference or null if the index doesn't refer to a valid column.
  - getCellValue
```
private final <T> T getCellValue(NumberType nodeId,
                                 NumberType colIndex,
                                 java.util.function.Function<TreeNodeResource,java.util.List<T>> getValues)
```
    Helper method to set indexed field values, like cell colors and values.
    
    Type Parameters:
    
    T - the value type
    
    Parameters:
    
    nodeId - the node ID
    
    colIndex - the cell index
    
    getValues - the procedure to retrieve the value array from the node
    
    Returns:
    
    the cell value
  - setCellValue
```
private final <T> void setCellValue(int nodeId,
                                    int colIndex,
                                    java.util.function.Function<TreeNodeResource,java.util.List<T>> getValues,
                                    T newValue)
```
    Helper method to set indexed field values, like cell colors and values.
    
    Parameters:
    
    nodeId - the node ID
    
    colIndex - the cell index
    
    getValues - the procedure to retrieve the value array from the node
    
    newValue - the new value
  - swapNodes
```
private final void swapNodes(java.util.function.Function<TreeNodeResource,handle> getOtherNode)
```
    If a node is selected in the tree, try to swap it with the given node. If no node selected or the other node is null, then do nothing.
    
    Parameters:
    
    getOtherNode - the function to obtain the other node, may return null. the function must guarantee its return value always differs from the selected node.
  - treeListConfig
```
private final TreeListConfig treeListConfig()
```
    Get widget config casted to the real type.
    
    Returns:
    
    see above
  - sortNodes
```
private void sortNodes(java.util.List<TreeNodeResource> nodes,
                       java.util.Comparator<TreeNodeResource> comparator)
```
    Sort nodes recursively using the provided comparator.
    
    Parameters:
    
    nodes - the nodes to sort.
    
    comparator - the comparator to use when sorting
  - nodeComparator
```
private final java.util.Comparator<TreeNodeResource> nodeComparator()
```
    Create a comparator capable to compare nodes based on current sorting column.
    
    Returns:
    
    the comparator or null if no sorting column is set in the tree.
  - convertCompare
```
private static <T extends java.lang.Comparable<T>> java.util.Comparator<TreeNodeResource> convertCompare(int index,
                                                                                                         java.util.function.Function<java.lang.String,T> parser,
                                                                                                         boolean descending,
                                                                                                         T defaultValue)
```
    Create a comparator suitable for comparing cell values in the sorting column with datatypes other than STRING or ICON.
    For such columns, the cell values should be compared according to their types. So, the value string representations shall first be parsed into the corresponding types before the values can be compared.
    The parsed values are cached in the TreeListNodeEntry.cellSortingValues.
    
    Type Parameters:
    
    T - the type of values to compare.
    
    Parameters:
    
    index - the column index
    
    parser - the parsing function to try to parse string
    
    descending - true if sorting order should be reversed
    
    defaultValue - the value to use if parse was not successful
    
    Returns:
    
    the comparator created
  - directCompare
```
private static <T extends java.lang.Comparable<T>> java.util.Comparator<TreeNodeResource> directCompare(int index,
                                                                                                        java.util.function.Function<java.lang.Object,T> parser,
                                                                                                        boolean descending)
```
    Create a comparator suitable for comparing cell values in the sorting column with datatypes STRING and ICON. For such columns, the values in TreeListNodeEntry.cellValues can be directly compared.
    
    Type Parameters:
    
    T - the type of values to compare.
    
    Parameters:
    
    index - the column index
    
    parser - the parsing function to try to parse string
    
    descending - true if sorting order should be reversed
    
    Returns:
    
    the comparator created
  - getDateTimeParser
```
private final java.time.format.DateTimeFormatter getDateTimeParser()
```
    Get datetime parser to use when sorting columns of DATETIME type.
    
    Returns:
    
    the formatter created.
  - parseDecimal
```
private double parseDecimal(java.lang.String s)
                     throws ErrorConditionException
```
    Parse a decimal number, honor the group and decimal separators. The values of the group and decimal separators are taken from the tree list config or, if missing, from the 4gl SESSION configuration.
    
    Parameters:
    
    s - the string to parse
    
    Returns:
    
    the parsed value
    
    Throws:
    
    ErrorConditionException - if the value cannot parse
  - parseInteger
```
private int parseInteger(java.lang.String s)
                  throws ErrorConditionException
```
    Parse an integer number, honor the group separator.
    The values of the group separator are taken from the tree list config or, if missing, from the 4gl session configuration.
    
    Parameters:
    
    s - the string to parse
    
    Returns:
    
    the parsed value
    
    Throws:
    
    ErrorConditionException - if the value cannot be parsed

Class TreeListWidget

Nested Class Summary

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

Field Summary

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

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.TreeWidgetBase

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.util.WrappedResource

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

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

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

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.Nameable

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

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

Methods inherited from interface com.goldencode.util.Printable

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

Field Detail

columns

pendingPushColumns

selectedNodesIds

WHITE

dateTimeParser

Constructor Detail

TreeListWidget

TreeListWidget

TreeListWidget

Method Detail

afterConfigUpdate

clearAll

createCellImage

createColumn

ensureNodeVisible

fixColumnsLeft

getCellBgColor

getCellFgColor

getCellString

getColumnPosition

getColumnWidth

getDateSeparator

getDecimalSeparator

getNodeBgColor

getNodeFgColor

getShortDateFormat

getSortedColumnCount

getSortedColumns

getThousandSeparator

getTriggerColumn

isAsteriskActive

isColumnVisible

isEventsActive

isShowHeader

moveDownInParent

moveUpInParent

resort

setAsteriskActive

setBuildingTree

setCellBgColor

_getSelectedNodesIds

getFocusedAndSelectedNode