edu.jhu.tmaj.client.image.data
Class Navigator

java.lang.Object
  edu.jhu.tmaj.client.image.data.Navigator

public final class Navigator
extends java.lang.Object

A class that controls which ArrayImages are seen (as well as the order) when the user clicks the "Next" and "Back" buttons.

Constructor Summary

Navigator()

Method Summary

ArrayImageCell	getBack(ArrayImageCell currentArrayImage, boolean isRandom) Returns the last ArrayImage in this navigation sequence.
ArrayImageCell	getDown(ArrayImageCell currentArrayImage) Returns the ArrayImage that is directory below currentArrayImage in the ArraySlide.
ArrayImageCell	getNext(ArrayImageCell currentArrayImage, boolean isRandom) Returns the next ArrayImage in this navigation sequence.
ArrayImageCell	getUp(ArrayImageCell currentArrayImage) Returns the ArrayImage that is directory above currentArrayImage in the ArraySlide.
void	initialize(ArrayImageCollectionBean arrayImageCollectionBean) Initializes the navigator by setting the the ArrayImageCollectionBean
static boolean	isArrayImageIncluded(ArrayImageCell arrayImage) Returns true if the ArrayImage should be included in the navigator.
void	reset() Recalculates the ArrayImage sequence.
void	setSpecifiedArrayImagesList(java.util.List<ArrayImageCell> arrayImagesList)

Methods inherited from class java.lang.Object

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

Constructor Detail

Navigator

public Navigator()

Method Detail

reset

public void reset()

Recalculates the ArrayImage sequence. A filter, for example, may have changed the images the user wishes to see when the next and back buttons are pressed.

initialize

public void initialize(ArrayImageCollectionBean arrayImageCollectionBean)

Initializes the navigator by setting the the ArrayImageCollectionBean

setSpecifiedArrayImagesList

public void setSpecifiedArrayImagesList(java.util.List<ArrayImageCell> arrayImagesList)

getBack

public ArrayImageCell getBack(ArrayImageCell currentArrayImage,
                              boolean isRandom)
                       throws NoArrayImageException

Returns the last ArrayImage in this navigation sequence.

Throws:

NoArrayImageException

getNext

public ArrayImageCell getNext(ArrayImageCell currentArrayImage,
                              boolean isRandom)
                       throws NoArrayImageException

Returns the next ArrayImage in this navigation sequence.

Throws:

NoArrayImageException

getUp

public ArrayImageCell getUp(ArrayImageCell currentArrayImage)

Returns the ArrayImage that is directory above currentArrayImage in the ArraySlide.

getDown

public ArrayImageCell getDown(ArrayImageCell currentArrayImage)

Returns the ArrayImage that is directory below currentArrayImage in the ArraySlide.

isArrayImageIncluded

public static boolean isArrayImageIncluded(ArrayImageCell arrayImage)

Returns true if the ArrayImage should be included in the navigator. If the image is not included in this navigator, it will be simply skipped when the user presses the next and back buttons.