au.com.southsky.jfreesane

Class ScanListenerAdapter

java.lang.Object

au.com.southsky.jfreesane.ScanListenerAdapter

All Implemented Interfaces:

ScanListener

public class ScanListenerAdapter
extends java.lang.Object
implements ScanListener

A no-op implementation of ScanListener. You may extend this subclass and provide implementations of methods corresponding to events of interest to you.

Constructor Summary

Constructors

Constructor and Description
ScanListenerAdapter()

Method Summary

Modifier and Type	Method and Description
void	frameAcquisitionStarted(SaneDevice device, au.com.southsky.jfreesane.SaneParameters parameters, int currentFrame, int likelyTotalFrames) Called once frame acquisition has begun.
void	recordRead(SaneDevice device, int totalBytesRead, int imageSize) Called once for each record in a frame.
void	scanningFinished(SaneDevice device) Called once the current page is done.
void	scanningStarted(SaneDevice device) Called once scanning has begun.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScanListenerAdapter

public ScanListenerAdapter()

Method Detail

scanningStarted

public void scanningStarted(SaneDevice device)

Description copied from interface: ScanListener

Called once scanning has begun.

Specified by:

scanningStarted in interface ScanListener

Parameters:

device - the device that is now acquiring an image

frameAcquisitionStarted

public void frameAcquisitionStarted(SaneDevice device,
                                    au.com.southsky.jfreesane.SaneParameters parameters,
                                    int currentFrame,
                                    int likelyTotalFrames)

Description copied from interface: ScanListener

Called once frame acquisition has begun. Typically there is one frame per page, but in older three-pass color scanners (where one scan pass is made for each color) this method will be called three times during a successful scan.

Specified by:

frameAcquisitionStarted in interface ScanListener

Parameters:

device - the device that is acquiring the frame

parameters - the parameters of the acquisition

currentFrame - the zero-based index of the frame in the current scan (normally 0, but will be 0, 1 and 2 in successive calls for three-pass scanners)

likelyTotalFrames - the number of frames that are likely to be received in this scan. JFreeSane cannot know this for sure, so the number should not be relied upon for program correctness

recordRead

public void recordRead(SaneDevice device,
                       int totalBytesRead,
                       int imageSize)

Description copied from interface: ScanListener

Called once for each record in a frame. A frame may consist of many records.

Specified by:

recordRead in interface ScanListener

Parameters:

device - the device that acquired the record

totalBytesRead - the number of bytes read so far in this frame

imageSize - the total number of bytes in the frame. When this cannot be known in advance, this will be set to -1 (e.g. the scanner is a hand-held scanner or uses page height detection)

scanningFinished

public void scanningFinished(SaneDevice device)

Description copied from interface: ScanListener

Called once the current page is done.

Specified by:

scanningFinished in interface ScanListener

Parameters:

device - the device that is now finished acquiring a page