Package com.famoco.barcode

Class BarcodeManager

java.lang.Object

com.famoco.barcode.BarcodeManager

public class BarcodeManager
extends java.lang.Object

Manager class for IBarcodeManager remote calls.

 Manage service @see com.famoco.barcode.BarcodeManagerService
 

Field Summary

Fields

Modifier and Type	Field	Description
static int	INPUT_METHOD_INTENT	Sends the barcode to the foreground app as an intent
static int	INPUT_METHOD_KEY	Inputs characters one by one as key input events
static int	INPUT_METHOD_PASTE	Inputs the barcode as a whole as a clipboard paste event

Constructor Summary

Constructors

Constructor	Description
BarcodeManager(com.famoco.barcode.IBarcodeManager service)

Method Summary

Modifier and Type	Method	Description
static BarcodeManager	getInstance(android.content.Context context)	Gets the BarcodeManager instance to manage the barcode manager service.
boolean	isActive()	Returns whether the barcode scanner service is active.
void	open()	Opens the barcode scanner service.
void	pause()	Pauses barcode scanner service.
void	release()	Releases the barcode scanner service.
void	resume()	Resumes barcode scanner service.
void	setButtonKeycodes(java.lang.String buttonKeycodesList)	Set button keycodes to trigger a barcode laser scan.
void	setEnabled(boolean enabled)	Enable/disable barcode scanner service.
void	setInputMethod(int inputMethod)	Set inputMethod scan action to execute after a barcode laser scan.
void	setPostScanAction(int postScanAction)	Set post scan action to execute after a barcode laser scan.
void	setScanning(boolean enabled)	Start/stop a single scan.
void	setSoundEnabled(boolean enabled)	Enable/disable sound

Methods inherited from class java.lang.Object

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

Field Detail

INPUT_METHOD_KEY

public static int INPUT_METHOD_KEY

Inputs characters one by one as key input events

INPUT_METHOD_PASTE

public static int INPUT_METHOD_PASTE

Inputs the barcode as a whole as a clipboard paste event

INPUT_METHOD_INTENT

public static int INPUT_METHOD_INTENT

Sends the barcode to the foreground app as an intent

Constructor Detail

BarcodeManager

public BarcodeManager(com.famoco.barcode.IBarcodeManager service)

Method Detail

getInstance

public static BarcodeManager getInstance(android.content.Context context)

Gets the BarcodeManager instance to manage the barcode manager service. It is always required to manage the service, therefore it is generally done in the constructor and used globally in the app's controller class.

release

public void release()

Releases the barcode scanner service. This is not necessarily used. pause() is preferred in most use cases.

isActive

public boolean isActive()

Returns whether the barcode scanner service is active.

Returns:

true if the service is active

open

public void open()

Opens the barcode scanner service. This is not mandatory to use because the service is automatically started in background when the user press the barcode key (KEY_F1 by default) for the first time. If for any reason, the service is released and not re-opened, this method could be used as a fallback even though it should not be necessary.

pause

public void pause()

Pauses barcode scanner service. It is very important for apps using the proprietary SDK directly because it is required for them to disable the service before loading the native barcode libraries. To be used in conjunction with resume().

resume

public void resume()

Resumes barcode scanner service. It is important to leave back the service if required by another app. Calling this in Activity's onResume() makes the service back again with the service for another usage. To be used in conjunction with pause().

setEnabled

public void setEnabled(boolean enabled)

Enable/disable barcode scanner service.

Parameters:

enabled - whether to enable or disable the barcode scanner service.

setScanning

public void setScanning(boolean enabled)

Start/stop a single scan.

Parameters:

enabled - whether to start or stop the scan.

setSoundEnabled

public void setSoundEnabled(boolean enabled)

Enable/disable sound

Parameters:

enabled - whether to enable or disable the sound in barcode scanner service.

setButtonKeycodes

public void setButtonKeycodes(java.lang.String buttonKeycodesList)

Set button keycodes to trigger a barcode laser scan.

Parameters:

buttonKeycodesList - list of button keycodes ids separated by commas.

Throws:

java.lang.IllegalArgumentException - if the buttonKeycodes is invalid.

setPostScanAction

public void setPostScanAction(int postScanAction)

Set post scan action to execute after a barcode laser scan.

Parameters:

postScanAction - action to execute after a barcode laser scan.

Throws:

java.lang.IllegalArgumentException - if the post scan action is invalid.

setInputMethod

public void setInputMethod(int inputMethod)

Set inputMethod scan action to execute after a barcode laser scan.

Parameters:

inputMethod - : one of INPUT_METHOD_KEY, INPUT_METHOD_PASTE or INPUT_METHOD_INTENT

Throws:

java.lang.IllegalArgumentException - if the input method is invalid.