com.klg.jclass.higrid
Class HeaderTipWalk

java.lang.Object
  |
  +--com.klg.jclass.higrid.HeaderTipWalk

All Implemented Interfaces:

Serializable, Walkable

public class HeaderTipWalk

extends Object

implements Walkable

The HeaderTipWalk class is used as a container of information during recursive searches of the RowTree. It is used to determine whether a headerTip should be displayed.

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.klg.jclass.higrid.Walkable

serialVersionUID

Constructor Summary

HeaderTipWalk(com.klg.jclass.higrid.RowNode topRowNode, com.klg.jclass.higrid.RowNode startRowNode, int rowTipDisplay)

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.
boolean	shouldDisplay()

Methods inherited from class java.lang.Object

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

Constructor Detail

HeaderTipWalk

public HeaderTipWalk(com.klg.jclass.higrid.RowNode topRowNode,
                     com.klg.jclass.higrid.RowNode startRowNode,
                     int rowTipDisplay)

Method Detail

getDownward

public boolean getDownward()

Description copied from interface: Walkable

Return true if walking downward, false if walking upward.

Specified by:

getDownward in interface Walkable

done

public boolean done()

Description copied from interface: Walkable

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.

Specified by:

done in interface Walkable

next

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

Description copied from interface: Walkable

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

Specified by:

next in interface Walkable

Parameters:

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

previous

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

Description copied from interface: Walkable

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

Specified by:

previous in interface Walkable

Parameters:

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

find

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

Description copied from interface: Walkable

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

Specified by:

find in interface Walkable

Parameters:

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

shouldDisplay

public boolean shouldDisplay()