ScannerWindow Class Reference

List of all members.

---

Detailed Description

Scanner Image capture options.

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

Class ScannerWindow represents the ScannerWindow dtd as a PHP object, a window contains several PlText, PlTextEntry, PlButton, PlSlider or PlCombo objects

Public Member Functions
	addButton ($pB)
	Add a button to this window, only for TOOL_WINDOW 's.
	addComboBox ($pC)
	Add a combo box to this window, only for TOOL_WINDOW 's.
	addImage ($pI)
	Add Image to this window, only for TOOL_WINDOW 's.
	addRectangle ($pR)
	Add Rectangle to this window, only for TOOL_WINDOW 's.
	addSlider ($pS)
	Add a slider box to this window, only for TOOL_WINDOW 's.
	addText ($pT)
	Add a text to this window, only for TOOL_WINDOW 's.
	addTextEntry ($pT)
	Add a text entry to this window, only for TOOL_WINDOW 's.
	loadImageFile ($aName)
	Load an image file on the server, only for IMAGE_WINDOW 's.
	readXML (&$xml)
	Read an XML descriptor.
	ScannerWindow ($aClass=IMAGE_WINDOW)
	Constructor.
	setImage ($aImage)
	Pass an Image to this window, only for IMAGE_WINDOW 's.
	writeXML (&$xml)
	Write the XML descriptor.
Public Attributes
	$mBgColor = FALSE
	background color, integer, optional
	$mClass = IMAGE_WINDOW
	Scanner window class name, String (IMAGE_WINDOW or TOOL_WINDOW), required.
	$mEncoding = FALSE
	encoding of Preset image, only in IMAGE_WINDOW, call setImage or loadImageFile, String (base64compressed or base64) , optional
	$mFgColor = FALSE
	foreground color, integer, optional
	$mImage = FALSE
	Preset image, only in IMAGE_WINDOW, call setImage or loadImageFile, String, optional.
	$plButton = FALSE
	Array of button elements (PlButton), call addButton.
	$plCombo = FALSE
	Array of combo box elements (PlComboBox), call addCombo.
	$plCoordinate
	Coordinate object, PlCoordinate, required.
	$plImage = FALSE
	Array of image elements (PlImage), only in TOOL_WINDOW, call addImage.
	$plRectangle = 0
	Array of optional PlRectangle objects, see addRectangle.
	$plSlider = FALSE
	Array of slider elements (PlSlider), call addSlider.
	$plText = FALSE
	Array of text elements (PlText), call addText.
	$plTextEntry = FALSE
	Array of text entry elements (PlTextEntry), call addTextEntry.

---

Constructor & Destructor Documentation

ScannerWindow.ScannerWindow (  $  aClass = IMAGE_WINDOW  )

Constructor. Parameters: $aClass  [i] String, the window class name, IMAGE_WINDOW or TOOL_WINDOW

---

Member Function Documentation

ScannerWindow.addButton (  $  pB  )

Add a button to this window, only for TOOL_WINDOW 's. Parameters: $pB  [i] PlButton, the button to add

ScannerWindow.addComboBox (  $  pC  )

Add a combo box to this window, only for TOOL_WINDOW 's. Parameters: $pC  [i] PlComboBox, the combo box to add

ScannerWindow.addImage (  $  pI  )

Add Image to this window, only for TOOL_WINDOW 's. Parameters: $pI  [i] PlImage, a static Image to be displayed in a tool window

ScannerWindow.addRectangle (  $  pR  )

Add Rectangle to this window, only for TOOL_WINDOW 's. Parameters: $pR  [i] PlRectangle, the rectangle to add

ScannerWindow.addSlider (  $  pS  )

Add a slider box to this window, only for TOOL_WINDOW 's. Parameters: $pS  [i] PlSlider, the slider box to add

ScannerWindow.addText (  $  pT  )

Add a text to this window, only for TOOL_WINDOW 's. Parameters: $pT  [i] PlText, the text to add

ScannerWindow.addTextEntry (  $  pT  )

Add a text entry to this window, only for TOOL_WINDOW 's. Parameters: $pT  [i] PlTextEntry, the text entry to add

ScannerWindow.loadImageFile (  $  aName  )

Load an image file on the server, only for IMAGE_WINDOW 's. Parameters: $aName  [i] String, relative image path on the server Exceptions: Exception  on errors such as file not found Note: loadImageFile sets $mImage and $mEncoding The image will be displayed in a capture window and is editable as a scanned image

ScannerWindow.readXML (  &$  xml  )

Read an XML descriptor.

ScannerWindow.setImage (  $  aImage  )

Pass an Image to this window, only for IMAGE_WINDOW 's. Parameters: $aImage  [i] String, an image to be displayed in a capture window Note: loadImageFile sets $mImage and $mEncoding The image will be displayed in a capture window and is editable as a scanned image

ScannerWindow.writeXML (  &$  xml  )

Write the XML descriptor.

---

Member Data Documentation

ScannerWindow.$mBgColor = FALSE

background color, integer, optional

ScannerWindow.$mClass = IMAGE_WINDOW

Scanner window class name, String (IMAGE_WINDOW or TOOL_WINDOW), required.

ScannerWindow.$mEncoding = FALSE

encoding of Preset image, only in IMAGE_WINDOW, call setImage or loadImageFile, String (base64compressed or base64) , optional

ScannerWindow.$mFgColor = FALSE

foreground color, integer, optional

ScannerWindow.$mImage = FALSE

Preset image, only in IMAGE_WINDOW, call setImage or loadImageFile, String, optional.

ScannerWindow.$plButton = FALSE

Array of button elements (PlButton), call addButton.

ScannerWindow.$plCombo = FALSE

Array of combo box elements (PlComboBox), call addCombo.

ScannerWindow.$plCoordinate

Coordinate object, PlCoordinate, required.

ScannerWindow.$plImage = FALSE

Array of image elements (PlImage), only in TOOL_WINDOW, call addImage.

ScannerWindow.$plRectangle = 0

Array of optional PlRectangle objects, see addRectangle.

ScannerWindow.$plSlider = FALSE

Array of slider elements (PlSlider), call addSlider.

ScannerWindow.$plText = FALSE

Array of text elements (PlText), call addText.

ScannerWindow.$plTextEntry = FALSE

Array of text entry elements (PlTextEntry), call addTextEntry.

---

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

• signware_bapi.php