com.goldencode.p2j.ui

Interface TreeList

All Superinterfaces:

CustomFont, HasVisible, Nodes, OcxDragDrop, RemoveNode, TreeFace, WrappedResource

All Known Subinterfaces:

HandleCommon

All Known Implementing Classes:

TreeListWidget

public interface TreeList
extends WrappedResource, TreeFace

Interface for the server side TreeView widget implementation.

Method Summary

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.

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

id, id, unknown, valid

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

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

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

getNodes

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

removeNode

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

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

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

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

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

isVisible, setVisible, setVisible

Method Detail

getSortedColumns

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.

Returns:

see above.

setSortedColumns

void setSortedColumns(NumberType colIndex)

Setter for the SORTED-COLUMNS attribute. Make a column sorting, assure this column is the only sorting column in the tree.

Parameters:

colIndex - The index of the column to sort ascending by or a negative value to disable sorting.

getSortedColumnCount

integer getSortedColumnCount()

Getter for the SORTED-COLUMN-COUNT attribute. Returns number of tree columns used as the sort key.

Returns:

see above.

resort

void resort()

Resorts the list according to current settings.

fixColumnsLeft

void fixColumnsLeft(NumberType colIndex)

Fixes the columns to the left starting at the provided column index. Fixed columns stay static during horizontal scrolling.

Parameters:

colIndex - Column index. Set negative value or unknown to unfix all columns.

createColumn

integer createColumn(character caption,
                     NumberType dataType,
                     NumberType width,
                     NumberType align,
                     NumberType bgColor,
                     NumberType fgColor)

Adds new column to the tree-list.

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.

getTriggerColumn

integer getTriggerColumn()

The attribute holds the column index that is the target of the current trigger. The value is valid only during the following trigger: COLUMN-SORTING.

Returns:

The index of the trigger column.

setColumnCaption

void setColumnCaption(NumberType index,
                      character caption)

Sets column caption.

Parameters:

index - Column index.

caption - The new caption.

getColumnWidth

integer getColumnWidth(NumberType index)

Returns column width of a specified column.

Parameters:

index - Column index.

Returns:

column width in pixels.

setColumnWidth

void setColumnWidth(NumberType index,
                    NumberType width)

Sets column width of a specified column.

Parameters:

index - Column index.

width - The new width.

getColumnPosition

integer getColumnPosition(NumberType index)

Returns column position, based on the column index.

Parameters:

index - Column index.

Returns:

column position.

isShowHeader

logical isShowHeader()

Getter for the SHOW-HEADER attribute.

Returns:

the attribute value.

setShowHeader

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.

Parameters:

value - the attribute value

getThousandSeparator

character getThousandSeparator()

Getter for the THOUSAND-SEPARATOR attribute.

Returns:

the attribute value.

setThousandSeparator

void setThousandSeparator(character value)

Setter for the SHOW-HEADER attribute.

Parameters:

value - the attribute value

getDecimalSeparator

character getDecimalSeparator()

Getter for the DECIMAL-SEPARATOR attribute.

Returns:

the attribute value.

setDecimalSeparator

void setDecimalSeparator(character value)

Setter for the DECIMAL-SEPARATOR attribute.

Parameters:

value - the attribute value

getDateSeparator

character getDateSeparator()

Getter for the DATE-SEPARATOR attribute.

Returns:

the attribute value.

setDateSeparator

void setDateSeparator(character value)

Setter for the DATE-SEPARATOR attribute.

Parameters:

value - the attribute value

getShortDateFormat

character getShortDateFormat()

Getter for the SHORT-DATE-FORMAT attribute.

Returns:

the attribute value.

setShortDateFormat

void setShortDateFormat(character value)

Setter for the SHORT-DATE-FORMAT attribute.

Parameters:

value - the attribute value

isColumnVisible

logical isColumnVisible(NumberType colIndex)

IS-COLUMN-VISIBLE method. Returns column visibility state.

Parameters:

colIndex - 0-based column index

Returns:

see above.

setColumnVisible

void setColumnVisible(NumberType colIndex,
                      logical visible)

SET-COLUMN-VISIBLE method. Sets column visibility state.

Parameters:

colIndex - 0-based column index

visible - New visibility state.

setCellIcon

void setCellIcon(NumberType nodeId,
                 NumberType colIndex,
                 NumberType imgId)

SET-CELL-ICON-VALUE method. Assigns image to a cell of the specified node.

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

moveUpInParent

void moveUpInParent()

TODO: find out what this method does

moveDownInParent

void moveDownInParent()

TODO: find out what this method does

getCellString

void getCellString(NumberType nodeId,
                   NumberType colIndex,
                   character outValue)

Assigns string value to a specified cell.

Parameters:

nodeId - Node id.

colIndex - 0-based column index

outValue - If the method succeeds, it will assign the cell string value.

setCellString

void setCellString(NumberType nodeId,
                   NumberType colIndex,
                   character value)

Sets string value to a specified cell.

Parameters:

nodeId - Node id.

colIndex - 0-based column index

value - New string value.

isAsteriskActive

logical isAsteriskActive()

Getter for the ASTERISK-ACTIVE attribute.

Returns:

the attribute value.

setAsteriskActive

void setAsteriskActive(logical value)

Setter for the ASTERISK-ACTIVE attribute.

Parameters:

value - the attribute value

isEventsActive

logical isEventsActive()

Getter for the EVENTS-ACTIVE attribute.

Returns:

the attribute value.

setEventsActive

void setEventsActive(logical value)

Setter for the EVENTS-ACTIVE attribute. TODO: find out what this does

Parameters:

value - the attribute value

getCellFgColor

integer getCellFgColor(NumberType nodeId,
                       NumberType colIndex)

Returns foreground 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.

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.

setCellFgColor

void setCellFgColor(NumberType nodeId,
                    NumberType colIndex,
                    NumberType fgrValue)

Sets foreground color for the supplied cell.

Parameters:

nodeId - A valid node id.

colIndex - Column index.

fgrValue - The new color.

getCellBgColor

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.

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.

setCellBgColor

void setCellBgColor(NumberType nodeId,
                    NumberType colIndex,
                    NumberType bgrValue)

Sets background color for the supplied cell.

Parameters:

nodeId - A valid node id.

colIndex - Column index.

bgrValue - The new color.

createCellImage

integer createCellImage(character path)

Creates an image that can be later used in setCellIcon(NumberType, NumberType, NumberType)

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