com.plumtree.uiinfrastructure.tree
Class TreeCompositeIterator

java.lang.Object
  com.plumtree.uiinfrastructure.tree.TreeCompositeIterator

All Implemented Interfaces:

ITreeIterator

public class TreeCompositeIterator
extends java.lang.Object
implements ITreeIterator

This iterator is used for walking through the tree. The GetBase* methods should always be valid, but the GetCurrent* methods are only valid after MoveToNextCompositeChild() has been called and has returned true.

Author:

Don Hayler

Constructor Summary

TreeCompositeIterator(TreeCompositeNode root, AActivitySpace asOwner)
Constructor for iterator

Method Summary

boolean	GetBaseBrowsableOnly()
int	GetBaseClassID()
int	GetBaseCompositeChildCount()
java.lang.String	GetBaseDescription()
boolean	GetBaseDisabled()
java.lang.String	GetBaseEncodedName()
boolean	GetBaseExpanded()
boolean	GetBaseForceSelectable()
HTMLImg	GetBaseImage() This method returns the current image.
int	GetBaseLeafChildCount() This method returns the number of leaf child nodes of the root node.
TreeLeafIterator	GetBaseLeafChildIterator() This method returns an iterator to the leaf child nodes of the root node.
java.lang.String	GetBaseLocation()
int	GetBaseObjectID()
boolean	GetBaseSelected()
int	GetBaseTreeNodeID()
int	GetCurrentClassID()
TreeCompositeIterator	GetCurrentCompositeChildIterator()
boolean	GetCurrentDisabled()
java.lang.String	GetCurrentEncodedName() Returns the encoded and truncated name.
boolean	GetCurrentExpanded()
boolean	GetCurrentForceSelectable()
HTMLImg	GetCurrentImage() This method returns the current image.
java.lang.String	GetCurrentLocation()
int	GetCurrentObjectID()
boolean	GetCurrentSelected()
int	GetCurrentTreeNodeID()
boolean	MoveToNextCompositeChild() Moves to the next composite child.

Methods inherited from class java.lang.Object

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

Constructor Detail

TreeCompositeIterator

public TreeCompositeIterator(TreeCompositeNode root,
                             AActivitySpace asOwner)

Constructor for iterator

Parameters:

TreeCompositeNode - the root node of this iterator

AActivitySpace - asOwner the space that this tree is in (used to get default localized strings)

Method Detail

GetBaseClassID

public int GetBaseClassID()

Returns:

GetBaseDisabled

public boolean GetBaseDisabled()

Returns:

GetBaseBrowsableOnly

public boolean GetBaseBrowsableOnly()

Returns:

GetBaseExpanded

public boolean GetBaseExpanded()

Returns:

GetBaseForceSelectable

public boolean GetBaseForceSelectable()

Returns:

GetBaseImage

public HTMLImg GetBaseImage()

This method returns the current image. This will automatically handle open and closed images.

Returns:

HTMLImg the current image

GetBaseLeafChildIterator

public TreeLeafIterator GetBaseLeafChildIterator()

This method returns an iterator to the leaf child nodes of the root node.

Returns:

iterator to the leaf children of the root node.

GetBaseLeafChildCount

public int GetBaseLeafChildCount()

This method returns the number of leaf child nodes of the root node.

Returns:

the number of leaf children of the root node.

GetBaseCompositeChildCount

public int GetBaseCompositeChildCount()

GetBaseLocation

public java.lang.String GetBaseLocation()

Returns:

GetBaseEncodedName

public java.lang.String GetBaseEncodedName()

Returns:

GetBaseDescription

public java.lang.String GetBaseDescription()

Returns:

GetBaseObjectID

public int GetBaseObjectID()

Returns:

GetBaseSelected

public boolean GetBaseSelected()

Returns:

GetBaseTreeNodeID

public int GetBaseTreeNodeID()

Returns:

GetCurrentClassID

public int GetCurrentClassID()

Specified by:

GetCurrentClassID in interface ITreeIterator

Returns:

GetCurrentCompositeChildIterator

public TreeCompositeIterator GetCurrentCompositeChildIterator()

Returns:

GetCurrentDisabled

public boolean GetCurrentDisabled()

Returns:

GetCurrentExpanded

public boolean GetCurrentExpanded()

Returns:

GetCurrentForceSelectable

public boolean GetCurrentForceSelectable()

Specified by:

GetCurrentForceSelectable in interface ITreeIterator

Returns:

GetCurrentImage

public HTMLImg GetCurrentImage()

This method returns the current image. This will automatically handle open and closed images.

Specified by:

GetCurrentImage in interface ITreeIterator

Returns:

HTMLImg the current image

GetCurrentLocation

public java.lang.String GetCurrentLocation()

Returns:

GetCurrentEncodedName

public java.lang.String GetCurrentEncodedName()

Description copied from interface: ITreeIterator

Returns the encoded and truncated name.

Specified by:

GetCurrentEncodedName in interface ITreeIterator

Returns:

GetCurrentObjectID

public int GetCurrentObjectID()

Specified by:

GetCurrentObjectID in interface ITreeIterator

Returns:

GetCurrentSelected

public boolean GetCurrentSelected()

Specified by:

GetCurrentSelected in interface ITreeIterator

Returns:

GetCurrentTreeNodeID

public int GetCurrentTreeNodeID()

Specified by:

GetCurrentTreeNodeID in interface ITreeIterator

Returns:

MoveToNextCompositeChild

public boolean MoveToNextCompositeChild()

Moves to the next composite child.

Returns:

boolean false if there are no more composite children.