visit Kofax web site

PadEntryDialog Class Reference

List of all members.

Detailed Description

Signature capture dialog.

Class PadEntryDialog represents the element PadEntryDialog in PadEntryOptions-dtd as a PHP object


Public Member Functions

 addButton ($pB)
 Add a button to this dialog.
 addDocument ($pD)
 Add an image to this dialog.
 addImage ($pI)
 Add an image to this dialog.
 addRectangle ($pR)
 Add a rectangle to this dialog.
 addText ($pT)
 Add text to this dialog.
 addTextEntry ($pT)
 Add a text entry field to this dialog.
 PadEntryDialog ()
 Constructor.
 readXML (&$xml)
 Read an XML descriptor.
 writeXML (&$xml)
 Write the XML descriptor.

Public Attributes

 $mBgColor = FALSE
 optional Background color
 $mFgColor = FALSE
 optional Foreground color
 $mMandatory = TRUE
 optional signature in this dialog is mandatory
 $plButton = 0
 Array of optional PlButton objects, see addButton.
 $plCoordinate = false
 Coordinate object (PlCoordinate), required.
 $plDocument = 0
 Array of optional PlDocument object, see addDocument.
 $plImage = 0
 Array of optional PlImage object, see addImage.
 $plRectangle = FALSE
 Array of PlRectangle objects, see addRectangle.
 $plTablet = 0
 An optional PlTablet object.
 $plText = 0
 Array of optional PlText objects, see addText.
 $plTextEntry = 0
 Array of optional PlTextEntry objects, see addTextEntry.


Constructor & Destructor Documentation

PadEntryDialog.PadEntryDialog  ) 
 

Constructor.


Member Function Documentation

PadEntryDialog.addButton pB  ) 
 

Add a button to this dialog.

Parameters:
$pB [i] PlButton, the button to add

PadEntryDialog.addDocument pD  ) 
 

Add an image to this dialog.

Parameters:
$pD [i] PlDocument, the document to add

PadEntryDialog.addImage pI  ) 
 

Add an image to this dialog.

Parameters:
$pI [i] PlImage, the image to add

PadEntryDialog.addRectangle pR  ) 
 

Add a rectangle to this dialog.

Parameters:
$pR [i] PlRectangle, the rectangle to add

PadEntryDialog.addText pT  ) 
 

Add text to this dialog.

Parameters:
$pT [i] PlText, the text to add

PadEntryDialog.addTextEntry pT  ) 
 

Add a text entry field to this dialog.

Parameters:
$pT [i] PlTextEntry, the text entry to add

PadEntryDialog.readXML &$  xml  ) 
 

Read an XML descriptor.

PadEntryDialog.writeXML &$  xml  ) 
 

Write the XML descriptor.


Member Data Documentation

PadEntryDialog.$mBgColor = FALSE
 

optional Background color

PadEntryDialog.$mFgColor = FALSE
 

optional Foreground color

PadEntryDialog.$mMandatory = TRUE
 

optional signature in this dialog is mandatory

PadEntryDialog.$plButton = 0
 

Array of optional PlButton objects, see addButton.

PadEntryDialog.$plCoordinate = false
 

Coordinate object (PlCoordinate), required.

PadEntryDialog.$plDocument = 0
 

Array of optional PlDocument object, see addDocument.

PadEntryDialog.$plImage = 0
 

Array of optional PlImage object, see addImage.

PadEntryDialog.$plRectangle = FALSE
 

Array of PlRectangle objects, see addRectangle.

PadEntryDialog.$plTablet = 0
 

An optional PlTablet object.

PadEntryDialog.$plText = 0
 

Array of optional PlText objects, see addText.

PadEntryDialog.$plTextEntry = 0
 

Array of optional PlTextEntry objects, see addTextEntry.


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