CapPlugin Class Reference

List of all members.

---

Detailed Description

Build a HTML string to instantiate the Browser plugin for the requested function.

The browser plugin requires a set off additional parameters, which may be passed in an instance of PluginParameters. The default parameters set use:

• name = "SPCapPlugin"
• id = "SPCapPlugin"
• width "400"
• height "300"

You may append additional attributes for the obejct / embed element using the attribute "attributes", e. g. "attributes" = "style=\"background:#0000ff;\""

Public Member Functions
	getPadInfo ($aResponseUrl, $aPadClass="", $aPadConfiguration="")
	Build the html string to query info about the locally connected tablet.
	getScanner ($aResponseUrl, $aScannerEntryOptions="", $aScannerEntryEncoding="Base64")
	Build the html string to capture one or more scanned images.
	getScannerOptions ($aResponseUrl, $aParameters)
	Build the html string to query one or more scanner images.
	getSignature ($aResponseUrl, $aPadEntryOptions="", $aPadClass="", $aPadConfiguration="")
	Build the html string to query one or more signatures.
	getSignatureOptions ($aResponseUrl, $aParameters)
	Build the html string to query one or more signatures.
	getVersion ($aResponseUrl)
	Build the html string to query the plugin version.
Public Attributes
	$CapPluginClsid = "FF6EC0EB-F5A9-436c-A64C-F63791FCC157"
	Constant, CLSID of COM Plugin.
	$CapPluginVersion = "2,1,2,0"
	Constant, Version of COM Plugin.

---

Member Function Documentation

CapPlugin.getPadInfo (  $  aResponseUrl, $  aPadClass = "", $  aPadConfiguration = "" )

Build the html string to query info about the locally connected tablet. Parameters: $aResponseUrl  [i] the script that will be called with the pad info result, relative path $aPadClass  [i] optional name of the tablett class $aPadConfiguration  [i] optional contents of the tablet configuartion contents Returns: string the HTML request Exceptions: Exception  on errors

CapPlugin.getScanner (  $  aResponseUrl, $  aScannerEntryOptions = "", $  aScannerEntryEncoding = "Base64" )

Build the html string to capture one or more scanned images. Parameters: $aResponseUrl  [i] the script that will be called with the scanner query result, relative path $aScannerEntryOptions  [i] a base64 encoded XML that describes the scanner entry options, see PadEntryOptions.dtd $aScannerEntryEncoding  [i] the encoding of scanner entry options Returns: string the HTML request Exceptions: Exception  on errors

CapPlugin.getScannerOptions (  $  aResponseUrl, $  aParameters )

Build the html string to query one or more scanner images. Parameters: $aResponseUrl  [i] the script that will be called with the scanner query result, relative path $aParameters  [i] an array of PluginParameters Returns: string the HTML request Exceptions: Exception  on errors

CapPlugin.getSignature (  $  aResponseUrl, $  aPadEntryOptions = "", $  aPadClass = "", $  aPadConfiguration = "" )

Build the html string to query one or more signatures. Parameters: $aResponseUrl  [i] the script that will be called with the signature query result, relative path $aPadEntryOptions  [i] a base64 encoded XML that describes the pad entry options, see PadEntryOptions.dtd $aPadClass  [i] optional name of the pad class $aPadConfiguration  [i] optional configuration parameters of the tablet as base64 encoded string Returns: string the HTML request Exceptions: Exception  on errors

CapPlugin.getSignatureOptions (  $  aResponseUrl, $  aParameters )

Build the html string to query one or more signatures. Parameters: $aResponseUrl  [i] the script that will be called with the signature query result, relative path $aParameters  [i] an array of PluginParameters Returns: string the HTML request Exceptions: Exception  on errors

CapPlugin.getVersion (  $  aResponseUrl  )

Build the html string to query the plugin version. Parameters: $aResponseUrl  [i] the script that will be called with the version query result, relative path Returns: string the HTML request Exceptions: Exception  on errors

---

Member Data Documentation

CapPlugin.$CapPluginClsid = "FF6EC0EB-F5A9-436c-A64C-F63791FCC157"

Constant, CLSID of COM Plugin.

CapPlugin.$CapPluginVersion = "2,1,2,0"

Constant, Version of COM Plugin.

---

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

• signware_bapi.php