public class Request
extends java.lang.Object
implements java.lang.Cloneable
Modifier and Type | Field and Description |
---|---|
static int |
DEFAULT_BLANK_PAGE_MARGIN_PERCENT |
static double |
DEFAULT_BLANK_PAGE_THRESHOLD |
static java.lang.String |
I18N_IMAGE_THUMB_DELETE |
static java.lang.String |
I18N_IMAGE_THUMB_EDIT |
static java.lang.String |
I18N_IMAGE_THUMB_MARK_DOC_SEP |
static java.lang.String |
I18N_IMAGE_THUMB_MARK_NEW_DOC |
static java.lang.String |
I18N_IMAGE_THUMB_TOOLTIP_DND |
static java.lang.String |
I18N_IMAGE_THUMB_UNMARK |
static java.lang.String |
I18N_LANG |
static java.lang.String |
I18N_LANG_CHINESE_SIMPLIFIED |
static java.lang.String |
I18N_LANG_ENGLISH |
static java.lang.String |
I18N_LANG_FRENCH |
static java.lang.String |
I18N_LANG_GERMAN |
static java.lang.String |
I18N_LANG_ITALIAN |
static java.lang.String |
I18N_LANG_JAPANESE |
static java.lang.String |
I18N_LANG_PORTUGUESE |
static java.lang.String |
I18N_LANG_RUSSIAN |
static java.lang.String |
I18N_LANG_SPANISH |
static java.lang.String |
I18N_LANG_USER
User's locale
|
static java.lang.String |
I18N_OPERATION_IN_PROGRESS |
static java.lang.String |
I18N_PROPS_PREFIX |
static java.lang.String |
I18N_SCAN_MORE_DIALOG_MESSAGE
Message appears on scan more dialog
|
static java.lang.String |
I18N_SCAN_MORE_DIALOG_TITLE |
static java.lang.String |
I18N_SCAN_PANEL_BRIGHTNESS |
static java.lang.String |
I18N_SCAN_PANEL_COLOR_MODE |
static java.lang.String |
I18N_SCAN_PANEL_COLOR_MODE_ELEMENTS |
static java.lang.String |
I18N_SCAN_PANEL_CONTRAST |
static java.lang.String |
I18N_SCAN_PANEL_NO_SCANNER_FOUND |
static java.lang.String |
I18N_SCAN_PANEL_PAPER_SIZE |
static java.lang.String |
I18N_SCAN_PANEL_PAPER_SIZE_ELEMENTS |
static java.lang.String |
I18N_SCAN_PANEL_PAPER_SOURCE |
static java.lang.String |
I18N_SCAN_PANEL_PAPER_SOURCE_ELEMENTS
Map of key to value; entry separated by | and key/value separated by =
|
static java.lang.String |
I18N_SCAN_PANEL_PROMPT_SCAN_MORE |
static java.lang.String |
I18N_SCAN_PANEL_REFRESH_TOOLTIP |
static java.lang.String |
I18N_SCAN_PANEL_REMOVE_BLANK |
static java.lang.String |
I18N_SCAN_PANEL_RESOLUTION |
static java.lang.String |
I18N_SCAN_PANEL_RESOLUTION_FORMAT |
static java.lang.String |
I18N_SCAN_PANEL_SCAN |
static java.lang.String |
I18N_SCAN_PANEL_SCAN_TOOLTIP |
static java.lang.String |
I18N_SCAN_PANEL_SCANNER |
static java.lang.String |
I18N_SCAN_PANEL_SCANNER_UI |
static java.lang.String |
I18N_SCAN_SELECT_FORMAT_ACTIONS_ELEMENTS |
static java.lang.String |
I18N_SCAN_UI_CANCEL |
static java.lang.String |
I18N_SCAN_UI_DISCARD_MESSAGE |
static java.lang.String |
I18N_SCAN_UI_DISCARD_TITLE |
static java.lang.String |
I18N_SCAN_UI_INSTRUCTION_PANEL |
static java.lang.String |
I18N_SCAN_UI_NO_IMAGE_SCANNED |
static java.lang.String |
I18N_SCAN_UI_OK |
static java.lang.String |
I18N_SCAN_UI_PAGES_FORMAT |
static java.lang.String |
I18N_SCAN_UI_REMOVE_MESSAGE |
static java.lang.String |
I18N_SCAN_UI_REMOVE_TITLE |
static java.lang.String |
I18N_SCAN_UI_SCAN_PANEL |
static java.lang.String |
I18N_SCAN_UI_TITLE |
static java.lang.String |
I18N_SCAN_UI_USE_LAST_SCANNED |
static java.lang.String |
I18N_SELECT_SOURCE_CANCEL |
static java.lang.String |
I18N_SELECT_SOURCE_CANCEL_MESG |
static java.lang.String |
I18N_SELECT_SOURCE_CANCEL_TITLE |
static java.lang.String |
I18N_SELECT_SOURCE_REFRESH |
static java.lang.String |
I18N_SELECT_SOURCE_SELECT |
static java.lang.String |
I18N_SELECT_SOURCE_SOURCES |
static java.lang.String |
I18N_SELECT_SOURCE_TITLE |
static java.lang.String |
I18N_SELECT_SOURCE_WIA_SOURCES |
static java.lang.String |
I18N_STATUS_MEMORY |
static java.lang.String |
I18N_STATUS_MEMORY_FORMAT_2 |
static java.lang.String |
I18N_STATUS_READY |
static java.lang.String |
SEP_MARKER_NEW |
static java.lang.String |
SEP_MARKER_NEW_SEP |
static java.lang.String |
SEP_MARKER_NO |
Constructor and Description |
---|
Request()
Constructor.
|
Modifier and Type | Method and Description |
---|---|
Request |
addImageFile(java.io.File imageFile)
Adds an image file
|
Request |
addImageFiles(java.util.List<java.io.File> imageFiles,
java.util.List<ResultImageItem> imgFilesItems)
Adds list of image files.
|
Request |
addOutputItem(RequestOutputItem outputItem)
Adds an output specification.
|
Request |
addOutputItems(java.util.List<RequestOutputItem> items)
Adds output specifications.
|
Request |
clearI18n(java.lang.String key)
Removes an i18n record.
|
java.lang.Object |
clone() |
void |
configUiControl(java.lang.String key,
javax.swing.JComponent... components)
Configures components' visibility and enable status according to spec in ui_controls_config.
|
static Request |
fromJson(java.lang.String spec) |
int |
getAdfMaxPages() |
int |
getBlankPageMarginPercent()
Percentage of margin to be excluded when calculating ink coverage.
|
double |
getBlankPageThreshold()
Ink coverage threshold to determine if a page is blank.
|
java.lang.Object |
getData()
Request data
|
java.lang.String |
getDetectBlankPages()
Whether blank pages should be detected.
|
int |
getDialogHeight() |
java.lang.String |
getDialogTitle() |
int |
getDialogWidth() |
java.util.List<java.lang.String> |
getDocSeparators() |
java.util.Properties |
getI18n() |
java.lang.String |
getId()
Request ID
|
java.util.List<java.io.File> |
getImageFiles() |
java.lang.String |
getInstruction() |
static java.lang.String[] |
getKeywords() |
static java.lang.String[] |
getKeywordsWithExtras() |
java.lang.Boolean |
getModalScannerUI() |
java.util.List<RequestOutputItem> |
getOutputItems()
Output specifications.
|
java.util.Set<java.lang.String> |
getRetrieveCaps()
Names of caps to be retrieved.
|
java.util.Set<java.lang.String> |
getRetrieveExtendedImageAttributes()
Name of extended image attributes to be retrieved.
|
java.lang.String |
getSelectOutputActions() |
java.lang.String |
getSelectOutputFileName() |
java.lang.String |
getSelectOutputType() |
boolean |
getSelectOutputTypeAndFileName() |
java.lang.Boolean |
getShowLoggingOnError() |
java.lang.Boolean |
getShowScannerUI() |
java.lang.String |
getSourceName() |
java.awt.Dimension |
getSpecifiedDialogSize()
Dimension from dialog width and dialog height or null if either is not greater than 0.
|
java.util.Map<java.lang.String,java.lang.String> |
getTwainCapSetting()
Map of cap name (could be appended with operation and priority, e.g., /RESET, /SET/3456)
|
int |
getTwainCapValueAsInt(int capCode)
Returns the cap value setting specified in the request as int or -1 if failed to convert to int.
|
java.lang.Boolean |
getUseAspriseDialog() |
boolean |
isEnableUseLastScanned() |
boolean |
isI18nSet(java.lang.String key) |
boolean |
isOnWebServer() |
boolean |
isProcessImagesAfterAllScans()
By default images will be processed after each scan; Set to true to process images after all scans.
|
boolean |
isPromptScanMore()
Whether to prompt scan more dialog.
|
boolean |
isRecognizeBarcodes()
Whether barcodes should be recognized.
|
Request |
removeAllOutputItems() |
Request |
retrieveCap(int capCode)
Add a cap to be retrieved.
|
Request |
retrieveExtendedImageAttributes(int tweiCode)
Adds an extended image attribute to be retrieved.
|
Request |
setAdfMaxPages(int adfMaxPages) |
Request |
setBarcodesDpi(int value)
The DPI at which level to recognize barcodes.
|
Request |
setBarcodesSettings(java.lang.Object value)
Additional barcodes settings
|
Request |
setBlankPageMarginPercent(int blankPageMarginPercent)
Percentage of margin to be excluded when calculating ink coverage.
|
Request |
setBlankPageThreshold(double blankPageThreshold)
Ink coverage threshold to determine if a page is blank.
|
Request |
setData(java.lang.Object data)
Request data
|
Request |
setDetectBlankPages(java.lang.String detectBlankPages)
Whether blank pages should be detected.
|
Request |
setDialogHeight(int dialogHeight) |
Request |
setDialogTitle(java.lang.String dialogTitle) |
Request |
setDialogWidth(int dialogWidth) |
Request |
setDocSeparators(java.lang.String... separators) |
Request |
setEnableUseLastScanned(java.lang.Boolean enableUseLastScanned) |
Request |
setI18n(java.lang.String key,
java.lang.String text)
Adds an i18n record.
|
Request |
setId(java.lang.String id)
Request ID
|
Request |
setInstruction(java.lang.String instruction) |
Request |
setModalScannerUI(java.lang.Boolean modalScannerUI) |
Request |
setOnWebServer(boolean value) |
Request |
setProcessImagesAfterAllScans(boolean processImagesAfterAllScan)
By default images will be processed after each scan; Set to true to process images after all scans.
|
Request |
setPromptScanMore(boolean promptScanMore)
Whether to prompt scan more dialog.
|
Request |
setRecognizeBarcodes(boolean recognizeBarcodes)
Whether barcodes should be recognized.
|
Request |
setSelectOutputActions(java.lang.String selectOutputActions) |
Request |
setSelectOutputFileName(java.lang.String selectOutputFileName) |
Request |
setSelectOutputType(java.lang.String selectOutputType) |
Request |
setSelectOutputTypeAndFileName(java.lang.Boolean selectOutputTypeAndFileName) |
Request |
setShowLoggingOnError(java.lang.Boolean showLoggingOnError) |
Request |
setShowScannerUI(java.lang.Boolean showScannerUI) |
Request |
setSourceName(java.lang.String sourceName) |
Request |
setTwainCap(int capCode,
java.lang.Object value)
Set twain capability.
|
Request |
setTwainCap(int capCode,
java.lang.Object value,
boolean reset)
Set or reset twain capability.
|
Request |
setUiControlConfig(java.lang.String key,
boolean invisible,
boolean uneditable)
Adds an entry to ui_controls_config with value of // "I"nvisble | "U"editable | "E"ditable
|
Request |
setUseAspriseDialog(java.lang.Boolean useAspriseDialog) |
java.lang.String |
toJson(boolean pretty) |
java.util.Map<java.lang.String,java.lang.Object> |
toJsonObject() |
public static final double DEFAULT_BLANK_PAGE_THRESHOLD
public static final int DEFAULT_BLANK_PAGE_MARGIN_PERCENT
public static final java.lang.String SEP_MARKER_NEW
public static final java.lang.String SEP_MARKER_NEW_SEP
public static final java.lang.String SEP_MARKER_NO
public static java.lang.String I18N_PROPS_PREFIX
public static java.lang.String I18N_SCAN_MORE_DIALOG_MESSAGE
public static java.lang.String I18N_SCAN_MORE_DIALOG_TITLE
public static java.lang.String I18N_SELECT_SOURCE_TITLE
public static java.lang.String I18N_SELECT_SOURCE_SOURCES
public static java.lang.String I18N_SELECT_SOURCE_WIA_SOURCES
public static java.lang.String I18N_SELECT_SOURCE_SELECT
public static java.lang.String I18N_SELECT_SOURCE_CANCEL
public static java.lang.String I18N_SELECT_SOURCE_REFRESH
public static java.lang.String I18N_SELECT_SOURCE_CANCEL_MESG
public static java.lang.String I18N_SELECT_SOURCE_CANCEL_TITLE
public static java.lang.String I18N_SCAN_PANEL_SCANNER
public static java.lang.String I18N_SCAN_PANEL_PAPER_SOURCE
public static java.lang.String I18N_SCAN_PANEL_PAPER_SOURCE_ELEMENTS
public static java.lang.String I18N_SCAN_PANEL_PAPER_SIZE
public static java.lang.String I18N_SCAN_PANEL_PAPER_SIZE_ELEMENTS
public static java.lang.String I18N_SCAN_PANEL_COLOR_MODE
public static java.lang.String I18N_SCAN_PANEL_COLOR_MODE_ELEMENTS
public static java.lang.String I18N_SCAN_PANEL_RESOLUTION
public static java.lang.String I18N_SCAN_PANEL_RESOLUTION_FORMAT
public static java.lang.String I18N_SCAN_PANEL_BRIGHTNESS
public static java.lang.String I18N_SCAN_PANEL_CONTRAST
public static java.lang.String I18N_SCAN_PANEL_PROMPT_SCAN_MORE
public static java.lang.String I18N_SCAN_PANEL_REMOVE_BLANK
public static java.lang.String I18N_SCAN_PANEL_SCANNER_UI
public static java.lang.String I18N_SCAN_PANEL_SCAN
public static java.lang.String I18N_SCAN_PANEL_SCAN_TOOLTIP
public static java.lang.String I18N_SCAN_PANEL_REFRESH_TOOLTIP
public static java.lang.String I18N_SCAN_PANEL_NO_SCANNER_FOUND
public static java.lang.String I18N_IMAGE_THUMB_EDIT
public static java.lang.String I18N_IMAGE_THUMB_DELETE
public static java.lang.String I18N_IMAGE_THUMB_MARK_DOC_SEP
public static java.lang.String I18N_IMAGE_THUMB_MARK_NEW_DOC
public static java.lang.String I18N_IMAGE_THUMB_UNMARK
public static java.lang.String I18N_IMAGE_THUMB_TOOLTIP_DND
public static java.lang.String I18N_SCAN_UI_TITLE
public static java.lang.String I18N_SCAN_UI_OK
public static java.lang.String I18N_SCAN_UI_CANCEL
public static java.lang.String I18N_SCAN_UI_USE_LAST_SCANNED
public static java.lang.String I18N_SCAN_UI_PAGES_FORMAT
public static java.lang.String I18N_SCAN_UI_DISCARD_MESSAGE
public static java.lang.String I18N_SCAN_UI_DISCARD_TITLE
public static java.lang.String I18N_SCAN_UI_REMOVE_MESSAGE
public static java.lang.String I18N_SCAN_UI_REMOVE_TITLE
public static java.lang.String I18N_SCAN_UI_INSTRUCTION_PANEL
public static java.lang.String I18N_SCAN_UI_SCAN_PANEL
public static java.lang.String I18N_SCAN_UI_NO_IMAGE_SCANNED
public static java.lang.String I18N_STATUS_READY
public static java.lang.String I18N_STATUS_MEMORY
public static java.lang.String I18N_STATUS_MEMORY_FORMAT_2
public static java.lang.String I18N_OPERATION_IN_PROGRESS
public static java.lang.String I18N_SCAN_SELECT_FORMAT_ACTIONS_ELEMENTS
public static java.lang.String I18N_LANG
public static java.lang.String I18N_LANG_ENGLISH
public static java.lang.String I18N_LANG_FRENCH
public static java.lang.String I18N_LANG_GERMAN
public static java.lang.String I18N_LANG_ITALIAN
public static java.lang.String I18N_LANG_PORTUGUESE
public static java.lang.String I18N_LANG_SPANISH
public static java.lang.String I18N_LANG_RUSSIAN
public static java.lang.String I18N_LANG_JAPANESE
public static java.lang.String I18N_LANG_CHINESE_SIMPLIFIED
public static java.lang.String I18N_LANG_USER
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
clone
in class java.lang.Object
java.lang.CloneNotSupportedException
public java.lang.String toJson(boolean pretty)
public static Request fromJson(java.lang.String spec) throws java.io.IOException
java.io.IOException
public java.util.Map<java.lang.String,java.lang.Object> toJsonObject()
public static java.lang.String[] getKeywordsWithExtras()
public static java.lang.String[] getKeywords()
public java.lang.String getId()
public Request setId(java.lang.String id)
public java.lang.Object getData()
public Request setData(java.lang.Object data)
public boolean isProcessImagesAfterAllScans()
public Request setProcessImagesAfterAllScans(boolean processImagesAfterAllScan)
public boolean isPromptScanMore()
public Request setPromptScanMore(boolean promptScanMore)
public java.lang.String getDetectBlankPages()
public Request setDetectBlankPages(java.lang.String detectBlankPages)
public double getBlankPageThreshold()
public Request setBlankPageThreshold(double blankPageThreshold)
public int getBlankPageMarginPercent()
public Request setBlankPageMarginPercent(int blankPageMarginPercent)
public boolean isRecognizeBarcodes()
public Request setRecognizeBarcodes(boolean recognizeBarcodes)
public Request setBarcodesDpi(int value)
public Request setBarcodesSettings(java.lang.Object value)
public boolean isOnWebServer()
public Request setOnWebServer(boolean value)
public boolean getSelectOutputTypeAndFileName()
public Request setSelectOutputTypeAndFileName(java.lang.Boolean selectOutputTypeAndFileName)
public java.lang.String getSelectOutputActions()
public Request setSelectOutputActions(java.lang.String selectOutputActions)
public java.lang.String getSelectOutputType()
public Request setSelectOutputType(java.lang.String selectOutputType)
public java.lang.String getSelectOutputFileName()
public Request setSelectOutputFileName(java.lang.String selectOutputFileName)
public java.util.Map<java.lang.String,java.lang.String> getTwainCapSetting()
public Request setTwainCap(int capCode, java.lang.Object value, boolean reset)
capCode
- e.g., TwainConstants.ICAP_PIXELTYPEvalue
- support raw value and twain constant expansion; support fall back values e.g., "TWPT_GRAY,TWPT_BW"reset
- true to set operation RESET instead of SET.public Request setTwainCap(int capCode, java.lang.Object value)
capCode
- e.g., TwainConstants.ICAP_PIXELTYPEvalue
- support raw value and twain constant expansion; support fall back values e.g., "TWPT_GRAY,TWPT_BW"public int getTwainCapValueAsInt(int capCode)
capCode
- public java.util.Set<java.lang.String> getRetrieveCaps()
public Request retrieveCap(int capCode)
public java.util.Set<java.lang.String> getRetrieveExtendedImageAttributes()
public Request retrieveExtendedImageAttributes(int tweiCode)
public java.util.List<RequestOutputItem> getOutputItems()
public Request addOutputItem(RequestOutputItem outputItem)
public Request addOutputItems(java.util.List<RequestOutputItem> items)
public Request removeAllOutputItems()
public java.util.List<java.io.File> getImageFiles()
public Request addImageFile(java.io.File imageFile)
java.lang.IllegalArgumentException
- if the file is not readablepublic Request addImageFiles(java.util.List<java.io.File> imageFiles, java.util.List<ResultImageItem> imgFilesItems)
imageFiles
- list of image files or null.imgFilesItems
- The associated ResultImageItem if any.java.lang.IllegalArgumentException
- if any of the file in the list is not readablepublic Request setUseAspriseDialog(java.lang.Boolean useAspriseDialog)
public Request setDialogTitle(java.lang.String dialogTitle)
public Request setInstruction(java.lang.String instruction)
public Request setDialogWidth(int dialogWidth)
public Request setDialogHeight(int dialogHeight)
public Request setShowScannerUI(java.lang.Boolean showScannerUI)
public Request setModalScannerUI(java.lang.Boolean modalScannerUI)
public Request setSourceName(java.lang.String sourceName)
public java.lang.Boolean getUseAspriseDialog()
public java.lang.Boolean getShowLoggingOnError()
public Request setShowLoggingOnError(java.lang.Boolean showLoggingOnError)
public java.lang.String getDialogTitle()
public java.lang.String getInstruction()
public int getDialogWidth()
public int getDialogHeight()
public java.lang.Boolean getShowScannerUI()
public java.lang.Boolean getModalScannerUI()
public java.lang.String getSourceName()
public int getAdfMaxPages()
public Request setAdfMaxPages(int adfMaxPages)
public boolean isEnableUseLastScanned()
public Request setEnableUseLastScanned(java.lang.Boolean enableUseLastScanned)
public Request setI18n(java.lang.String key, java.lang.String text)
public Request clearI18n(java.lang.String key)
key
- the specific key to remove or null
to clear all keys.public boolean isI18nSet(java.lang.String key)
public Request setUiControlConfig(java.lang.String key, boolean invisible, boolean uneditable)
key
- the control idinvisible
- whether the control should be invisibleuneditable
- if not invisible, whether it's uneditable?public void configUiControl(java.lang.String key, javax.swing.JComponent... components)
key
- components
- list of components associated with the keypublic java.util.List<java.lang.String> getDocSeparators()
public Request setDocSeparators(java.lang.String... separators)
public java.util.Properties getI18n()
public java.awt.Dimension getSpecifiedDialogSize()
v12.0.5.0 | Copyright © Asprise Software. All Rights Reserved. Please visit the product page at asprise.com