com.plumtree.uiinfrastructure.tree
Class TreeLeafIterator

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

All Implemented Interfaces:

ITreeIterator

public class TreeLeafIterator
extends java.lang.Object
implements ITreeIterator

This iterator is used for walking through the tree. The GetGetCurrent* methods are only valid after MoveToNextChild() has been called and has returned true.

Author:

Don Hayler

Constructor Summary

TreeLeafIterator(IXPEnumerator children, AActivitySpace asOwner)
Constructor for iterator

Method Summary

int	GetCurrentClassID()
java.lang.String	GetCurrentDescription()
java.lang.String	GetCurrentEncodedName() Returns the encoded and truncated name.
boolean	GetCurrentForceSelectable()
HTMLImg	GetCurrentImage() This method returns the current image.
java.lang.String	GetCurrentLocation()
int	GetCurrentObjectID()
boolean	GetCurrentSelected()
int	GetCurrentTreeNodeID()
boolean	MoveToNextChild() Moves to the next child.

Methods inherited from class java.lang.Object

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

Constructor Detail

TreeLeafIterator

public TreeLeafIterator(IXPEnumerator children,
                        AActivitySpace asOwner)

Constructor for iterator

Parameters:

IXPEnumerator - the child nodes for this iterator

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

Method Detail

GetCurrentClassID

public int GetCurrentClassID()

Specified by:

GetCurrentClassID in interface ITreeIterator

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:

GetCurrentDescription

public java.lang.String GetCurrentDescription()

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:

MoveToNextChild

public boolean MoveToNextChild()

Moves to the next child.

Returns:

boolean false if there are no more children.