com.klg.jclass.higrid
Interface Walkable

All Superinterfaces:

Serializable

All Known Implementing Classes:

HeaderTipWalk, LastRowWalk, LastVisibleRowWalk

public interface Walkable

extends Serializable

The Walkable interface should be implemented by objects that wish to traverse HiGrid's RowTree. The walk() method within RowTree class takes as arguments an initial rowNode to start walking from and a Walkable object that controls when the walking is to finish. You can use your Walkable object to store state information that you can examine after the walk has completed.

Field Summary

static long

serialVersionUID

Method Summary

boolean	done() Return true if the walk has met its terminating condition.
boolean	find(com.klg.jclass.higrid.RowNode rowNode) find() is invoked by the walk() routine to test whether the passed rowNode meets the walk termination criteria.
boolean	getDownward() Return true if walking downward, false if walking upward.
void	next(com.klg.jclass.higrid.RowNode rowNode) next() is invoked when the walk() routine moves to the next RowNode.
void	previous(com.klg.jclass.higrid.RowNode rowNode) previous() is invoked when the walk() routine moves to the previous RowNode.

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Method Detail

getDownward

public boolean getDownward()

Return true if walking downward, false if walking upward.

done

public boolean done()

Return true if the walk has met its terminating condition. If this method never returns true, an infinite loop will result when RowTree.walk() is invoked.

next

public void next(com.klg.jclass.higrid.RowNode rowNode)

next() is invoked when the walk() routine moves to the next RowNode.

Parameters:

rowNode - The rowNode that the walk() routine has traversed to.

previous

public void previous(com.klg.jclass.higrid.RowNode rowNode)

previous() is invoked when the walk() routine moves to the previous RowNode.

Parameters:

rowNode - The rowNode that the walk() routine has traversed to.

find

public boolean find(com.klg.jclass.higrid.RowNode rowNode)

find() is invoked by the walk() routine to test whether the passed rowNode meets the walk termination criteria.

Parameters:

rowNode - The rowNode that the walk() routine has traversed to and is checking for termination.