public interface TreeList extends WrappedResource, TreeFace
Modifier and Type | Method and Description |
---|---|
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)
Adds new column to the tree-list.
|
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)
Assigns string value to a specified cell.
|
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.
|
character |
getDecimalSeparator()
Getter for the DECIMAL-SEPARATOR 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()
The attribute holds the column index that is the target of the current trigger.
|
logical |
isAsteriskActive()
Getter for the ASTERISK-ACTIVE attribute.
|
logical |
isColumnVisible(NumberType colIndex)
IS-COLUMN-VISIBLE method.
|
logical |
isEventsActive()
Getter for the EVENTS-ACTIVE attribute.
|
logical |
isShowHeader()
Getter for the SHOW-HEADER attribute.
|
void |
moveDownInParent()
TODO: find out what this method does
|
void |
moveUpInParent()
TODO: find out what this method does
|
void |
resort()
Resorts the list according to current settings.
|
void |
setAsteriskActive(logical value)
Setter for the ASTERISK-ACTIVE attribute.
|
void |
setCellBgColor(NumberType nodeId,
NumberType colIndex,
NumberType bgrValue)
Sets background color for the supplied cell.
|
void |
setCellFgColor(NumberType nodeId,
NumberType colIndex,
NumberType fgrValue)
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.
|
void |
setColumnCaption(NumberType index,
character caption)
Sets column caption.
|
void |
setColumnVisible(NumberType colIndex,
logical visible)
SET-COLUMN-VISIBLE method.
|
void |
setColumnWidth(NumberType index,
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 |
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 SHOW-HEADER attribute.
|
id, id, unknown, valid
clearAll, clearNodesImageList, collapseAll, collapseAllExcept, collapseNode, createImage, createMergedImage, createSubNode, createSubNode, deleteChildNodes, ensureNodeVisible, expandAll, expandNode, findNode, findNode, getDraggedNode, getDraggedOverNode, getDropHighlight, getFirstChildNode, getFirstNode, getFirstVisibleNode, getFocusedAndSelectedNode, getFocusedAndSelectedNodeKey, getFocusedNode, getFocusedNodeKey, getHWND, getImageList, getIndentation, getLineStyle, getMousePointerNum, getNewNodeLabel, getNextNode, getNextSiblingNode, getNodeAt, getNodeBgColor, getNodeBold, getNodeFgColor, getNodeHasChildren, getNodeHeight, getNodeLevel, getNodeText, getNodeVisibleInViewPort, getParentNode, getPrevSiblingNode, getPrivateData, getRemoveNodeOnCollapse, getRowHeight, getScrollNodeCount, getScrollWheelLines, getSelectedNode, getSelectedNodeColors, getSelectedNodeId, getSelectedNodeKey, getStyle, getTopVisibleNodeId, getTriggerNode, getVisibleNodeCount, hitTest, hitTestFwd, isBuildingTree, isCheckBoxes, isDblClickExpanding, isDragDrop, isDragDropOtherTree, isExpandOnEnter, isExpandOnSingleClick, isMultiSelect, isNodeExpanded, isShowButtons, isTextEdit, nodeKeyToId, scrollNodeToTop, scrollVertical, selectSetFirstVisibleNode, setBuildingTree, setCheckBoxes, setDblClickExpanding, setDragDrop, setDragDropOtherTree, setDropHighlight, setExpandOnEnter, setExpandOnSingleClick, setImageList, setImageList, setIndentation, setLineStyle, setMousePointerNum, setMultiSelect, setNewNodeLabel, setNodeBgColor, setNodeBold, setNodeFgColor, setNodeHasChildren, setNodeHeight, setNodeText, setPrivateData, setRemoveNodeOnCollapse, setRowHeight, setScrollWheelLines, setSelectedNode, setSelectedNodeColors, setSelectedNodeKey, setShowButtons, setStyle, setTextEdit, setTreeNodeIcons, startLabelEdit
removeNode
getFontInfo, getFontName, getFontSize, isFontBold, isFontItalic, isFontUnderline, setFontBold, setFontItalic, setFontName, setFontSize, setFontUnderline
getAllowedEffects, getDataFormat, getEffect, getOleDragMode, getOleDropMode, getOleX, getOleY, getState, isDefaultCursors, oleDrag, setAllowedEffects, setDataFormat, setDefaultCursors, setEffect, setOleDragMode, setOleDropMode, setOleX, setOleY, setState
isVisible, setVisible, setVisible
integer getSortedColumns()
void setSortedColumns(NumberType colIndex)
colIndex
- The index of the column to sort ascending by or a negative value to disable sorting.integer getSortedColumnCount()
void resort()
void fixColumnsLeft(NumberType colIndex)
colIndex
- Column index. Set negative value or unknown to unfix all columns.integer createColumn(character caption, NumberType dataType, NumberType width, NumberType align, NumberType bgColor, NumberType fgColor)
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... leftbgColor
- 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?integer getTriggerColumn()
void setColumnCaption(NumberType index, character caption)
index
- Column index.caption
- The new caption.integer getColumnWidth(NumberType index)
index
- Column index.void setColumnWidth(NumberType index, NumberType width)
index
- Column index.width
- The new width.integer getColumnPosition(NumberType index)
index
- Column index.logical isShowHeader()
void setShowHeader(logical value)
true
columns header
will be shown at the top of the list.value
- the attribute valuecharacter getThousandSeparator()
void setThousandSeparator(character value)
value
- the attribute valuecharacter getDecimalSeparator()
void setDecimalSeparator(character value)
value
- the attribute valuecharacter getDateSeparator()
void setDateSeparator(character value)
value
- the attribute valuecharacter getShortDateFormat()
void setShortDateFormat(character value)
value
- the attribute valuelogical isColumnVisible(NumberType colIndex)
colIndex
- 0-based column indexvoid setColumnVisible(NumberType colIndex, logical visible)
colIndex
- 0-based column indexvisible
- New visibility state.void setCellIcon(NumberType nodeId, NumberType colIndex, NumberType imgId)
nodeId
- Node id.colIndex
- 0-based column indeximgId
- Id of the image to assign. The image must be first created with
TreeFace.createImage(character)
.void moveUpInParent()
void moveDownInParent()
void getCellString(NumberType nodeId, NumberType colIndex, character outValue)
nodeId
- Node id.colIndex
- 0-based column indexoutValue
- If the method succeeds, it will assign the cell string value.void setCellString(NumberType nodeId, NumberType colIndex, character value)
nodeId
- Node id.colIndex
- 0-based column indexvalue
- New string value.logical isAsteriskActive()
void setAsteriskActive(logical value)
value
- the attribute valuelogical isEventsActive()
void setEventsActive(logical value)
value
- the attribute valueinteger getCellFgColor(NumberType nodeId, NumberType colIndex)
nodeId
- A valid node id.colIndex
- Column index.void setCellFgColor(NumberType nodeId, NumberType colIndex, NumberType fgrValue)
nodeId
- A valid node id.colIndex
- Column index.fgrValue
- The new color.integer getCellBgColor(NumberType nodeId, NumberType colIndex)
nodeId
- A valid node id.colIndex
- Column index.void setCellBgColor(NumberType nodeId, NumberType colIndex, NumberType bgrValue)
nodeId
- A valid node id.colIndex
- Column index.bgrValue
- The new color.integer createCellImage(character path)
setCellIcon(NumberType, NumberType, NumberType)
path
- The image file path. Can be an absolute name or relative. When relative the Propath entries
will be searched.