com.plumtree.uiinfrastructure.tree
Class TreeCompositeNode

java.lang.Object
  com.plumtree.uiinfrastructure.tree.TreeLeafNode
      com.plumtree.uiinfrastructure.tree.TreeCompositeNode

public class TreeCompositeNode
extends TreeLeafNode

This class represents composite nodes in the tree such as folders, or browseable groups.

Author:

Don Hayler

Field Summary

boolean	m_bBrowsableOnly true implies browsable but not selectable
boolean	m_bChildrenLoaded Have the children of this node been loaded?
boolean	m_bDisabled Neither browsable nor selectable
boolean	m_bExpanded Is this folder expanded
HTMLImg	m_OpenImage The image when the container is open

Fields inherited from class com.plumtree.uiinfrastructure.tree.TreeLeafNode

m_bForceSelectable, m_bMultiplyInstanced, m_bSelected, m_Image, m_nClassID, m_nObjectID, m_nTreeNodeID, m_strLocation

Constructor Summary

TreeCompositeNode(int nTreeNodeID)
Creates a new TreeCompositeNode object.

Method Summary

void	AddCompositeChild(TreeCompositeNode child)
void	AddLeafChild(TreeLeafNode child)
void	ClearSelected(boolean bVisibleOnly, boolean bRecursive)
int	GetCompositeChildCount() This method calculates how many composite children this node contains
IXPEnumerator	GetCompositeChildIterator()
int	GetLeafChildCount() This method calculates how many leaf children this node contains.
IXPEnumerator	GetLeafChildIterator()
TreeLeafNode	GetNode(int nNodeID)
TreeLeafNode	GetNode(int nClassID, int nObjectID)
TreeLeafNode	GetNode(java.lang.String strLocation) Note: This function compares the location to get the node
void	RemoveCompositeChild(TreeCompositeNode child)
void	RemoveLeafChild(TreeLeafNode child)
void	SetSelected(int nClassID, int nObjectID) This method searches the entire tree for nodes with the classID and objectID and sets them to selected.

Methods inherited from class com.plumtree.uiinfrastructure.tree.TreeLeafNode

GetDescription, GetEncodedName, GetName, SetDescription, SetName, SetNameAndDescription

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

m_OpenImage

public HTMLImg m_OpenImage

The image when the container is open

m_bChildrenLoaded

public boolean m_bChildrenLoaded

Have the children of this node been loaded?

m_bDisabled

public boolean m_bDisabled

Neither browsable nor selectable

m_bBrowsableOnly

public boolean m_bBrowsableOnly

true implies browsable but not selectable

m_bExpanded

public boolean m_bExpanded

Is this folder expanded

Constructor Detail

TreeCompositeNode

public TreeCompositeNode(int nTreeNodeID)

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

Parameters:

int - internal ID of this node

Method Detail

AddCompositeChild

public void AddCompositeChild(TreeCompositeNode child)

Parameters:

child -

RemoveCompositeChild

public void RemoveCompositeChild(TreeCompositeNode child)

Parameters:

child -

AddLeafChild

public void AddLeafChild(TreeLeafNode child)

Parameters:

child -

RemoveLeafChild

public void RemoveLeafChild(TreeLeafNode child)

Parameters:

child -

ClearSelected

public void ClearSelected(boolean bVisibleOnly,
                          boolean bRecursive)

GetCompositeChildIterator

public IXPEnumerator GetCompositeChildIterator()

Returns:

GetLeafChildIterator

public IXPEnumerator GetLeafChildIterator()

Returns:

GetLeafChildCount

public int GetLeafChildCount()

This method calculates how many leaf children this node contains.

Returns:

the number of leaf children in this node.

GetCompositeChildCount

public int GetCompositeChildCount()

This method calculates how many composite children this node contains

Returns:

the number if composite children in this node.

GetNode

public TreeLeafNode GetNode(int nNodeID)

Parameters:

nNodeID -

Returns:

GetNode

public TreeLeafNode GetNode(int nClassID,
                            int nObjectID)

Parameters:

nClassID -

nObjectID -

Returns:

GetNode

public TreeLeafNode GetNode(java.lang.String strLocation)

Note: This function compares the location to get the node

Parameters:

nClassID -

nObjectID -

Returns:

SetSelected

public void SetSelected(int nClassID,
                        int nObjectID)

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.