Foxit PDF SDK  9.1
com.foxit.pdfscan.PDFScanManager Class Reference

Public Member Functions

void setContentView (@ScanManagerType int type, IContentViewPresenter view)
 
IContentViewPresenter getContentView (@ScanManagerType int type)
 
void setActionView (@ScanManagerType int type, IActionViewPresenter view)
 
IActionViewPresenter getActionView (@ScanManagerType int type)
 
void showUI (Activity context)
 
void setItemHiddenWithType (@FSScanCameraControllerItemType int fsScanCameraControllerItemType, boolean hidden)
 
void setOnScanPDFSaveAsCallBack (String path)
 

Static Public Member Functions

static void initializeScanner (Application application, long serial1, long serial2)
 
static void initializeCompression (Application application, long serial1, long serial2)
 
static boolean isInitializeScanner ()
 
static boolean isInitializeCompression ()
 
static void registerManagerListener (IPDFScanManagerListener listener)
 
static void unregisterManagerListener (IPDFScanManagerListener listener)
 

Static Public Attributes

static final int PDF_SAVE_AS_ACTION_VIEW = 1
 
static final int PDF_SAVE_AS_CONTENT_VIEW = 2
 
static final int FS_SCAN_CAMERA_CONTROLLER_ITEM_TYPE_FLASH_LIGHT = 1
 
static final int FS_SCAN_CAMERA_CONTROLLER_ITEM_TYPE_SINGLE_SHOOTING = 2
 
static final int FS_SCAN_CAMERA_CONTROLLER_ITEM_TYPE_PHOTOS = 3
 
static final int FS_SCAN_CAMERA_CONTROLLER_ITEM_TYPE_AUTO_DECTION = 4
 
static final int FS_SCAN_CAMERA_CONTROLLER_ITEM_TYPE_FORMAT_PAGESIZE = 5
 

Detailed Description

Foxit PDF SDK for Android Scanning Add-On

1:To use the scanning functionality, you must always declare the initializeScanner and initializeCompression methods 2:you can determine whether the initialization is successful through isInitializeScanner and isInitializeCompression methods 3:Once the initialization is complete, then you can use the showUI(Activity) method to show the scan ui,

Member Function Documentation

◆ getActionView()

IActionViewPresenter com.foxit.pdfscan.PDFScanManager.getActionView ( @ScanManagerType int  type)

get the custom view of appending actionview

Parameters
typeDistinguish the key of custom view PDF_SAVE_AS_ACTION_VIEW
Returns
Add ActionView view

◆ getContentView()

IContentViewPresenter com.foxit.pdfscan.PDFScanManager.getContentView ( @ScanManagerType int  type)

Get full custom contentView

Parameters
typeDistinguish the key of custom view PDF_SAVE_AS_CONTENT_VIEW
Returns
Customize the management class of contentView view

◆ initializeCompression()

static void com.foxit.pdfscan.PDFScanManager.initializeCompression ( Application  application,
long  serial1,
long  serial2 
)
static

Initialize the Mobile Compression module Successful initialization of the module requires a valid serial number

Parameters
serial1First part of the serial number. The trial serial can be passed to 0,
  • if you need a formal serial , please contact us
serial2Second part of the serial number The trial serial can be passed to 0,
  • if you need a formal serial , please contact us

◆ initializeScanner()

static void com.foxit.pdfscan.PDFScanManager.initializeScanner ( Application  application,
long  serial1,
long  serial2 
)
static

Initialize the Scanner module with additional parameters This function must be called before any objects can be instantiated Successful initialization of the module requires a valid serial number

Parameters
serial1First part of the serial number. The trial serial can be passed to 0, if you need a formal serial , please contact us
serial2Second part of the serial number. The trial serial can be passed to 0,
  • if you need a formal serial , please contact us

◆ isInitializeCompression()

static boolean com.foxit.pdfscan.PDFScanManager.isInitializeCompression ( )
static

Indicates whether the Mobile Compression module is initialized.

Returns
true if the Mobile Compression module is initialized, false otherwise

◆ isInitializeScanner()

static boolean com.foxit.pdfscan.PDFScanManager.isInitializeScanner ( )
static

Indicates whether the Scanner module is initialized.

Returns
true if the Scanner module is initialized, false otherwise

◆ registerManagerListener()

static void com.foxit.pdfscan.PDFScanManager.registerManagerListener ( IPDFScanManagerListener  listener)
static

Return the scanning list Fragment.

Parameters
dismissListenerSet a listener to be invoked when the scanning list Fragment is dismissed.android.content.DialogInterface.OnDismissListener
Returns
Return the scanning list Fragment. Register a callback to be invoked when the scanning list is changed.
Parameters
listenera IPDFScanManagerListener to use

◆ setActionView()

void com.foxit.pdfscan.PDFScanManager.setActionView ( @ScanManagerType int  type,
IActionViewPresenter  view 
)

Set the custom view of appending actionview

Parameters
typeDistinguish the key of custom view PDF_SAVE_AS_ACTION_VIEW
viewCustomize the management class of action view view

◆ setContentView()

void com.foxit.pdfscan.PDFScanManager.setContentView ( @ScanManagerType int  type,
IContentViewPresenter  view 
)

Set the complete custom content view management class to the save as view

Parameters
typeDistinguish the key of custom view PDF_SAVE_AS_CONTENT_VIEW
viewCustomize the management class of contentView view

◆ setItemHiddenWithType()

void com.foxit.pdfscan.PDFScanManager.setItemHiddenWithType ( @FSScanCameraControllerItemType int  fsScanCameraControllerItemType,
boolean  hidden 
)

Set the item of photos hidden in the camera viewController of PDFScan

Parameters
fsScanCameraControllerItemTypeSet hidden itemsPlease refer to values starting from fs_itemTypeXXX.
hiddenhidden hidden is YES otherwise is NO

◆ setOnScanPDFSaveAsCallBack()

void com.foxit.pdfscan.PDFScanManager.setOnScanPDFSaveAsCallBack ( String  path)

Save as PDF with file path

Parameters
pathThe path saved by the user

◆ showUI()

void com.foxit.pdfscan.PDFScanManager.showUI ( Activity  context)

Show the scan camera interface

Parameters
contextA Context of the application package implementing this class.

◆ unregisterManagerListener()

static void com.foxit.pdfscan.PDFScanManager.unregisterManagerListener ( IPDFScanManagerListener  listener)
static

Unregister the specified IPDFScanManagerListener

Parameters
listenerA IPDFScanManagerListener object to be unregistered.

Member Data Documentation

◆ FS_SCAN_CAMERA_CONTROLLER_ITEM_TYPE_AUTO_DECTION

final int com.foxit.pdfscan.PDFScanManager.FS_SCAN_CAMERA_CONTROLLER_ITEM_TYPE_AUTO_DECTION = 4
static

The auto dection button in the top bar of home view

◆ FS_SCAN_CAMERA_CONTROLLER_ITEM_TYPE_FLASH_LIGHT

final int com.foxit.pdfscan.PDFScanManager.FS_SCAN_CAMERA_CONTROLLER_ITEM_TYPE_FLASH_LIGHT = 1
static

The Flash of light item in the top bar of camera viewController

◆ FS_SCAN_CAMERA_CONTROLLER_ITEM_TYPE_FORMAT_PAGESIZE

final int com.foxit.pdfscan.PDFScanManager.FS_SCAN_CAMERA_CONTROLLER_ITEM_TYPE_FORMAT_PAGESIZE = 5
static

The format pagesize button in the top bar of home view

◆ FS_SCAN_CAMERA_CONTROLLER_ITEM_TYPE_PHOTOS

final int com.foxit.pdfscan.PDFScanManager.FS_SCAN_CAMERA_CONTROLLER_ITEM_TYPE_PHOTOS = 3
static

The photos button in the top bar of home view

◆ FS_SCAN_CAMERA_CONTROLLER_ITEM_TYPE_SINGLE_SHOOTING

final int com.foxit.pdfscan.PDFScanManager.FS_SCAN_CAMERA_CONTROLLER_ITEM_TYPE_SINGLE_SHOOTING = 2
static

The Single shooting button in the top bar of home view

◆ PDF_SAVE_AS_ACTION_VIEW

final int com.foxit.pdfscan.PDFScanManager.PDF_SAVE_AS_ACTION_VIEW = 1
static

Customize the management class for the Save as actionView view

◆ PDF_SAVE_AS_CONTENT_VIEW

final int com.foxit.pdfscan.PDFScanManager.PDF_SAVE_AS_CONTENT_VIEW = 2
static

Customize the management class of save as contentView view