Plumtree UI Infrastructure API  
 

TreeCompositeNode Members

TreeCompositeNode overview

Public Instance Constructors

TreeCompositeNode Constructor Creates a new TreeCompositeNode object. All objects in a folder should have sequential tree ids.

Public Instance Fields

m_bBrowsableOnly true implies browsable but not selectable
m_bChildrenLoaded Have the children of this node been loaded?
m_bDisabled Neither browsable nor selectable
m_bExpanded Is this folder expanded
m_bForceSelectable (inherited from TreeLeafNode) Whether or not to override the normal selectable logic and force this node to be selectable. true implies this node should be selectable no matter what.
m_bMultiplyInstanced (inherited from TreeLeafNode) Whether or not this node can be simultaneously located in multiple places. true implies there can be more than one instance of the object this node points to in the same tree. N.B. Multiply instanced items must use unique class ID / object ID pairs (per item, not per instance).
m_bSelected (inherited from TreeLeafNode) Whether or not this node is selected.
m_Image (inherited from TreeLeafNode) The default image for this object. For a composite node, this will be the closed image (the composite node will store the open image).
m_nClassID (inherited from TreeLeafNode) 
m_nObjectID (inherited from TreeLeafNode) 
m_nTreeNodeID (inherited from TreeLeafNode) unique internal ID for this node
m_OpenImage The image when the container is open
m_strLocation (inherited from TreeLeafNode) 

Public Instance Methods

AddCompositeChild 
AddLeafChild 
ClearSelected 
Equals (inherited from Object)Determines whether the specified Object is equal to the current Object.
GetCompositeChildIterator 
GetDescription (inherited from TreeLeafNode) This method returns the description of the node (HTMLEncoded). If there is no description, it returns the name.
GetEncodedName (inherited from TreeLeafNode) This method returns the name of the node (truncated to 50 characters and HTMLEncoded). The name is stored truncated and encoded, so this method is fast. Tracing should use this method, even though it does not need to encode the name.
GetHashCode (inherited from Object)Serves as a hash function for a particular type. GetHashCode is suitable for use in hashing algorithms and data structures like a hash table.
GetLeafChildCount This method calculates how many leaf children this node contains.
GetLeafChildIterator 
GetName (inherited from TreeLeafNode) This method returns the name of the node (truncated to 50 characters). This method unencodes the stored encoded name, so it should only be used when retrieving the final tree selections. Tracing should use the GetEncodedName method.
GetNodeOverloaded.  
GetType (inherited from Object)Gets the Type of the current instance.
RemoveCompositeChild 
RemoveLeafChild 
SetDescription (inherited from TreeLeafNode) This method sets the description of the node and HTMLEncodes it. This will ignore the description if it is null or the empty string.
SetName (inherited from TreeLeafNode) This method sets the name of the node, truncates it to 50 characters, and HTMLEncodes it. This also sets the description to the full name, if there is no description set.
SetNameAndDescription (inherited from TreeLeafNode) This method sets the name and description of the node by copying the truncated and encoded versions from the node.
SetSelected This method searches the entire tree for nodes with the classID and objectID and sets them to selected. This should only be used for multiply instanced nodes.
ToString (inherited from Object)Returns a String that represents the current Object.

Protected Instance Methods

Finalize (inherited from Object)Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
MemberwiseClone (inherited from Object)Creates a shallow copy of the current Object.

See Also

TreeCompositeNode Class | com.plumtree.uiinfrastructure.tree Namespace