com.goldencode.p2j.ui

Class TreeListNodeResource

java.lang.Object

com.goldencode.p2j.util.HandleResource

com.goldencode.p2j.ui.TreeNodeResource

com.goldencode.p2j.ui.TreeListNodeResource

All Implemented Interfaces:

Checkable, Nodes, TreeListNode, TreeNodeFace, CommonHandle, Deletable, DynamicResource, InstantiatingProcedure, WrappedResource, Printable

public class TreeListNodeResource
extends TreeNodeResource
implements TreeListNode

TREELIST-NODE resource implementation.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<ColorRgb>	cellBGColors Cell custom background colors
protected java.util.List<ColorRgb>	cellFGColors Cell custom text colors
java.util.List<java.lang.Object>	cellValues Cell values for this node entry.

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

bold, checked, key, nodeId, nodes, parent, tag, tree

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

instProc, pm

Constructor Summary

Constructors

Constructor and Description
TreeListNodeResource(TreeWidgetBase treeList, int nodeId, java.lang.String key, java.lang.String text, TreeNodeResource parent) Constructor.
TreeListNodeResource(TreeWidgetBase treeList, int nodeId, java.lang.String key, TreeNodeResource parent) Constructor.

Method Summary

Modifier and Type	Method and Description
int	getBgColor() Returns the node's background color, if it was previously set with setBgColor(int).
<T> T	getCellValue(int colIndex, java.util.function.Function<TreeNodeResource,java.util.List<T>> getValues) Helper method to retrieve indexed field values, like cell colors and values.
int	getFgColor() Returns the node's foreground color.
character	getNodeText() Getter for the NODE-TEXT attribute.
protected TreeNodeEntry	saveToEntry() The method serializes the node state into new config entry instance.
void	setBgColor(int bgColor) Sets the node's background color.
void	setFgColor(int fgColor) Sets the node's foreground color.
void	setNodeText(character value) Setter for the NODE-TEXT attribute.

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

_dynamic, _getHasChildren, _getNodeId, _getNodeKey, _getNodeLevel, _getNodes, _getNodes, _getParent, _isNodeExpanded, _removeCollection, _setExpandNodeIcon, _setHasChildren, _setNodeExpanded, _setNodeIcon, _setSelectedNodeIcon, _setTooltip, delete, dynamic, ensureVisible, getChildNode, getChildren, getEditorMode, getExpandNodeIcon, getFirstSiblingNode, getFullPath, getLastSiblingNode, getNextNode, getNodeIcon, getNodeId, getNodeIndex, getNodeKey, getNodes, getParentNode, getPreviousNode, getSelectedNodeIcon, getTag, getTreeNodeIndex, getTreeNodeValue, isBold, isChecked, isNodeExpanded, isSelected, isVisible, loadFromEntry, print, resourceDelete, saveToEntry, setBold, setChecked, setChecked, setEditorMode, setExpandNodeIcon, setExpandNodeIcon, setNodeExpanded, setNodeIcon, setNodeIcon, setNodeKey, setParentNode, setSelected, setSelectedNodeIcon, setSelectedNodeIcon, setTag, setTreeNodeValue, valid

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

_instantiatingProcedure, addToPool, doDelete, equals, hashCode, id, id, implicitDeletion, incrementTrigger, instantiatingProcedure, invalidAttribute, processResource, readOnlyError, readOnlyError, registerResource, resourceType, setInstantiatingProcedure, toString, type, unableToAssignUnknown, unknown

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

ensureVisible, getChildNode, getChildren, getEditorMode, getExpandNodeIcon, getFirstSiblingNode, getFullPath, getLastSiblingNode, getNextNode, getNodeIcon, getNodeId, getNodeIndex, getNodeKey, getParentNode, getPreviousNode, getSelectedNodeIcon, getTag, getTreeNodeIndex, getTreeNodeValue, isBold, isNodeExpanded, isSelected, isVisible, setBold, setEditorMode, setExpandNodeIcon, setExpandNodeIcon, setNodeExpanded, setNodeIcon, setNodeIcon, setNodeKey, setParentNode, setSelected, setSelectedNodeIcon, setSelectedNodeIcon, setTag, setTreeNodeValue

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

id, id, unknown, valid

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

getNodes

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

isChecked, setChecked, setChecked

Methods inherited from interface com.goldencode.util.Printable

asString

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

allowDelete

Field Detail

cellValues

public final java.util.List<java.lang.Object> cellValues

Cell values for this node entry. Each cell value may be in a form of string or integer. A string value is used is cell display string. An integer value denotes index into the cell image list.

cellBGColors

protected final java.util.List<ColorRgb> cellBGColors

Cell custom background colors

cellFGColors

protected final java.util.List<ColorRgb> cellFGColors

Cell custom text colors

Constructor Detail

TreeListNodeResource

public TreeListNodeResource(TreeWidgetBase treeList,
                            int nodeId,
                            java.lang.String key,
                            java.lang.String text,
                            TreeNodeResource parent)

Constructor.

Parameters:

treeList - Owning tree list.

nodeId - Node id.

key - Node key.

text - Node text.

parent - Node parent.

TreeListNodeResource

public TreeListNodeResource(TreeWidgetBase treeList,
                            int nodeId,
                            java.lang.String key,
                            TreeNodeResource parent)

Constructor.

Parameters:

treeList - Owning tree list.

nodeId - Node id.

key - Node key.

parent - Node parent.

Method Detail

getBgColor

public int getBgColor()

Returns the node's background color, if it was previously set with setBgColor(int). 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:

getBgColor in class TreeNodeResource

Returns:

background color

getCellValue

public final <T> T getCellValue(int colIndex,
                                java.util.function.Function<TreeNodeResource,java.util.List<T>> getValues)

Helper method to retrieve indexed field values, like cell colors and values.

Type Parameters:

T - the value type

Parameters:

colIndex - the cell index

getValues - the procedure to retrieve the value array from the node

Returns:

the cell value

getFgColor

public int getFgColor()

Returns the node's foreground color. 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:

getFgColor in class TreeNodeResource

Returns:

foreground color

getNodeText

public character getNodeText()

Getter for the NODE-TEXT attribute. The attribute holds the text displayed on the node in the widget.

Specified by:

getNodeText in interface TreeNodeFace

Specified by:

getNodeText in class TreeNodeResource

Returns:

the attribute value.

setBgColor

public void setBgColor(int bgColor)

Sets the node's background color. The method expects argument compatible with the P4GL color binary format, i.e. BGR encoding.

Specified by:

setBgColor in class TreeNodeResource

Parameters:

bgColor - New background color.

setFgColor

public void setFgColor(int fgColor)

Sets the node's foreground color. The method expects argument compatible with the P4GL color binary format, i.e. BGR encoding.

Specified by:

setFgColor in class TreeNodeResource

Parameters:

fgColor - New foreground color.

setNodeText

public void setNodeText(character value)

Setter for the NODE-TEXT attribute.

Specified by:

setNodeText in interface TreeNodeFace

Specified by:

setNodeText in class TreeNodeResource

Parameters:

value - the new attribute value.

saveToEntry

protected TreeNodeEntry saveToEntry()

The method serializes the node state into new config entry instance.

Specified by:

saveToEntry in class TreeNodeResource

Returns:

new instance of TreeListNodeEntry.