public class Imaging
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
EXIF_NAME_Copyright
Limit length to max 20
|
static java.lang.String |
EXIF_NAME_DocumentName |
static java.lang.String |
EXIF_NAME_EquipMake |
static java.lang.String |
EXIF_NAME_EquipModel |
static java.lang.String |
EXIF_NAME_ImageDescription |
static java.lang.String |
EXIF_NAME_UserComment |
static java.lang.String |
FORMAT_BMP |
static java.lang.String |
FORMAT_JPG |
static java.lang.String |
FORMAT_PDF |
static java.lang.String |
FORMAT_PNG |
static java.lang.String |
FORMAT_TIF |
static int |
LOG_LEVEL_DEBUG |
static int |
LOG_LEVEL_ERROR |
static int |
LOG_LEVEL_INFO
Info: the default.
|
static int |
LOG_LEVEL_OFF
Turn of logging
|
static int |
LOG_LEVEL_WARN |
static java.lang.String |
LOG_TO_STDERR |
static java.lang.String |
LOG_TO_STDOUT |
static java.lang.String |
OUTPUT_RETURN_BASE64 |
static java.lang.String |
OUTPUT_RETURN_BASE64_THUMB |
static java.lang.String |
OUTPUT_RETURN_HANDLE |
static java.lang.String |
OUTPUT_RETURN_HANDLE_THUMB |
static java.lang.String |
OUTPUT_SAVE |
static java.lang.String |
OUTPUT_SAVE_THUMB |
static java.lang.String |
OUTPUT_UPLOAD |
static java.lang.String |
OUTPUT_UPLOAD_THUMB |
static java.lang.String |
SYSTEM_INFO_DEFAULT_PAPER_SIZE
Default paper size: letter | legal | a3 | a4
|
static java.lang.String |
SYSTEM_INFO_GEO_NATION_ID
User geo id of nation, e.g, 244; result of GetUserGeoID(GEOCLASS_NATION)
|
static java.lang.String |
SYSTEM_INFO_GEO_NATION_NAME
User geo name of nation, e.g, 'US; United States'; result of GetUserGeoID(GEOCLASS_NATION)
|
static java.lang.String |
SYSTEM_INFO_GEO_REGION_ID
User geo id of region; result of GetUserGeoID(GEOCLASS_REGION)
|
static java.lang.String |
SYSTEM_INFO_GEO_REGION_NAME
User geo id of region; result of GetUserGeoID(GEOCLASS_REGION)
|
static java.lang.String |
SYSTEM_INFO_MEASUREMENT_SYSTEM
Measurement system: metric | us
|
static java.lang.String |
SYSTEM_INFO_OS
Operating system name.
|
static java.lang.String |
SYSTEM_INFO_OS_LANG_CODE
the language of the installed OS, e.g, 'en_US'; result of GetUserDefaultLangID()
|
static java.lang.String |
SYSTEM_INFO_OS_LANG_ID
the language of the installed OS, e.g, 1033; result of GetUserDefaultLangID()
|
static java.lang.String |
SYSTEM_INFO_TIMEZONE_BIAS
TIME_ZONE_INFORMATION.Bias: bias in minutes for local time translation.
|
static java.lang.String |
SYSTEM_INFO_TIMEZONE_NAME
TIME_ZONE_INFORMATION.DaylightName or TIME_ZONE_INFORMATION.StandardName or null depending on tz type.
|
static java.lang.String |
SYSTEM_INFO_TIMEZONE_TYPE
daylight | standard | <error: ...>; result of GetTimeZoneInformation
|
static java.lang.String |
SYSTEM_INFO_TWAIN_VERSION
TWAIN data source manager version
|
static java.lang.String |
SYSTEM_INFO_USER_DEFAULT_LC_CODE
User's preferred locale code (LCID), e.g, 'en_US'; result of GetUserDefaultLCID()
|
static java.lang.String |
SYSTEM_INFO_USER_DEFAULT_LC_ID
User's preferred locale ID (LCID), e.g, 1033; result of GetUserDefaultLCID()
|
static java.lang.String |
SYSTEM_INFO_USER_DEFAULT_UI_LANG_CODE
User's preferred language ID (LANGID), e.g, 'en_US'; result of GetUserDefaultUILanguage()
|
static java.lang.String |
SYSTEM_INFO_USER_DEFAULT_UI_LANG_ID
User's preferred language ID (LANGID), e.g, 1033; result of GetUserDefaultUILanguage()
|
static java.lang.String |
TIFF_COMPRESSION_CCITT_G3 |
static java.lang.String |
TIFF_COMPRESSION_CCITT_G4 |
static java.lang.String |
TIFF_COMPRESSION_LZW |
static java.lang.String |
TIFF_COMPRESSION_NONE |
static java.lang.String |
TIFF_COMPRESSION_PACKBITS |
static java.lang.String |
TIFF_COMPRESSION_RLE |
static java.lang.String |
TIFF_COMPRESSION_ZIP |
static int |
TWAIN_CONFIG_INVOCATION_ALWAYS_CREATE_NEW_WINDOW |
static int |
TWAIN_CONFIG_INVOCATION_AUTO |
static int |
TWAIN_CONFIG_INVOCATION_REUSE_WINDOW |
static java.lang.String |
TWAIN_CONFIG_system_twain_version |
static java.lang.String |
TWAIN_CONFIG_twain_config_invocation |
static java.lang.String |
TWAIN_CONFIG_twain_config_version |
static java.lang.String |
TWAIN_CONFIG_twain_loaded |
static java.lang.String |
TWAIN_CONFIG_twain_version_in_use |
static int |
TWAIN_CONFIG_VERSION_AUTO |
static int |
TWAIN_CONFIG_VERSION_BUNDLED |
static int |
TWAIN_CONFIG_VERSION_SYSTEM |
Constructor and Description |
---|
Imaging(java.awt.Component owningUI) |
Imaging(java.lang.String appId,
int windowHandle) |
Modifier and Type | Method and Description |
---|---|
static java.lang.String |
callNativeFunc(java.lang.String functionName,
java.lang.Object... args) |
static void |
configureNativeLogging(int level,
java.lang.String logFilePath)
Configure logging settings.
|
Result |
convert(Request request)
Performs image conversion and output (return, save, and/or upload).
|
java.lang.String |
doSelectSourceIfUsingAspriseSelectUI(java.lang.String sourceName)
Performs swing based source selection is sourceName is "select" and swing based source select UI is enabled.
|
static <R> R |
executeInDefaultExecutorServiceAndWaitTillReturn(java.util.concurrent.Callable<R> callable)
Executes and wait indefinitely until the result is returned or exception occurs
|
static java.util.concurrent.ExecutorService |
getDefaultExecutorServiceForScanning()
Use this executor service to make sure that all scanning related code is executed from the same thread.
|
java.util.Map<java.lang.String,java.lang.Object> |
getImageInfo(java.lang.String imageFile)
Get information about the image, e.g.
|
static java.lang.String |
getLibraryBuildInfo()
Gets the current Asprise Scan library build info.
|
static java.lang.String |
getLibraryVersion()
Gets the current Asprise Scan version.
|
static java.lang.String |
getLibraryVersionNumberOnly()
Gets the current Asprise Scan version number.
|
java.lang.String |
getLicense() |
Source |
getSource(java.lang.String sourceName,
boolean nameOnly,
java.lang.String capsToRetrieve,
boolean getCurrent,
boolean detectDeviceType,
java.lang.String capsToSet)
Retrieve the source info optionally with caps.
|
static java.util.Properties |
getSystemInfo()
Gets the system related properties.
|
static java.lang.String |
getSystemInfoUserLocale()
Returns user's preferred locale code, e.g, 'en_US' or null if failed.
|
static java.util.Properties |
getTwainConfig()
Returns TWAIN related properties containing something like:
|
static int |
getTwainConfigInvocation()
Returns the twain invocation mode in use, any of TWAIN_CONFIG_INVOCATION_AUTO
|
static int |
getTwainConfigVersion()
Returns the twain version config, any of TWAIN_CONFIG_VERSION_AUTO
|
static java.lang.String |
getTwainVersionLoaded()
Returns the loaded twain version or null if not loaded
|
static java.lang.String |
getTwainVersionSystem()
Returns the system twain version
|
boolean |
getUseAspriseSourceSelectUI()
Whether to use Asprise Swing based source select UI; default to true.
|
static boolean |
isTwainLoaded()
Whether TWAIN is loaded.
|
java.lang.String |
licRequest(java.lang.String lic) |
static boolean |
loadTwain()
Loads twain_32.dll
|
static void |
main(java.lang.String[] args) |
java.util.Map<java.lang.String,java.lang.Object> |
processImage(java.lang.String inputImageFile,
java.lang.String commands,
java.lang.String outputImageFile)
Performs operations on image, e.g., rotate, crop, scale, gray, etc.
|
void |
resetIt()
Allows ScanServer to reset properly.
|
Result |
scan(Request request,
java.lang.String sourceName,
boolean showUI,
boolean modalUI)
Performs scanning from a device and output (return, save, and/or upload).
|
Result |
scan(java.lang.String scanRequestInJson,
java.lang.String sourceName,
boolean showUI,
boolean modalUI)
Performs scanning from a device and output (return, save, and/or upload).
|
java.lang.String |
scanAndReturnRaw(java.lang.String scanRequestInJson,
java.lang.String sourceName,
boolean showUI,
boolean modalUI)
Performs scanning from a device and output result in JSON.
|
java.lang.String |
scanGetDefaultSourceName()
Gets the name of the default source or null if none presents.
|
java.lang.String |
scanGetLastUsedSourceName()
Gets the name of the last used (at least one page has been scanned from) source or null if it doesn't exist.
|
java.util.List<Source> |
scanListSources()
Lists all sources with names only.
|
java.util.List<Source> |
scanListSources(boolean nameOnly,
java.lang.String capsToRetrieve,
boolean detectDeviceType,
boolean excludeTwainDsOnWia)
Retrieve list of sources (i.e., devices) optionally with caps; the default source has "default": true in JSON format.
|
java.util.List<Source> |
scanListSourcesWithFullDetails()
Retrieve list of sources (i.e., devices) with all caps; the default source has "default": true in JSON format.
|
java.lang.String |
scanSelectDefaultSource()
Prompts system device selection dialog for the user to select the default device.
|
java.lang.String |
scanSelectDefaultSource(java.lang.String defaultSelectedSourceName)
Prompts system device selection dialog for the user to select the default device.
|
java.lang.String |
scanSelectSource()
Select Source using Asprise source selection UI.
|
static void |
setGlobalClientConnectionObj(java.lang.Object clientConnectionObj) |
void |
setI18n(java.util.Properties i18n)
Sets to i18n to be used by ScanSelectUI
|
void |
setLicense(java.lang.String license) |
void |
setOwning(java.awt.Component owningUI) |
static boolean |
setTwainConfig(int version,
int invocation)
Configures TWAIN.
|
Imaging |
setUseAspriseSourceSelectUI(boolean value) |
static boolean |
unloadTwain()
Unloads twain_32.dll
|
public static final int LOG_LEVEL_OFF
public static final int LOG_LEVEL_ERROR
public static final int LOG_LEVEL_WARN
public static final int LOG_LEVEL_INFO
public static final int LOG_LEVEL_DEBUG
public static final java.lang.String LOG_TO_STDOUT
public static final java.lang.String LOG_TO_STDERR
public static final java.lang.String OUTPUT_RETURN_BASE64
public static final java.lang.String OUTPUT_RETURN_BASE64_THUMB
public static final java.lang.String OUTPUT_RETURN_HANDLE
public static final java.lang.String OUTPUT_RETURN_HANDLE_THUMB
public static final java.lang.String OUTPUT_SAVE
public static final java.lang.String OUTPUT_SAVE_THUMB
public static final java.lang.String OUTPUT_UPLOAD
public static final java.lang.String OUTPUT_UPLOAD_THUMB
public static final java.lang.String FORMAT_JPG
public static final java.lang.String FORMAT_PNG
public static final java.lang.String FORMAT_BMP
public static final java.lang.String FORMAT_TIF
public static final java.lang.String FORMAT_PDF
public static final java.lang.String TIFF_COMPRESSION_CCITT_G3
public static final java.lang.String TIFF_COMPRESSION_CCITT_G4
public static final java.lang.String TIFF_COMPRESSION_LZW
public static final java.lang.String TIFF_COMPRESSION_RLE
public static final java.lang.String TIFF_COMPRESSION_NONE
public static final java.lang.String TIFF_COMPRESSION_PACKBITS
public static final java.lang.String TIFF_COMPRESSION_ZIP
public static final java.lang.String EXIF_NAME_DocumentName
public static final java.lang.String EXIF_NAME_ImageDescription
public static final java.lang.String EXIF_NAME_EquipMake
public static final java.lang.String EXIF_NAME_EquipModel
public static final java.lang.String EXIF_NAME_Copyright
public static final java.lang.String EXIF_NAME_UserComment
public static final java.lang.String SYSTEM_INFO_OS
public static final java.lang.String SYSTEM_INFO_USER_DEFAULT_LC_ID
public static final java.lang.String SYSTEM_INFO_USER_DEFAULT_LC_CODE
public static final java.lang.String SYSTEM_INFO_USER_DEFAULT_UI_LANG_ID
public static final java.lang.String SYSTEM_INFO_USER_DEFAULT_UI_LANG_CODE
public static final java.lang.String SYSTEM_INFO_OS_LANG_ID
public static final java.lang.String SYSTEM_INFO_OS_LANG_CODE
public static final java.lang.String SYSTEM_INFO_GEO_NATION_ID
public static final java.lang.String SYSTEM_INFO_GEO_NATION_NAME
public static final java.lang.String SYSTEM_INFO_GEO_REGION_ID
public static final java.lang.String SYSTEM_INFO_GEO_REGION_NAME
public static final java.lang.String SYSTEM_INFO_TIMEZONE_TYPE
public static final java.lang.String SYSTEM_INFO_TIMEZONE_NAME
public static final java.lang.String SYSTEM_INFO_TIMEZONE_BIAS
public static final java.lang.String SYSTEM_INFO_TWAIN_VERSION
public static final java.lang.String SYSTEM_INFO_DEFAULT_PAPER_SIZE
public static final java.lang.String SYSTEM_INFO_MEASUREMENT_SYSTEM
public static final java.lang.String TWAIN_CONFIG_system_twain_version
public static final java.lang.String TWAIN_CONFIG_twain_config_invocation
public static final java.lang.String TWAIN_CONFIG_twain_config_version
public static final java.lang.String TWAIN_CONFIG_twain_loaded
public static final java.lang.String TWAIN_CONFIG_twain_version_in_use
public static final int TWAIN_CONFIG_VERSION_AUTO
public static final int TWAIN_CONFIG_VERSION_SYSTEM
public static final int TWAIN_CONFIG_VERSION_BUNDLED
public static final int TWAIN_CONFIG_INVOCATION_AUTO
public static final int TWAIN_CONFIG_INVOCATION_ALWAYS_CREATE_NEW_WINDOW
public static final int TWAIN_CONFIG_INVOCATION_REUSE_WINDOW
public Imaging(java.lang.String appId, int windowHandle)
public Imaging(java.awt.Component owningUI)
public void resetIt()
public void setLicense(java.lang.String license)
public java.lang.String getLicense()
public Imaging setUseAspriseSourceSelectUI(boolean value)
public boolean getUseAspriseSourceSelectUI()
public java.lang.String doSelectSourceIfUsingAspriseSelectUI(java.lang.String sourceName)
sourceName
- public void setI18n(java.util.Properties i18n)
public static void setGlobalClientConnectionObj(java.lang.Object clientConnectionObj)
public void setOwning(java.awt.Component owningUI)
public static java.util.concurrent.ExecutorService getDefaultExecutorServiceForScanning()
public static <R> R executeInDefaultExecutorServiceAndWaitTillReturn(java.util.concurrent.Callable<R> callable) throws java.lang.Throwable
R
- callable
- java.lang.Throwable
- in case of exeception occurred during executionpublic Result scan(Request request, java.lang.String sourceName, boolean showUI, boolean modalUI)
request
- scan request object.sourceName
- the exact source name or "select" to prompt dialog selection; "default" to use default source; "current" refers to current opened source if any.showUI
- set to true to use scanner UI or false to hide the UI. Set to true for maximum compatibility.modalUI
- whether the scanner UI should be modal. Set to to true if you are not sure.TwainException
- if failed.public Result scan(java.lang.String scanRequestInJson, java.lang.String sourceName, boolean showUI, boolean modalUI)
scanRequestInJson
- scan request in JSON format.sourceName
- the exact source name or "select" to prompt dialog selection; "default" to use default source; "current" refers to current opened source if any.showUI
- set to true to use scanner UI or false to hide the UI. Set to true for maximum compatibility.modalUI
- whether the scanner UI should be modal. Set to to true if you are not sure.TwainException
- if failed.public java.lang.String scanAndReturnRaw(java.lang.String scanRequestInJson, java.lang.String sourceName, boolean showUI, boolean modalUI)
scanRequestInJson
- scan request in JSON format.sourceName
- the exact source name or "select" to prompt dialog selection; "default" to use default source; "current" refers to current opened source if any.showUI
- set to true to use scanner UI or false to hide the UI. Set to true for maximum compatibility.modalUI
- whether the scanner UI should be modal. Set to to true if you are not sure.TwainException
- if failed.public Result convert(Request request)
request
- scan request object.TwainException
- if failed.public java.util.Map<java.lang.String,java.lang.Object> getImageInfo(java.lang.String imageFile)
imageFile
- Path to the image file.TwainException
- if failed.public java.util.Map<java.lang.String,java.lang.Object> processImage(java.lang.String inputImageFile, java.lang.String commands, java.lang.String outputImageFile)
inputImageFile
- Path to the input file.commands
- Processing commandsoutputImageFile
- Path to the output file.TwainException
- if failed.public java.util.List<Source> scanListSources(boolean nameOnly, java.lang.String capsToRetrieve, boolean detectDeviceType, boolean excludeTwainDsOnWia)
nameOnly
- if true, return list of device names separated by ',' otherwise return device info in JSON format.capsToRetrieve
- only effective if nameOnly is false - If set, return JSON string; can be cap name or code separated by comma or 'all' to list all caps supported.detectDeviceType
- detect whether the device has ADF and/or flatbed.excludeTwainDsOnWia
- exclude WIA synthesized sourcespublic java.util.List<Source> scanListSourcesWithFullDetails()
public java.util.List<Source> scanListSources()
public java.lang.String scanGetLastUsedSourceName()
public java.lang.String scanGetDefaultSourceName()
public java.lang.String scanSelectDefaultSource(java.lang.String defaultSelectedSourceName)
defaultSelectedSourceName
- the name of the source to be pre-selected or null to use the system default.
return: the name of the source selected or empty string if user cancels or error occurs.public java.lang.String scanSelectDefaultSource()
public java.lang.String scanSelectSource()
public Source getSource(java.lang.String sourceName, boolean nameOnly, java.lang.String capsToRetrieve, boolean getCurrent, boolean detectDeviceType, java.lang.String capsToSet)
sourceName
- the exact source name or "default" to open default source; "select" to prompt dialog selectionnameOnly
- if true, return the device name onlycapsToRetrieve
- only effective if nameOnly is false - can be cap name or code separated by comma or 'all' to list all caps supported.getCurrent
- true to return current value false to return current value as well as value range if available.detectDeviceType
- detect whether the device has ADF and/or flatbed.capsToSet
- optionally, you may set capabilities before getting capabilities, e.g, 'ICAP_PIXELTYPE: TWPT_GRAY,TWPT_BW; ICAP_XSCALING/RESET; ICAP_XRESOLUTION: 200'public java.lang.String licRequest(java.lang.String lic)
public static java.lang.String getLibraryVersion()
public static java.lang.String getLibraryBuildInfo()
public static boolean isTwainLoaded()
public static boolean loadTwain()
public static boolean unloadTwain()
public static java.util.Properties getTwainConfig()
"system_twain_version" : "1.7.1.0, 1.7.1.3", "twain_config_invocation" : 1, "twain_config_version" : 2, "twain_loaded" : true, "twain_version_in_use" : "2.3.0.0, 2.3.0.0"
public static int getTwainConfigInvocation()
public static int getTwainConfigVersion()
public static java.lang.String getTwainVersionLoaded()
public static java.lang.String getTwainVersionSystem()
public static boolean setTwainConfig(int version, int invocation)
version
- 0: Auto; 1: Use system; 2: Use bundledinvocation
- 0: Auto; 1: always creates a new window handle; 2: reuse existing window handlepublic static java.util.Properties getSystemInfo()
public static java.lang.String getSystemInfoUserLocale()
public static java.lang.String getLibraryVersionNumberOnly()
public static java.lang.String callNativeFunc(java.lang.String functionName, java.lang.Object... args)
functionName
- args
- Must be of type: String, Integer or Boolean;java.lang.RuntimeException
- if failed to form request in JSON format.public static void configureNativeLogging(int level, java.lang.String logFilePath)
level
- Any of LOG_LEVEL_INFO (default), LOG_LEVEL_WARN, etc.logFilePath
- path to the target output file or special values: "stdout", "stderr" for console logging, null or empty string to disable logging.public static void main(java.lang.String[] args)
v12.0.5.0 | Copyright © Asprise Software. All Rights Reserved. Please visit the product page at asprise.com