com.so.net

Enum DeviceApi.Device.Mode

java.lang.Object

java.lang.Enum<DeviceApi.Device.Mode>

com.so.net.DeviceApi.Device.Mode

All Implemented Interfaces:

Serializable, Comparable<DeviceApi.Device.Mode>

Enclosing class:

DeviceApi.Device

public static enum DeviceApi.Device.Mode
extends Enum<DeviceApi.Device.Mode>

Devices have various modes of operations.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Boot
Calibrate To track pen movements precisely, the sensors of the device need to be calibrated.
Configuration This mode allos to access the file system.
CustomerLogo The customer logo mode allows you to use the display of the signature pad for showing images to customers.
Dialog This mode is deprecated.
DocumentSign The sign in document mode.
DocumentView One may view documents with this mode.
PadOpenDirect
PadOpenSign
SignBmpPrepare The device is preparing the default signature mode.
SignBmpRun The device has finished the preparation of the default signature mode.
SignConfirm In the signature confirm mode the device waits for a physical confirmation from the signer, that is, the person wielding the pen.
SimpleDialogSign The simple dialog sign mode.
StandardSign The standard signature mode.
Suspend

Method Summary

Modifier and Type	Method and Description
static DeviceApi.Device.Mode	valueOf(String name) Returns the enum constant of this type with the specified name.
static DeviceApi.Device.Mode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

StandardSign

public static final DeviceApi.Device.Mode StandardSign

The standard signature mode.

CustomerLogo

public static final DeviceApi.Device.Mode CustomerLogo

The customer logo mode allows you to use the display of the signature pad for showing images to customers. Use DeviceApi.setCustomerLogoMode() to set the device to that mode.

Calibrate

public static final DeviceApi.Device.Mode Calibrate

To track pen movements precisely, the sensors of the device need to be calibrated. This mode indicates that the device is performing a calibration. You may start a calibration by means of DeviceApi.calibrateSensor().

SignBmpPrepare

public static final DeviceApi.Device.Mode SignBmpPrepare

The device is preparing the default signature mode.

SignBmpRun

public static final DeviceApi.Device.Mode SignBmpRun

The device has finished the preparation of the default signature mode.

DocumentView

public static final DeviceApi.Device.Mode DocumentView

One may view documents with this mode.

Configuration

public static final DeviceApi.Device.Mode Configuration

This mode allos to access the file system.

Dialog

public static final DeviceApi.Device.Mode Dialog

This mode is deprecated.

PadOpenSign

public static final DeviceApi.Device.Mode PadOpenSign

PadOpenDirect

public static final DeviceApi.Device.Mode PadOpenDirect

Boot

public static final DeviceApi.Device.Mode Boot

Suspend

public static final DeviceApi.Device.Mode Suspend

SignConfirm

public static final DeviceApi.Device.Mode SignConfirm

In the signature confirm mode the device waits for a physical confirmation from the signer, that is, the person wielding the pen.

DocumentSign

public static final DeviceApi.Device.Mode DocumentSign

The sign in document mode.

SimpleDialogSign

public static final DeviceApi.Device.Mode SimpleDialogSign

The simple dialog sign mode.

Method Detail

values

public static DeviceApi.Device.Mode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (DeviceApi.Device.Mode c : DeviceApi.Device.Mode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static DeviceApi.Device.Mode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null