de.softpro.signware.SPTablet Class Reference

Inheritance diagram for de.softpro.signware.SPTablet:

List of all members.

---

Detailed Description

Tablet object.

This class interfaces with the tablet hardware. It allows for connecting to a tablet and for listening for tablet events.

Operating Systems:

Windows (Win32)

Public Member Functions
final void	acquire (java.awt.Component parent) throws SPSignwareException
	Enter acquiry mode.
final void	acquireDone () throws SPSignwareException
	Leave acquiry mode.
final void	clearBackgroundImage (int iImFlags) throws SPSignwareException
	Clear the background image of a tablet that includes a LCD display.
final void	connect () throws SPSignwareException
	Enter connect mode.
final void	disconnect () throws SPSignwareException
	Leave connect mode.
void	dispose ()
final int	getDevice () throws SPSignwareException
	Query the device id.
String	getDeviceStr ()
	Query the device as a String.
int	getDisplayType () throws SPSignwareException
	Query the display type of the tablet used by this SPTablet object.
final int	getDriver () throws SPSignwareException
	Query the driver id.
String	getDriverStr ()
	Query the driver as a String.
final int	getFlags () throws SPSignwareException
	Query device flags.
String	getHardwareName () throws SPSignwareException
	Query the hardware file name.
final int	getLCDBitsPerPixel () throws SPSignwareException
	Query the bits per pixel of the LCD screen.
final Dimension	getLCDSize () throws SPSignwareException
	Query the size of the LCD screen.
final int	getMaxPressure () throws SPSignwareException
	Query the device pressure range.
final byte[]	getPadSerial () throws SPSignwareException
	Query the tablet serial identification.
final Dimension	getPhysicalSize () throws SPSignwareException
	Query the device size [in mm].
final int	getResolution (int iDetail) throws SPSignwareException
	Query the device resolution.
final int	getResolution () throws SPSignwareException
	Query the logical device resolution.
final int	getSampleRate (int iDetail) throws SPSignwareException
	Query the device sample rate.
final int	getSampleRate () throws SPSignwareException
	Query the logical device sample rate.
final int	getState () throws SPSignwareException
	Query device state.
final Dimension	getTabletSize () throws SPSignwareException
	Query the device size in pixel according to the actual device resolution.
int	getTabletType () throws SPSignwareException
	Query the tablet type.
final int	getTimeStamp () throws SPSignwareException
	Query the time stamp of the last tablet acquiry.
final boolean	hasExternalLCD () throws SPSignwareException
	Query if the device has an integrated lcd display.
final boolean	hasLCD () throws SPSignwareException
	Query whether the device has an LCD screen.
final boolean	hasProximity () throws SPSignwareException
	Query if the device sends position notifications when the pen is moved.
void	reloadParameters () throws SPSignwareException
	Reload the tablet characteristics.
final void	setBackgroundImage (int iImFlags, byte[] pucImage) throws SPSignwareException
	Set the background image of a tablet that includes a LCD display.
final void	setBackgroundImage (byte[] pucImage) throws SPSignwareException
	Set the background image of a tablet that includes a LCD display.
void	setClipRectangle (int iLeft, int iTop, int iRight, int iBottom) throws SPSignwareException
	Set the clipping rectangle.
final void	setDevice (int iDevice) throws SPSignwareException
	Set the device id.
void	setDisplayType (int iDisplay) throws SPSignwareException
	Set the display type of the tablet used by this SPTablet object.
final void	setDriver (int iDriver) throws SPSignwareException
	Set the driver id.
final void	setFlags (int iFlags) throws SPSignwareException
	Set device flags.
final void	setLCD (int iLCD) throws SPSignwareException
	Set the device has an LCD screen.
void	setListener (SPTabletEventListener aListener) throws SPSignwareException
	Register a listener for tablet events.
final void	setMaxPressure (int iMaxPressure) throws SPSignwareException
	Set the device pressure range.
final void	setPadSerial (byte padSerial[]) throws SPSignwareException
	Set the tablet serial identification.
final void	setResolution (int iResolution) throws SPSignwareException
	Set the logical device resolution.
final void	setSampleRate (int iSampleRate) throws SPSignwareException
	Set the logical device sample rate.
void	setTabletOption (String strName, int iValue) throws SPSignwareException
	Set a tablet parameter.
final void	setTabletSize (int iWidth, int iHeight) throws SPSignwareException
	Set the device size.
void	setTicket (SPTicket spTicket) throws SPSignwareException
	Pass a license for one or more signature captures.
	SPTablet (SPPropertyMap spDescriptor) throws SPSignwareException
	Create a Tablet object based on a property map.
	SPTablet (String strTabletAlias) throws SPSignwareException
	Create a Tablet object based on an Alias.
	SPTablet (String strTabletClass, String strConfig) throws SPSignwareException
	Create a Tablet object that is connected to a specific tablet driver.
	SPTablet (int iDriverId) throws SPSignwareException
	Create a Tablet object that is connected to a specific tablet driver.
final void	switchSerialType (int iSerialType) throws SPSignwareException
	Chooses a different type of serial ID to be returned by getPadSerial.
String	toString ()
	Query a String representation of this object.
Static Public Member Functions
static SPTablet	create (long spTablet) throws SPSignwareException
	Create a weak SPTablet object based on an existing handle within another object, such as SPGuiAcqu.
static String	getDeviceStr (int deviceId) throws SPSignwareException
	Query the device as a String.
static String	getDriverStr (int driverId) throws SPSignwareException
	Query the driver as a String.
static int	getXInputDeviceCount () throws SPSignwareException
static String	getXInputDeviceName (int iIndex) throws SPSignwareException
static void	reset (boolean bReset) throws SPSignwareException
	Reset the tablet hardware.
Static Public Attributes
static final int	SP_ACQUIRE_RETURN_IMMEDIATELY = 2
	Flag for setFlags(): return immediately from acquire.
static final int	SP_ACQUIRE_TRANSFER_0_VECTORS = 8
	Flag for setFlags(): send all vectors having a pressure value of 0.
static final int	SP_ACTIVE_IMAGE = 0
	Image destination on the tablet: active image.
static final int	SP_BAMBOO_DEV = 23
	Wacom Bamboo Tablet.
static final int	SP_BLUEM_DEV = 16
	Stepover blueM II without LCD Tablet.
static final int	SP_BLUEMLCD_DEV = 17
	Stepover blueM II with LCD Tablet.
static final int	SP_DONT_ECHO_STROKES = 0x10
	Flag for setFlags(): don't echo strokes on the tablet LCD.
static final int	SP_EID2_DEV = 21
	Interlink EPad-ID Pro Tablet.
static final int	SP_EID_DEV = 12
	Interlink EPad-ID Tablet.
static final int	SP_EINK2_DEV = 20
	Interlink EPad-Ink Pro Tablet.
static final int	SP_EINK_DEV = 8
	Interlink ePad-ink tablet.
static final int	SP_EPAD2_DEV = 15
	Interlink ePad II Tablet.
static final int	SP_EPADLS_DEV = 19
	Interlink EPad-LS Tablet.
static final int	SP_EPOS_DEV = 6
	Interlink ePad POS tablet.
static final int	SP_ESIG_DEV = 7
	Interlink ePad E-Signature tablet.
static final int	SP_GRAPHIRE_DEV = 3
	Wacom Graphire tablet.
static final int	SP_HESY_DEV = 4
	BS Hesy tablet.
static final int	SP_IDLE_IMAGE = 1
	Image destination on the tablet: idle image.
static final int	SP_IMMEDIATE_IMAGE = 2
	Image destination on the tablet: immediate image.
static final int	SP_INTUOS_DEV = 1
	Wacom Intuos tablet.
static final int	SP_MOBINETIX_DEV = 2
	MobiNetix tablet.
static final int	SP_MTLCD_DEV = 13
	MotionTouch LegaPad LCD Tablet.
static final int	SP_MTLPD_DEV = 14
	MotionTouch LegaPad Tablet.
static final int	SP_NATIVE_DRV = 3
	Kofax native driver.
static final int	SP_PADCOM_DRV = 2
	MobiNetix driver.
static final int	SP_PENPARTNER_DEV = 9
	Wacom PenPartner tablet.
static final int	SP_PL400_DEV = 5
	Wacom PL400 tablet.
static final int	SP_REMOTETABLET_DRV = 6
	Kofax remote driver.
static final int	SP_SIGNPAD_DEV = 22
	Wacom SIGNPAD Tablet.
static final int	SP_STEPOVER_DEV = 11
	StepOver Tablet.
static final int	SP_SYNCHRONOUS_START_ACQUIRE = 0x40
	Flag for setFlags(): execute acquire synchronously.
static final int	SP_TABLET_HARDWARE_AS_VIRTUAL_BUTTONS = 2
	The connected tablet has builtin virtual buttons. A click on a virtual button is passed as a hardware button notification.
static final int	SP_TABLET_LCD_DISPLAY = 1
	SPTablet display type of the connected tablet, the tablet has an integrated LCD display, e.g. Wacom Signpad (STU-500).
static final int	SP_TABLET_LOGICAL = 2
	Request a logical tablet property.
static final int	SP_TABLET_NO_DISPLAY = 0
	SPTablet display type of the connected tablet, the tablet has no display, e.g. Wacom Intuos.
static final int	SP_TABLET_NO_REALTIME_VECTORS = 1
	The connected tablet cannot send signature strokes (vectors) in real time but rather sends all vectors in a block at the end of the capture process.
static final int	SP_TABLET_PC_DISPLAY = 2
	SPTablet display type of the connected tablet, the tablet is integrated into the PC's display, e.g. TabletPC.
static final int	SP_TABLET_PHYSICAL = 1
	Request a physical tablet property.
static final int	SP_TABLET_STATE_ACQUIRE = 2
	Tablet state acquiring.
static final int	SP_TABLET_STATE_CONNECT = 1
	Tablet state connected.
static final int	SP_TABLET_STATE_IDLE = 0
	Tablet state idle.
static final int	SP_TABLETPC_DEV = 10
	Tablet PC.
static final int	SP_TABLETSERVER_DRV = 5
	Kofax TabletServer driver.
static final int	SP_TCP_DRV = 4
	Kofax remote driver.
static final int	SP_TZSE_DEV = 18
	Topaz pressure sensitive SE devices.
static final int	SP_UNKNOWN_DEV = 0
	Unknown tablet device.
static final int	SP_UNKNOWN_DRV = 0
	Unknown driver.
static final int	SP_VERIFONE_MX_DEV = 24
	Verifone MX 800 series.
static final int	SP_WINTAB_DRV = 1
	Wintab driver.
Package Functions
final native int	jniFree ()

---

Constructor & Destructor Documentation

de.softpro.signware.SPTablet.SPTablet (  int  iDriverId  )  throws SPSignwareException

Create a Tablet object that is connected to a specific tablet driver. Please read Tablet creation options Parameters: iDriverId  [i] the driver id Exceptions: SPSignwareException  if an error occured Operating Systems: Windows (Win32) See also: SP_UNKNOWN_DRV, SP_WINTAB_DRV SPSignwareException.SP_LINKLIBRARYERR SPTabletCreate

de.softpro.signware.SPTablet.SPTablet (  String  strTabletClass, String  strConfig )  throws SPSignwareException

Create a Tablet object that is connected to a specific tablet driver. Please read Tablet creation options for a list of supported options Parameters: strTabletClass  [i] class name of Kofax tablet access module. strConfig  [i] pass optional configuration data. Configuration data depends on the detected hardware driver, see Installation and configuration of various pads Exceptions: SPSignwareException  if an error occured Operating Systems: Windows (Win32) See also: SPSignwareException.SP_LINKLIBRARYERR SPTabletCreateEx

de.softpro.signware.SPTablet.SPTablet (  String  strTabletAlias  )  throws SPSignwareException

Create a Tablet object based on an Alias. Please read Tablet creation options for resolving the Alias Parameters: strTabletAlias  [i] alias name of the desired tablet hardware. Exceptions: SPSignwareException  if an error occured Operating Systems: Windows (Win32) See also: SPSignwareException.SP_LINKLIBRARYERR SPTabletCreateByAlias

de.softpro.signware.SPTablet.SPTablet (  SPPropertyMap  spDescriptor  )  throws SPSignwareException

Create a Tablet object based on a property map. Please read Tablet creation options for resolving the Alias Note: This function creates a default tablet if spDescriptor is null Parameters: spDescriptor  [i] property map as returned from SPTabletEnum. Exceptions: SPSignwareException  if an error occured Operating Systems: Windows (Win32) See also: SPSignwareException.SP_LINKLIBRARYERR SPTabletCreateByEnum

---

Member Function Documentation

final void de.softpro.signware.SPTablet.acquire (  java.awt.Component  parent  )  throws SPSignwareException

Enter acquiry mode. parent must be a valid Java component, otherwise events cannot be processed! Parameters: parent  [i] the parent component Exceptions: SPSignwareException  if an error occured Operating Systems: Windows (Win32) See also: SPSignwareException.SP_LINKLIBRARYERR SPTabletAcquire

final void de.softpro.signware.SPTablet.acquireDone (   )  throws SPSignwareException

Leave acquiry mode. Exceptions: SPSignwareException  if an error occured Operating Systems: Windows (Win32) See also: SPSignwareException.SP_LINKLIBRARYERR SPTabletAcquireDone

final void de.softpro.signware.SPTablet.clearBackgroundImage (  int  iImFlags  )  throws SPSignwareException

Clear the background image of a tablet that includes a LCD display. Parameters: iImFlags  [i] image destination, either SP_ACTIVE_IMAGE or SP_IDLE_IMAGE or SP_IMMEDIATE_IMAGE Exceptions: SPSignwareException  on error SP_UNSUPPORTEDERR the tablet does not support images SP_PARAMERR any parameter was was wrong, or the image could not be read SP_LINKLIBRARYERR external modules could not be loaded Operating Systems: Windows (Win32)

final void de.softpro.signware.SPTablet.connect (   )  throws SPSignwareException

Enter connect mode. Exceptions: SPSignwareException  if an error occured Operating Systems: Windows (Win32) See also: SPSignwareException.SP_LINKLIBRARYERR SPTabletConnect

static SPTablet de.softpro.signware.SPTablet.create (  long  spTablet  )  throws SPSignwareException [static]

Create a weak SPTablet object based on an existing handle within another object, such as SPGuiAcqu. This object may be destroyed by the object owner, possibly without notifiction. Parameters: spTablet  [i] handle to an existing SPTablet object Exceptions: SPSignwareException  if an error occured Operating Systems: Windows (Win32) Returns: SPTablet an instance of a SPTablet object

final void de.softpro.signware.SPTablet.disconnect (   )  throws SPSignwareException

Leave connect mode. Exceptions: SPSignwareException  if an error occured Operating Systems: Windows (Win32) See also: SPSignwareException.SP_LINKLIBRARYERR SPTabletDisconnect

void de.softpro.signware.SPTablet.dispose (   )

Reimplemented from de.softpro.signware.SPSignwareObject.

final int de.softpro.signware.SPTablet.getDevice (   )  throws SPSignwareException

Query the device id. Returns: int the device id Exceptions: SPSignwareException  if an error occured Operating Systems: Windows (Win32) See also: SP_UNKNOWN_DEV, SP_INTUOS_DEV, SP_GRAPHIRE_DEV, SP_PL400_DEV SP_EPOS_DEV, SP_ESIG_DEV, SP_EINK_DEV, SP_TABLETPC_DEV, SP_EID_DEV SPSignwareException.SP_LINKLIBRARYERR SPTabletGetDevice

String de.softpro.signware.SPTablet.getDeviceStr (   )

Query the device as a String. Returns: String representation of the device used in this object Operating Systems: Windows (Win32)

static String de.softpro.signware.SPTablet.getDeviceStr (  int  deviceId  )  throws SPSignwareException [static]

Query the device as a String. Returns: String representation of the device used in this object Exceptions: SPSignwareException  on error Operating Systems: Windows (Win32)

int de.softpro.signware.SPTablet.getDisplayType (   )  throws SPSignwareException

Query the display type of the tablet used by this SPTablet object. SPTablet differentiates 3 types of tablet displays SP_TABLET_NO_DISPLAY: tablets without a screen (such as Wacom Intuos) SP_TABLET_LCD_DISPLAY: tablets with an integrated LCD screen (such as Wacom Signpad) SP_TABLET_PC_DISPLAY: PCs with integrated tablet functionality (such as TabletPC) Returns: the display type of the tablet SP_TABLET_NO_DISPLAY SP_TABLET_LCD_DISPLAY SP_TABLET_PC_DISPLAY Exceptions: SPSignwareException  if an error occured Since: Version 2.5 Operating Systems: Windows (Win32) See also: SPTabletSetDisplayType, SPTabletSetDisplayType, setDisplayType

final int de.softpro.signware.SPTablet.getDriver (   )  throws SPSignwareException

Query the driver id. Returns: int the driver id Exceptions: SPSignwareException  if an error occured Operating Systems: Windows (Win32) See also: SP_UNKNOWN_DRV, SP_WINTAB_DRV SPSignwareException.SP_LINKLIBRARYERR SPTabletGetDriver

String de.softpro.signware.SPTablet.getDriverStr (   )

Query the driver as a String. Returns: String representation of the driver used in this object Operating Systems: Windows (Win32)

static String de.softpro.signware.SPTablet.getDriverStr (  int  driverId  )  throws SPSignwareException [static]

Query the driver as a String. Returns: String representation of the driver used in this object Exceptions: SPSignwareException  on error Operating Systems: Windows (Win32)

final int de.softpro.signware.SPTablet.getFlags (   )  throws SPSignwareException

Query device flags. Returns: the current flags, a bitwise or of these values: SP_ACQUIRE_TRANSFER_0_VECTORS SP_ACQUIRE_RETURN_IMMEDIATELY SP_DONT_ECHO_STROKES Exceptions: SPSignwareException  if an error occured Operating Systems: Windows (Win32) See also: SPSignwareException.SP_LINKLIBRARYERR SPTabletGetFlags SP_ACQUIRE_TRANSFER_0_VECTORS, SP_ACQUIRE_RETURN_IMMEDIATELY, SP_DONT_ECHO_STROKES

String de.softpro.signware.SPTablet.getHardwareName (   )  throws SPSignwareException

Query the hardware file name. Not all devices pass the hardware file name (currently only Wacom SIGNPAD). Returns: String representation of the hardware file name Exceptions: SPSignwareException  on error Since: Version 2.5 Operating Systems: Windows (Win32) See also: SPTabletGetHardwareName

final int de.softpro.signware.SPTablet.getLCDBitsPerPixel (   )  throws SPSignwareException

Query the bits per pixel of the LCD screen. Returns: int bits per pixel Exceptions: SPSignwareException  if an error occured Operating Systems: Windows (Win32) See also: SPSignwareException.SP_LINKLIBRARYERR SPTabletGetLCDBitsPerPixel, setBackgroundImage

final Dimension de.softpro.signware.SPTablet.getLCDSize (   )  throws SPSignwareException

Query the size of the LCD screen. Returns: Dimension size of the lcd screen in pixel Exceptions: SPSignwareException  if an error occured Operating Systems: Windows (Win32) See also: SPSignwareException.SP_LINKLIBRARYERR SPTabletGetLCDSize, setBackgroundImage

final int de.softpro.signware.SPTablet.getMaxPressure (   )  throws SPSignwareException

Query the device pressure range. Returns: int the pressure range Exceptions: SPSignwareException  if an error occured Operating Systems: Windows (Win32) See also: SPSignwareException.SP_LINKLIBRARYERR SPTabletGetMaxPressure

final byte [] de.softpro.signware.SPTablet.getPadSerial (   )  throws SPSignwareException

Query the tablet serial identification. The size of a tablet serial ID is limited to 20 bytes within the SignWare data structures, more limitations may apply depending on the tablet, see SPTabletGetPadSerial. See SPTabletGetPadSerial for limitations depending on specific tablet models. Returns: byte[] the tablet serial identification Exceptions: SPSignwareException  if an error occured Operating Systems: Windows (Win32) See also: SPTabletGetPadSerial setPadSerial

final Dimension de.softpro.signware.SPTablet.getPhysicalSize (   )  throws SPSignwareException

Query the device size [in mm]. Returns: Dimension size of the tablet in mm Exceptions: SPSignwareException  if an error occured Operating Systems: Windows (Win32) See also: SPSignwareException.SP_LINKLIBRARYERR SPTabletGetPhysicalSize

final int de.softpro.signware.SPTablet.getResolution (  int  iDetail  )  throws SPSignwareException

Query the device resolution. Parameters: iDetail  [i] query the physical (SP_TABLET_PHYSICAL) or logical (SP_TABLET_LOGICAL) resolution Returns: int the resolution Exceptions: SPSignwareException  if an error occured Operating Systems: Windows (Win32) See also: SPSignwareException.SP_LINKLIBRARYERR SPTabletGetResolution Since: Version 3.2.2

final int de.softpro.signware.SPTablet.getResolution (   )  throws SPSignwareException

Query the logical device resolution. Returns: int the resolution Exceptions: SPSignwareException  if an error occured Operating Systems: Windows (Win32) See also: SPSignwareException.SP_LINKLIBRARYERR SPTabletGetResolution

final int de.softpro.signware.SPTablet.getSampleRate (  int  iDetail  )  throws SPSignwareException

Query the device sample rate. Parameters: iDetail  [i] query the physical (SP_TABLET_PHYSICAL) or logical (SP_TABLET_LOGICAL) samplerate Returns: int the sample rate Exceptions: SPSignwareException  if an error occured Operating Systems: Windows (Win32) See also: SPSignwareException.SP_LINKLIBRARYERR SPTabletGetSampleRate Since: Version 3.2.2

final int de.softpro.signware.SPTablet.getSampleRate (   )  throws SPSignwareException

Query the logical device sample rate. Returns: int the sample rate Exceptions: SPSignwareException  if an error occured Operating Systems: Windows (Win32) See also: SPSignwareException.SP_LINKLIBRARYERR SPTabletGetSampleRate

final int de.softpro.signware.SPTablet.getState (   )  throws SPSignwareException

Query device state. Returns: the current state, one of these values: SP_TABLET_STATE_IDLE SP_TABLET_STATE_CONNECT SP_TABLET_STATE_ACQUIRE Exceptions: SPSignwareException  if an error occured Operating Systems: Windows (Win32) See also: SPSignwareException.SP_LINKLIBRARYERR SPTabletGetState SP_TABLET_STATE_IDLE, SP_TABLET_STATE_CONNECT, SP_TABLET_STATE_ACQUIRE

final Dimension de.softpro.signware.SPTablet.getTabletSize (   )  throws SPSignwareException

Query the device size in pixel according to the actual device resolution. Returns: Dimension size of the tablet in tablet coordinates Exceptions: SPSignwareException  if an error occured Operating Systems: Windows (Win32) See also: SPSignwareException.SP_LINKLIBRARYERR SPTabletGetTabletSize

int de.softpro.signware.SPTablet.getTabletType (   )  throws SPSignwareException

Query the tablet type. Returns: int the tablet type Exceptions: SPSignwareException  on error Since: Version 2.6.2 Operating Systems: Windows (Win32) See also: SPTabletGetTabletType

final int de.softpro.signware.SPTablet.getTimeStamp (   )  throws SPSignwareException

Query the time stamp of the last tablet acquiry. Returns: int the time stamp (seconds since 1st Jan 1970, UTC) Exceptions: SPSignwareException  if an error occured Operating Systems: Windows (Win32) See also: SPSignwareException.SP_LINKLIBRARYERR SPTabletGetTimeStamp

static int de.softpro.signware.SPTablet.getXInputDeviceCount (   )  throws SPSignwareException [static]

static String de.softpro.signware.SPTablet.getXInputDeviceName (  int  iIndex  )  throws SPSignwareException [static]

final boolean de.softpro.signware.SPTablet.hasExternalLCD (   )  throws SPSignwareException

Query if the device has an integrated lcd display. Returns: boolean device does not have an integrated lcd display Exceptions: SPSignwareException  if an error occured Deprecated: This function is replaced by de.softpro.signware.SPTablet.getDisplayType Operating Systems: Windows (Win32) See also: SPSignwareException.SP_LINKLIBRARYERR getDisplayType

final boolean de.softpro.signware.SPTablet.hasLCD (   )  throws SPSignwareException

Query whether the device has an LCD screen. Returns: boolean true if the tablet has an LCD screen Exceptions: SPSignwareException  if an error occured Operating Systems: Windows (Win32) See also: SPSignwareException.SP_LINKLIBRARYERR getDisplayType Deprecated: This function is replaced by de.softpro.signware.SPTablet.getDisplayType

final boolean de.softpro.signware.SPTablet.hasProximity (   )  throws SPSignwareException

Query if the device sends position notifications when the pen is moved. Returns: boolean device does not send notifications when the pen is moved Exceptions: SPSignwareException  if an error occured Operating Systems: Windows (Win32) See also: SPSignwareException.SP_LINKLIBRARYERR SPTabletHasProximity

final native int de.softpro.signware.SPTablet.jniFree (   )  [package, virtual]

Implements de.softpro.signware.SPSignwareObject.

void de.softpro.signware.SPTablet.reloadParameters (   )  throws SPSignwareException

Reload the tablet characteristics. Tablet characteristics are typically bound to the hardware and do not change, except for TabletPCs where the screen resolution or screen orientation might change. Both screen resolution and orientation must be considered to calculate the physical tablet width / height and tablet LCD width and height. Applications that support display resolution or orientation changes while acquiring a signature should call SPTabletReloadParameters while or after processing the WM_DISPLAYCHANGE message. Exceptions: SPSignwareException  on error Since: Version 2.5 Operating Systems: Windows (Win32) See also: SPTabletReloadParameters

static void de.softpro.signware.SPTablet.reset (  boolean  bReset  )  throws SPSignwareException [static]

Reset the tablet hardware. Parameters: bReset  [i] must be true Exceptions: SPSignwareException  Operating Systems: Windows (Win32) See also: SPTabletReset

final void de.softpro.signware.SPTablet.setBackgroundImage (  int  iImFlags, byte[]  pucImage )  throws SPSignwareException

Set the background image of a tablet that includes a LCD display. Parameters: iImFlags  [i] image destination, either SP_ACTIVE_IMAGE or SP_IDLE_IMAGE or SP_IMMEDIATE_IMAGE pucImage  [i] the image data, most standard image formats such as BMP, TIF, JPG, GIF CCITT4 etc are supported Exceptions: SPSignwareException  on error SP_UNSUPPORTEDERR the tablet does not support images SP_PARAMERR any parameter was was wrong, or the image could not be read SP_LINKLIBRARYERR external modules could not be loaded Operating Systems: Windows (Win32)

final void de.softpro.signware.SPTablet.setBackgroundImage (  byte[]  pucImage  )  throws SPSignwareException

Set the background image of a tablet that includes a LCD display. Parameters: pucImage  [i] the image data, most standard image formats such as BMP, TIF, JPG, GIF CCITT4 etc are supported Exceptions: SPSignwareException  on error SP_UNSUPPORTEDERR the tablet does not support images SP_PARAMERR any parameter was was wrong, or the image could not be read SP_LINKLIBRARYERR external modules could not be loaded Operating Systems: Windows (Win32)

void de.softpro.signware.SPTablet.setClipRectangle (  int  iLeft, int  iTop, int  iRight, int  iBottom )  throws SPSignwareException

Set the clipping rectangle. Parameters: iLeft  [i] the left corner, in ppm (1/1000, thousands) iTop  [i] the top corner, in ppm (1/1000, thousands) iRight  [i] the right corner, in ppm (1/1000, thousands) iBottom  [i] the bottom corner, in ppm (1/1000, thousands) Exceptions: SPSignwareException  on error Operating Systems: Windows (Win32) See also: SPTabletSetClipRectangle

final void de.softpro.signware.SPTablet.setDevice (  int  iDevice  )  throws SPSignwareException

Set the device id. You should normally not need to set the device id. Parameters: iDevice  [i] the new device id Exceptions: SPSignwareException  if an error occured Operating Systems: Windows (Win32) See also: SP_UNKNOWN_DEV, SP_INTUOS_DEV, SP_GRAPHIRE_DEV, SP_PL400_DEV SP_EPOS_DEV, SP_ESIG_DEV, SP_EINK_DEV, SP_TABLETPC_DEV, SP_EID_DEV SPSignwareException.SP_LINKLIBRARYERR SPTabletSetDevice

void de.softpro.signware.SPTablet.setDisplayType (  int  iDisplay  )  throws SPSignwareException

Set the display type of the tablet used by this SPTablet object. SPTablet differentiates 3 types of tablet displays SP_TABLET_NO_DISPLAY: tablets without a screen (such as Wacom Intuos) SP_TABLET_LCD_DISPLAY: tablets with an integrated LCD screen (such as Wacom Signpad) SP_TABLET_PC_DISPLAY: PCs with integrated tablet functionality (such as TabletPC) Parameters: iDisplay  [i] the display type of the tablet SP_TABLET_NO_DISPLAY SP_TABLET_LCD_DISPLAY SP_TABLET_PC_DISPLAY Exceptions: SPSignwareException  if an error occured Since: Version 2.5 Operating Systems: Windows (Win32) See also: SPTabletSetDisplayType, SPTabletSetDisplayType, getDisplayType

final void de.softpro.signware.SPTablet.setDriver (  int  iDriver  )  throws SPSignwareException

Set the driver id. You should normally not need to set the driver id. Parameters: iDriver  [i] the new driver id Exceptions: SPSignwareException  if an error occured Operating Systems: Windows (Win32) See also: SP_UNKNOWN_DRV, SP_WINTAB_DRV SPSignwareException.SP_LINKLIBRARYERR SPTabletSetDriver

final void de.softpro.signware.SPTablet.setFlags (  int  iFlags  )  throws SPSignwareException

Set device flags. Parameters: iFlags  [i] the new flags SP_ACQUIRE_TRANSFER_0_VECTORS SP_ACQUIRE_RETURN_IMMEDIATELY SP_DONT_ECHO_STROKES Exceptions: SPSignwareException  if an error occured Operating Systems: Windows (Win32) See also: SPSignwareException.SP_LINKLIBRARYERR SPTabletSetFlags SP_ACQUIRE_TRANSFER_0_VECTORS, SP_ACQUIRE_RETURN_IMMEDIATELY, SP_DONT_ECHO_STROKES

final void de.softpro.signware.SPTablet.setLCD (  int  iLCD  )  throws SPSignwareException

Set the device has an LCD screen. You should normally not need to set the device LCD mode. Parameters: iLCD  [i] the new LCD mode Exceptions: SPSignwareException  if an error occured Deprecated: This function is replaced by de.softpro.signware.SPTablet.setDisplayType Operating Systems: Windows (Win32) See also: SPSignwareException.SP_LINKLIBRARYERR setDisplayType

void de.softpro.signware.SPTablet.setListener (  SPTabletEventListener  aListener  )  throws SPSignwareException

Register a listener for tablet events. Parameters: aListener  [i] the event sink, implements either SPTabletEventListener or SPTabletEventListener2 Exceptions: SPSignwareException  Operating Systems: Windows (Win32) See also: SPTabletEventListener, SPTabletEventListener2

final void de.softpro.signware.SPTablet.setMaxPressure (  int  iMaxPressure  )  throws SPSignwareException

Set the device pressure range. You should normally not need to set the device pressure range. Parameters: iMaxPressure  [i] the new pressure range Exceptions: SPSignwareException  if an error occured Operating Systems: Windows (Win32) See also: SPSignwareException.SP_LINKLIBRARYERR SPTabletSetMaxPressure

final void de.softpro.signware.SPTablet.setPadSerial (  byte  padSerial[]  )  throws SPSignwareException

Set the tablet serial identification. The size of a tablet serial ID is limited to 20 bytes within the SignWare data structures, more limitations may apply depending on the tablet, see SPTabletSetPadSerial. See SPTabletSetPadSerial for limitations depending on specific tablet models Parameters: padSerial  the tablet serial identification Exceptions: SPSignwareException  if an error occured Operating Systems: Windows (Win32) See also: SPTabletSetPadSerial getPadSerial

final void de.softpro.signware.SPTablet.setResolution (  int  iResolution  )  throws SPSignwareException

Set the logical device resolution. You should normally not need to set the device resolution. Parameters: iResolution  [i] the new resolution Exceptions: SPSignwareException  if an error occured Operating Systems: Windows (Win32) See also: SPSignwareException.SP_LINKLIBRARYERR SPTabletSetResolution

final void de.softpro.signware.SPTablet.setSampleRate (  int  iSampleRate  )  throws SPSignwareException

Set the logical device sample rate. You should normally not need to set the device sample rate. Parameters: iSampleRate  [i] the new sample rate Exceptions: SPSignwareException  if an error occured Operating Systems: Windows (Win32) See also: SPSignwareException.SP_LINKLIBRARYERR SPTabletSetResolution

void de.softpro.signware.SPTablet.setTabletOption (  String  strName, int  iValue )  throws SPSignwareException

Set a tablet parameter. For details please see SPTabletSetTabletOption Options can only be passed to the tablet when the tablet is in state SP_TABLET_STATE_CONNECT. Parameters: strName  [i] the name / identifier of the option to set, must be one of the following: "BackgroundColor" the background color of the tablet display Currently only supported on Signpad STU-520 "ForegroundColor" the foreground color of the tablet display, pen strokes are drawn in foreground color Currently only supported on Signpad STU-520 "PenThickness" Pen thickness is used to render strokes on the tablet LCD. Currently only supported on Signpad STU-520 iValue  [i] Value of the addressed option Exceptions: SPSignwareException  on error Errors: SP_PARAMERR invalid parameter SP_UNSUPPORTEDERR unsupported for the device Operating Systems: Windows (Win32)

final void de.softpro.signware.SPTablet.setTabletSize (  int  iWidth, int  iHeight )  throws SPSignwareException

Set the device size. You should normally not need to set the device size. Parameters: iWidth  [i] the new width iHeight  [i] the new height Exceptions: SPSignwareException  if an error occured Operating Systems: Windows (Win32) See also: SPSignwareException.SP_LINKLIBRARYERR SPTabletSetSize

void de.softpro.signware.SPTablet.setTicket (  SPTicket  spTicket  )  throws SPSignwareException

Pass a license for one or more signature captures. You must pass the ticket before you connect with the tablet. The ticket must have been charged for usage SPTicket.ticket_capture. Deprecated: Please use a license key. Parameters: spTicket  [i] a valid and charged ticket Exceptions: SPSignwareException  Operating Systems: Windows (Win32)

final void de.softpro.signware.SPTablet.switchSerialType (  int  iSerialType  )  throws SPSignwareException

Chooses a different type of serial ID to be returned by getPadSerial. Parameters: iSerialType  [i] SP_TABLET_SERIAL_TYPE_DEFAULT: custom settable device ID if available, the factory set ID otherwise. SP_TABLET_SERIAL_TYPE_CUSTOM: use custom settable device ID. SP_TABLET_SERIAL_TYPE_FACTORY: use factory set device ID. Exceptions: SPSignwareException  if an error occured

String de.softpro.signware.SPTablet.toString (   )

Query a String representation of this object. Returns: String representation of this object Operating Systems: Windows (Win32)

---

Member Data Documentation

final int de.softpro.signware.SPTablet.SP_ACQUIRE_RETURN_IMMEDIATELY = 2 [static]

Flag for setFlags(): return immediately from acquire. If this flag is set, acquire will return immediately. If this flag is not set, acquire will not return until acquireDone is called. Note: Currently, this flag is assumed to be always set under Linux. See also: acquire, acquireDone, setFlags

final int de.softpro.signware.SPTablet.SP_ACQUIRE_TRANSFER_0_VECTORS = 8 [static]

Flag for setFlags(): send all vectors having a pressure value of 0. If this flag is set, acquire will send all vectors (samples) that have a pressure value of 0. If this flag is not set, acquire will send only one vector having a pressure value of 0 for a sequence of vectors having a pressure value of 0. See also: acquire, setFlags

final int de.softpro.signware.SPTablet.SP_ACTIVE_IMAGE = 0 [static]

Image destination on the tablet: active image. Note: The active image is displayed while capturing a signature

final int de.softpro.signware.SPTablet.SP_BAMBOO_DEV = 23 [static]

Wacom Bamboo Tablet. identifier for an Wacom Bamboo tablet

final int de.softpro.signware.SPTablet.SP_BLUEM_DEV = 16 [static]

Stepover blueM II without LCD Tablet. Identifier for a Stepover blueM II without LCD Tablet

final int de.softpro.signware.SPTablet.SP_BLUEMLCD_DEV = 17 [static]

Stepover blueM II with LCD Tablet. Identifier for a Stepover blueM II tablet with integrated LCD

final int de.softpro.signware.SPTablet.SP_DONT_ECHO_STROKES = 0x10 [static]

Flag for setFlags(): don't echo strokes on the tablet LCD. If this flag is set, strokes won't be echoed to the tablet LCD. If this flag is not set, strokes will be echoed to the tablet LCD This flag is ignored for tablets that don't have an LCD. See also: acquire, setFlags

final int de.softpro.signware.SPTablet.SP_EID2_DEV = 21 [static]

Interlink EPad-ID Pro Tablet. identifier for an Interlink EPad-ID Pro tablet

final int de.softpro.signware.SPTablet.SP_EID_DEV = 12 [static]

Interlink EPad-ID Tablet. Identifier for an Interlink EPad-ID Tablet

final int de.softpro.signware.SPTablet.SP_EINK2_DEV = 20 [static]

Interlink EPad-Ink Pro Tablet. identifier for an Interlink EPad-Ink Pro tablet

final int de.softpro.signware.SPTablet.SP_EINK_DEV = 8 [static]

Interlink ePad-ink tablet. Identifier for an Interlink ePad-ink E-Signature tablet

final int de.softpro.signware.SPTablet.SP_EPAD2_DEV = 15 [static]

Interlink ePad II Tablet. Identifier for a Interlink ePad II non LCD Tablet

final int de.softpro.signware.SPTablet.SP_EPADLS_DEV = 19 [static]

Interlink EPad-LS Tablet. identifier for an Interlink EPad-LS tablet

final int de.softpro.signware.SPTablet.SP_EPOS_DEV = 6 [static]

Interlink ePad POS tablet. Identifier for an Interlink ePad Point Of Sales tablet

final int de.softpro.signware.SPTablet.SP_ESIG_DEV = 7 [static]

Interlink ePad E-Signature tablet. Identifier for an Interlink ePad E-Signature tablet

final int de.softpro.signware.SPTablet.SP_GRAPHIRE_DEV = 3 [static]

Wacom Graphire tablet. Identifier for a Wacom Graphire tablet

final int de.softpro.signware.SPTablet.SP_HESY_DEV = 4 [static]

BS Hesy tablet. Identifier for a BS Hesy tablet

final int de.softpro.signware.SPTablet.SP_IDLE_IMAGE = 1 [static]

Image destination on the tablet: idle image. Note: The idle image is displayed after disconnecting a device. Not all devices support idle images (currently only Wacom SIGNPAD)

final int de.softpro.signware.SPTablet.SP_IMMEDIATE_IMAGE = 2 [static]

Image destination on the tablet: immediate image. Note: The immediate image is displayed immediately. Not all devices support immediate images (currently only Wacom SIGNPAD)

final int de.softpro.signware.SPTablet.SP_INTUOS_DEV = 1 [static]

Wacom Intuos tablet. Identifier for a Wacom Intuos tablet

final int de.softpro.signware.SPTablet.SP_MOBINETIX_DEV = 2 [static]

MobiNetix tablet. Identifier for a MobiNetix tablet

final int de.softpro.signware.SPTablet.SP_MTLCD_DEV = 13 [static]

MotionTouch LegaPad LCD Tablet. Identifier for a Motiontouch LegaPad LCD Tablet

final int de.softpro.signware.SPTablet.SP_MTLPD_DEV = 14 [static]

MotionTouch LegaPad Tablet. Identifier for a Motiontouch LegaPad non LCD Tablet

final int de.softpro.signware.SPTablet.SP_NATIVE_DRV = 3 [static]

Kofax native driver. Identifier for a Kofax native driver

final int de.softpro.signware.SPTablet.SP_PADCOM_DRV = 2 [static]

MobiNetix driver. Identifier for a MobiNetix driver

final int de.softpro.signware.SPTablet.SP_PENPARTNER_DEV = 9 [static]

Wacom PenPartner tablet. Identifier for a Wacom PenPartner tablet

final int de.softpro.signware.SPTablet.SP_PL400_DEV = 5 [static]

Wacom PL400 tablet. Identifier for a Wacom PL400 tablet

final int de.softpro.signware.SPTablet.SP_REMOTETABLET_DRV = 6 [static]

Kofax remote driver. Identifier for a Kofax RemoteTablet driver

final int de.softpro.signware.SPTablet.SP_SIGNPAD_DEV = 22 [static]

Wacom SIGNPAD Tablet. identifier for an Wacom SIGNPAD tablet

final int de.softpro.signware.SPTablet.SP_STEPOVER_DEV = 11 [static]

StepOver Tablet. Identifier for an StepOver Tablet

final int de.softpro.signware.SPTablet.SP_SYNCHRONOUS_START_ACQUIRE = 0x40 [static]

Flag for setFlags(): execute acquire synchronously. Some tablet drivers require windows messages posted to finally start acquiry mode. The normal behaviour is to post the messages and return. Set this flag if you want the SPTablet object to wait until the messages have been processed (SPTablet will then process and dispatch windows messages). This flag is currently ignored under Linux. See also: acquire, setFlags

final int de.softpro.signware.SPTablet.SP_TABLET_HARDWARE_AS_VIRTUAL_BUTTONS = 2 [static]

The connected tablet has builtin virtual buttons. A click on a virtual button is passed as a hardware button notification. See also: getTabletType, pSPTABLETBUTTON_T

final int de.softpro.signware.SPTablet.SP_TABLET_LCD_DISPLAY = 1 [static]

SPTablet display type of the connected tablet, the tablet has an integrated LCD display, e.g. Wacom Signpad (STU-500). See also: setDisplayType, getDisplayType

final int de.softpro.signware.SPTablet.SP_TABLET_LOGICAL = 2 [static]

Request a logical tablet property. See also: getResolution, getSampleRate

final int de.softpro.signware.SPTablet.SP_TABLET_NO_DISPLAY = 0 [static]

SPTablet display type of the connected tablet, the tablet has no display, e.g. Wacom Intuos. See also: setDisplayType, getDisplayType

final int de.softpro.signware.SPTablet.SP_TABLET_NO_REALTIME_VECTORS = 1 [static]

The connected tablet cannot send signature strokes (vectors) in real time but rather sends all vectors in a block at the end of the capture process. See also: getTabletType

final int de.softpro.signware.SPTablet.SP_TABLET_PC_DISPLAY = 2 [static]

SPTablet display type of the connected tablet, the tablet is integrated into the PC's display, e.g. TabletPC. See also: setDisplayType, getDisplayType

final int de.softpro.signware.SPTablet.SP_TABLET_PHYSICAL = 1 [static]

Request a physical tablet property. See also: getResolution, getSampleRate

final int de.softpro.signware.SPTablet.SP_TABLET_STATE_ACQUIRE = 2 [static]

Tablet state acquiring. See also: getState, acquire

final int de.softpro.signware.SPTablet.SP_TABLET_STATE_CONNECT = 1 [static]

Tablet state connected. See also: getState, connect

final int de.softpro.signware.SPTablet.SP_TABLET_STATE_IDLE = 0 [static]

Tablet state idle. See also: getState

final int de.softpro.signware.SPTablet.SP_TABLETPC_DEV = 10 [static]

Tablet PC. Identifier for an Tablet PC (Pad intergrated)

final int de.softpro.signware.SPTablet.SP_TABLETSERVER_DRV = 5 [static]

Kofax TabletServer driver. Identifier for a Kofax TabletServer driver

final int de.softpro.signware.SPTablet.SP_TCP_DRV = 4 [static]

Kofax remote driver. Identifier for a Kofax remote driver

final int de.softpro.signware.SPTablet.SP_TZSE_DEV = 18 [static]

Topaz pressure sensitive SE devices. Identifier for Topaz SE devices

final int de.softpro.signware.SPTablet.SP_UNKNOWN_DEV = 0 [static]

Unknown tablet device. Identifier for an unknown tablet device

final int de.softpro.signware.SPTablet.SP_UNKNOWN_DRV = 0 [static]

Unknown driver. Identifier for an unknown tablet driver

final int de.softpro.signware.SPTablet.SP_VERIFONE_MX_DEV = 24 [static]

Verifone MX 800 series. identifier for an Verifone MX 800 series tablet

final int de.softpro.signware.SPTablet.SP_WINTAB_DRV = 1 [static]

Wintab driver. Identifier for a Wintab driver

---

The documentation for this class was generated from the following file:

• SPTablet.java