public interface TreeNodeFace extends WrappedResource, Nodes, Checkable
Modifier and Type | Method and Description |
---|---|
void |
ensureVisible()
Makes this node visible.
|
handle |
getChildNode()
Gets its first child node.
|
integer |
getChildren()
Getter for the CHILDREN attribute.
|
TreeNodeEntry.EditorMode |
getEditorMode()
Returns its label editor state.
|
integer |
getExpandNodeIcon()
Getter for the EXPAND-NODE-ICON attribute.
|
handle |
getFirstSiblingNode()
Gets its first sibling node.
|
character |
getFullPath()
Builds a string from node's labels separated by a backslash \ in the path from the root node
to this node.
|
handle |
getLastSiblingNode()
Gets its last sibling node.
|
handle |
getNextNode()
Gets its next sibling node.
|
integer |
getNodeIcon()
Getter for the NODE-ICON attribute.
|
integer |
getNodeId()
Every node is identified with a numeric node id.
|
integer |
getNodeIndex()
Getter for the NODE-INDEX attribute.
|
character |
getNodeKey()
Every node can also be identified with a textual key.
|
handle |
getNodeParent()
Getter for the NODE-PARENT.
|
character |
getNodeText()
Getter for the NODE-TEXT attribute.
|
handle |
getParentNode()
Gets its parent node.
|
handle |
getPreviousNode()
Gets its previous sibling node.
|
integer |
getSelectedNodeIcon()
Getter for the SelectedImage attribute.
|
character |
getTag()
Returns node TAG attribute.
|
integer |
getTreeNodeIndex()
Gets a unique calculated index of this node.
|
character |
getTreeNodeValue()
Getter for the TREE-NODE-VALUE attribute.
|
boolean |
isBold()
Returns node BOLD attribute.
|
logical |
isNodeExpanded()
Getter for the NODE-EXPANDED attribute.
|
logical |
isSelected()
Gets the logical value of its SELECTED property.
|
logical |
isVisible()
Returns true if this node is visible (shown in the view).
|
void |
setBold(logical bold)
Sets node BOLD attribute.
|
void |
setEditorMode(TreeNodeEntry.EditorMode editorMode)
Sets new editor state for its label editor.
|
void |
setExpandNodeIcon(BaseDataType imageId)
Setter for the EXPAND-NODE-ICON attribute.
|
void |
setExpandNodeIcon(NumberType imageId)
Setter for the EXPAND-NODE-ICON attribute.
|
void |
setNodeExpanded(logical value)
Setter for the NODE-EXPANDED attribute.
|
void |
setNodeIcon(BaseDataType imageId)
Setter for the NODE-ICON attribute.
|
void |
setNodeIcon(NumberType imageId)
Setter for the NODE-ICON attribute.
|
void |
setNodeKey(character newKey)
Updates the node key and the tree according to new value.
|
void |
setNodeText(character value)
Setter for the NODE-TEXT attribute.
|
void |
setParentNode(handle newParent)
Sets its parent node.
|
void |
setSelected(logical selected)
Sets the new logical value of its SELECTED property.
|
void |
setSelectedNodeIcon(BaseDataType imageId)
Setter for the SelectedImage attribute.
|
void |
setSelectedNodeIcon(NumberType imageId)
Setter for the SelectedImage attribute.
|
void |
setTag(character tag)
Sets node TAG attribute.
|
void |
setTreeNodeValue(character value)
Setter for the TREE-NODE-VALUE attribute.
|
id, id, unknown, valid
isChecked, setChecked, setChecked
integer getNodeId()
character getNodeKey()
void setNodeKey(character newKey)
newKey
- The node keycharacter getNodeText()
void setNodeText(character value)
value
- the new attribute value.handle getNodeParent()
character getTreeNodeValue()
void setTreeNodeValue(character value)
value
- the new attribute value.logical isNodeExpanded()
void setNodeExpanded(logical value)
value
- the new attribute value.integer getNodeIndex()
integer getNodeIcon()
void setNodeIcon(NumberType imageId)
TreeFace.createImage(character)
or built-in image ids can
be used. For more details see TreeFace.createSubNode(com.goldencode.p2j.util.NumberType, com.goldencode.p2j.util.character, com.goldencode.p2j.util.character, com.goldencode.p2j.util.logical, com.goldencode.p2j.util.NumberType, com.goldencode.p2j.util.NumberType, com.goldencode.p2j.util.integer)
. If ImageList is used by
this node tree, then imageId means 1-based index of this image within its image list.imageId
- the attribute value.void setNodeIcon(BaseDataType imageId)
TreeFace.createImage(character)
or built-in image ids can
be used. For more details see TreeFace.createSubNode(com.goldencode.p2j.util.NumberType, com.goldencode.p2j.util.character, com.goldencode.p2j.util.character, com.goldencode.p2j.util.logical, com.goldencode.p2j.util.NumberType, com.goldencode.p2j.util.NumberType, com.goldencode.p2j.util.integer)
.imageId
- the attribute value.integer getSelectedNodeIcon()
void setSelectedNodeIcon(NumberType imageId)
imageId
- The attribute value.void setSelectedNodeIcon(BaseDataType imageId)
imageId
- The attribute value.integer getExpandNodeIcon()
void setExpandNodeIcon(NumberType imageId)
TreeFace.createImage(character)
or built-in image ids can be used. For more details see
TreeFace.createSubNode(com.goldencode.p2j.util.NumberType, com.goldencode.p2j.util.character, com.goldencode.p2j.util.character, com.goldencode.p2j.util.logical, com.goldencode.p2j.util.NumberType, com.goldencode.p2j.util.NumberType, com.goldencode.p2j.util.integer)
.imageId
- the attribute value.void setExpandNodeIcon(BaseDataType imageId)
TreeFace.createImage(character)
or built-in image ids can be used. For more details see
TreeFace.createSubNode(com.goldencode.p2j.util.NumberType, com.goldencode.p2j.util.character, com.goldencode.p2j.util.character, com.goldencode.p2j.util.logical, com.goldencode.p2j.util.NumberType, com.goldencode.p2j.util.NumberType, com.goldencode.p2j.util.integer)
.imageId
- the attribute value.character getFullPath()
handle getParentNode()
void setParentNode(handle newParent)
newParent
- the new parent nodehandle getChildNode()
handle getPreviousNode()
handle getNextNode()
handle getFirstSiblingNode()
handle getLastSiblingNode()
integer getTreeNodeIndex()
logical isSelected()
void setSelected(logical selected)
selected
- The new value to set, TRUE indicates the node is selected, FALSE that it is not.TreeNodeEntry.EditorMode getEditorMode()
void setEditorMode(TreeNodeEntry.EditorMode editorMode)
editorMode
- The new editor stateinteger getChildren()
void ensureVisible()
boolean isBold()
void setBold(logical bold)
bold
- the new attribute statecharacter getTag()
void setTag(character tag)
tag
- the new attribute statelogical isVisible()