visit Kofax web site

PlImage Class Reference

List of all members.

Detailed Description

Image element.

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


Public Member Functions

 loadImageFile ($aName)
 Load an image file on the server.
 PlImage ()
 Constructor.
 readXML (&$xml)
 Read an XML descriptor.
 writeXML (&$xml)
 Write the XML descriptor.

Public Attributes

 $mDrawflags = 0
 Flag to specify whether to draw the text in the browser window and / or on the tablet LCD.Combination of:
  • PL_DRAWFLAGS_DRAWWND or PL_DRAWFLAGS_IMAGE, draw the button on the PC screen
  • PL_DRAWFLAGS_LCD, draw the button on the tablet LCD
  • PL_DRAWFLAGS_OPAQUE, draw the image opaque

 $mFormat = 0
 Format specifyer, either one:
  • PL_IMAGE_LOCAL_FILE
  • PL_IMAGE_BASE64_BMP
  • PL_IMAGE_BASE64_COMPRESSED_BMP
  • PL_IMAGE_EMPTY, $width and height must be passed

 $mHeight = 0
 Height of the image, only required if an empty image is specified.
 $mImage = false
 Image data, use loadImageFile to pass a bitmap from the server.
 $mTransparentColor = -1
 $mWidth = 0
 Width of the image, only required if an empty image is specified.
 $plCoordinate = false
 Coordinate object (PlCoordinate), required.

Constructor & Destructor Documentation

PlImage.PlImage (   ) 
 

Constructor.

Member Function Documentation

PlImage.loadImageFile (  $  aName  ) 
 

Load an image file on the server.

Parameters:
$aName relative image path on the server
Exceptions:
Exception on errors such as file not found
Note:
loadImageFile sets $image and $format
The image must be in Windows Bitmap format

PlImage.readXML (  &$  xml  ) 
 

Read an XML descriptor.

PlImage.writeXML (  &$  xml  ) 
 

Write the XML descriptor.

Member Data Documentation

PlImage.$mDrawflags = 0
 

Flag to specify whether to draw the text in the browser window and / or on the tablet LCD.Combination of:

  • PL_DRAWFLAGS_DRAWWND or PL_DRAWFLAGS_IMAGE, draw the button on the PC screen
  • PL_DRAWFLAGS_LCD, draw the button on the tablet LCD
  • PL_DRAWFLAGS_OPAQUE, draw the image opaque

PlImage.$mFormat = 0
 

Format specifyer, either one:

  • PL_IMAGE_LOCAL_FILE
  • PL_IMAGE_BASE64_BMP
  • PL_IMAGE_BASE64_COMPRESSED_BMP
  • PL_IMAGE_EMPTY, $width and height must be passed

PlImage.$mHeight = 0
 

Height of the image, only required if an empty image is specified.

PlImage.$mImage = false
 

Image data, use loadImageFile to pass a bitmap from the server.

PlImage.$mTransparentColor = -1
 

Transparent color if PL_DRAWFLAGS_TRANSPARENT is set, format 0x00rrggbb

PlImage.$mWidth = 0
 

Width of the image, only required if an empty image is specified.

PlImage.$plCoordinate = false
 

Coordinate object (PlCoordinate), required.

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