public abstract class FunctionalUnit extends DeviceItem
Modifier and Type | Class and Description |
---|---|
static class |
FunctionalUnit.BitDepth
Bit depth.
|
static class |
FunctionalUnit.Duplex
Duplex mode for automatic document feeding
|
static class |
FunctionalUnit.FileFormat
Image file formats.
|
static class |
FunctionalUnit.Mode
Scanning performance mode
|
static class |
FunctionalUnit.OutputFormat
Output image format
|
static class |
FunctionalUnit.PixelDataType
Pixel data type - color, grayscale and black/white, etc.
|
static class |
FunctionalUnit.PropertyBuilder
Builder for configuring scan properties.
|
static class |
FunctionalUnit.TiffCompression
TIFF compression schemes
|
Modifier and Type | Field and Description |
---|---|
static String |
PROP_ADF
Whether multiple-scanning (ADF) is enabled
|
static String |
PROP_JPEG_QUALITY
Specifies JPEG image quality (0 ~ 100].
|
static String |
PROP_MODE
Specifies scan performance mode: FunctionalUnit.Mode.HIGH_SPEED or FunctionalUnit.Mode.NORMAL
|
static String |
PROP_OUTPUT_FORMAT
Specifies output image format.
|
static String |
PROP_TIFF_COMPRESSION
Specifies TIFF compression scheme
|
Modifier and Type | Method and Description |
---|---|
abstract FunctionalUnit.BitDepth |
getBitDepth() |
abstract long |
getBrightness() |
abstract long |
getContrast() |
Device |
getDevice()
Device that owns this functional unit.
|
abstract FunctionalUnit.Duplex |
getDuplex() |
abstract FunctionalUnit.PixelDataType |
getPixelDataType() |
abstract long |
getResolution() |
abstract boolean |
isDocumentFeeder()
Whether this is a document feeder
|
abstract boolean |
isFlatbed()
Whether this is a flatbed
|
abstract void |
scan(ScanListener listener,
String properties)
Performs single or multi-page ADF scan.
|
void |
scanOnePage(File file,
ScanProgressListener progressListener,
String properties)
Scans one page into the target file.
|
void |
scanOnePage(OutputStream output,
ScanProgressListener listener,
String properties)
Scans one page to the target output stream.
|
abstract void |
setBitDepth(FunctionalUnit.BitDepth bitDepth) |
abstract void |
setBrightness(long brightness) |
abstract void |
setContrast(long contrast) |
abstract void |
setDuplex(FunctionalUnit.Duplex duplex) |
abstract void |
setPaperSize(PaperSize paperSize) |
abstract void |
setPixelDataType(FunctionalUnit.PixelDataType dataType) |
abstract void |
setResolution(long resolution) |
String |
toString() |
abstract String |
toString(boolean verbose,
boolean withCapabilities)
String representation of this functional unit.
|
close, getCapabilities, getCapability, getCapabilityCurrentValueAsLong, getCapabilityCurrentValueAsString, getCapabilityValue, getCapabilityValueAsLong, getCapabilityValueAsString, getDescription, getId, getName, isCapabilityDirty, refreshCapabilities, setCapabilityDirty, setCapabilityValue
public static final String PROP_ADF
public static final String PROP_OUTPUT_FORMAT
public static final String PROP_TIFF_COMPRESSION
public static final String PROP_JPEG_QUALITY
public static final String PROP_MODE
public Device getDevice()
public abstract boolean isFlatbed()
public abstract boolean isDocumentFeeder()
public abstract void scan(ScanListener listener, String properties) throws ScanException
listener
- to supply output target and to get notification.properties
- scan properties, you may use FunctionalUnit.PropertyBuilder to build.ScanException
public void scanOnePage(File file, ScanProgressListener progressListener, String properties) throws ScanException
file
- progressListener
- optional listener to be notified about progress.properties
- scan properties, you may use FunctionalUnit.PropertyBuilder to build.ScanException
public void scanOnePage(OutputStream output, ScanProgressListener listener, String properties) throws ScanException
output
- listener
- optional listener to be notified about progress.properties
- scan properties, you may use FunctionalUnit.PropertyBuilder to build.ScanException
public abstract FunctionalUnit.PixelDataType getPixelDataType()
public abstract void setPixelDataType(FunctionalUnit.PixelDataType dataType)
public abstract FunctionalUnit.BitDepth getBitDepth()
public abstract void setBitDepth(FunctionalUnit.BitDepth bitDepth)
public abstract long getResolution()
public abstract void setResolution(long resolution)
public abstract long getContrast()
public abstract void setContrast(long contrast)
public abstract long getBrightness()
public abstract void setBrightness(long brightness)
public abstract void setPaperSize(PaperSize paperSize)
public abstract FunctionalUnit.Duplex getDuplex()
public abstract void setDuplex(FunctionalUnit.Duplex duplex)
public abstract String toString(boolean verbose, boolean withCapabilities)
Copyright © Asprise Software. All Rights Reserved. Please visit the product page at asprise.com