hu.kazocsaba.imageviewer

Class ImageSequenceViewer

java.lang.Object

hu.kazocsaba.imageviewer.ImageSequenceViewer

public class ImageSequenceViewer
extends Object

A component for displaying a series of images. Supports paging through GUI as well as setting the current position via function setPosition(int). When the position is changed, the positionChanged() method is called. Subclasses should override this method to update the image according to the new position.

Author:

Kazó Csaba

Constructor Summary

Constructors

Constructor and Description
ImageSequenceViewer(int number) Creates a new sequence viewer that can display the specified number of images.
ImageSequenceViewer(int number, int startPos) Creates a new sequence viewer that can display the specified number of images.

Method Summary

Methods

Modifier and Type	Method and Description
protected JComponent	createLocationDefinition() Creates and returns the component that displays the current position to the user.
JComponent	getComponent() Returns the Swing component for this sequence viewer.
ImageViewer	getImageViewer()
int	getPosition() Returns the current position of this image sequence shower.
protected void	positionChanged() Called when the current position of the viewer has changed.
void	setPosition(int pos) Sets the position of the viewer.
protected void	updateLocationDefinition(int pos) Called when the current position changes to update the location component.

Methods inherited from class java.lang.Object

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

Constructor Detail

ImageSequenceViewer

public ImageSequenceViewer(int number)

Creates a new sequence viewer that can display the specified number of images.

Parameters:

number - the number of images

Throws:

IllegalArgumentException - if the number is negative

ImageSequenceViewer

public ImageSequenceViewer(int number,
                   int startPos)

Creates a new sequence viewer that can display the specified number of images.

Parameters:

number - the number of images

startPos - the initial position of the viewer

Throws:

IllegalArgumentException - if the number is negative or the starting position is not valid

Method Detail

getComponent

public JComponent getComponent()

Returns the Swing component for this sequence viewer.

Returns:

the component

positionChanged

protected void positionChanged()

Called when the current position of the viewer has changed. The default implementation does nothing. Subclasses should override this method to update the image.

This method is not called from the constructor, but it is called before the viewer is made visible, so subclasses can safely use this method to set the initial image.

getImageViewer

public ImageViewer getImageViewer()

setPosition

public void setPosition(int pos)

Sets the position of the viewer.

Parameters:

pos - the new position of the viewer

Throws:

IllegalArgumentException - if the position is not valid

getPosition

public int getPosition()

Returns the current position of this image sequence shower.

createLocationDefinition

protected JComponent createLocationDefinition()

Creates and returns the component that displays the current position to the user. The default implementation creates a JLabel.

Returns:

the location component

updateLocationDefinition

protected void updateLocationDefinition(int pos)

Called when the current position changes to update the location component.

Parameters:

pos - the current position