PadEntryOptions Class Reference

List of all members.

---

Detailed Description

Pad entry options, the root element of a pad entry descriptor.

The capture options string describes a multi-page dialog to enter one or more signatures within the host browser

Class PadEntryOptions represents the PadEntryOptions dtd as a PHP object

Public Member Functions
	addDialog ($aPadEntryDialog)
	add a dialog page
	addRectangle ($pR)
	Add a rectangle to this dialog.
	addText ($pT)
	Add text to this dialog.
	createBase64XML ()
	Create the base64 encoded XML descriptor.
	createOptionsXML ()
	loadBase64XML ($aXml)
	Read a base64 encoded XML descriptor.
	PadEntryOptions ()
	Constructor.
Public Attributes
	$mEncryptModule = ""
	Name of the optional Encryption Module, required if $mEncryption is set to "SPEncrypt".
	$mEncryptParameter = ""
	Optional parameters for Encryption Module.
	$mImageEncoding = "Base64Zip"
	Encoding, 'Base64Zip', 'Base64UrlZip', 'Base64ZipSPEncrypt', 'Base64UrlZipSPEncrypt', default 'Base64Zip'.
	$mImageFormat = "None"
	Result format: None, Bmp, Gif, Png, Tiff, default 'None'.
	$mPadSerialType = "Default"
	Type of device serial to use: Default, Custom, Factory.
	$mSignatureEncoding = "NibbleHex"
	Encoding, 'Base64', 'Base64Url', 'NibbleHex', 'Base64SPEncrypt', 'Base64UrlSPEncrypt', 'NibbleHexSPEncrypt', default 'NibbleHex'.
	$mSignatureFormat = "SP_SOFTPRO"
	Result format: 'None', 'SP_SOFTPRO', 'ISO_19794', default 'SP_SOFTPRO'.
	$padEntryDialog = FALSE
	Array of PlDialog objects, see addDialog.
	$plRectangle = FALSE
	Array of PlRectangle objects, see addRectangle.
	$plText = FALSE
	Array of PlText objects, see addText.
	$strXmlHeader = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<PadEntryOptions>\n</PadEntryOptions>"
Protected Member Functions
	createXML ()
	Create the XML descriptor.
	loadXML ($aXml)
	Read an XML descriptor.

---

Constructor & Destructor Documentation

PadEntryOptions.PadEntryOptions (   )

Constructor.

---

Member Function Documentation

PadEntryOptions.addDialog (  $  aPadEntryDialog  )

add a dialog page Parameters: $aPadEntryDialog  [i] PlDialog, the dialog to add

PadEntryOptions.addRectangle (  $  pR  )

Add a rectangle to this dialog. Parameters: $pR  [i] PlRectangle, the rectangle to add

PadEntryOptions.addText (  $  pT  )

Add text to this dialog. Parameters: $pT  [i] PlText, the text to add

PadEntryOptions.createBase64XML (   )

Create the base64 encoded XML descriptor.

PadEntryOptions.createOptionsXML (   )

PadEntryOptions.createXML (   )  [protected]

Create the XML descriptor.

PadEntryOptions.loadBase64XML (  $  aXml  )

Read a base64 encoded XML descriptor. Parameters: $aXml  [i] String, XML data

PadEntryOptions.loadXML (  $  aXml  )  [protected]

Read an XML descriptor.

---

Member Data Documentation

PadEntryOptions.$mEncryptModule = ""

Name of the optional Encryption Module, required if $mEncryption is set to "SPEncrypt".

PadEntryOptions.$mEncryptParameter = ""

Optional parameters for Encryption Module.

PadEntryOptions.$mImageEncoding = "Base64Zip"

Encoding, 'Base64Zip', 'Base64UrlZip', 'Base64ZipSPEncrypt', 'Base64UrlZipSPEncrypt', default 'Base64Zip'.

PadEntryOptions.$mImageFormat = "None"

Result format: None, Bmp, Gif, Png, Tiff, default 'None'.

PadEntryOptions.$mPadSerialType = "Default"

Type of device serial to use: Default, Custom, Factory.

PadEntryOptions.$mSignatureEncoding = "NibbleHex"

Encoding, 'Base64', 'Base64Url', 'NibbleHex', 'Base64SPEncrypt', 'Base64UrlSPEncrypt', 'NibbleHexSPEncrypt', default 'NibbleHex'.

PadEntryOptions.$mSignatureFormat = "SP_SOFTPRO"

Result format: 'None', 'SP_SOFTPRO', 'ISO_19794', default 'SP_SOFTPRO'.

PadEntryOptions.$padEntryDialog = FALSE

Array of PlDialog objects, see addDialog.

PadEntryOptions.$plRectangle = FALSE

Array of PlRectangle objects, see addRectangle.

PadEntryOptions.$plText = FALSE

Array of PlText objects, see addText.

PadEntryOptions.$strXmlHeader = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<PadEntryOptions>\n</PadEntryOptions>"

---

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

• signware_bapi.php