visit Kofax web site

PlText Class Reference

List of all members.

Detailed Description

Text element.

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


Public Member Functions

 PlText ()
 Constructor.
 readXML (&$xml)
 Read an XML descriptor.
 writeXML (&$xml)
 Write the XML descriptor.

Public Attributes

 $mBgColor = FALSE
 Background color, fill color, integer, optional.
 $mCaption = ""
 Caption text, UTF8 String.
 $mDrawflags = 0
 Flag to specify whether to draw the text in the browser window and / or on the tablet LCD.Combination of:
  • PL_DRAWFLAGS_PLUGINWND or PL_DRAWFLAGS_DRAWWND or PL_DRAWFLAGS_IMAGE, draw the button on the PC screen
  • PL_DRAWFLAGS_LCD, draw the button on the tablet LCD

 $mFgColor = FALSE
 Foreground color, text color, integer, optional.
 $mTextflags = 0
 Text alignemnt and other flags, a combination of:
  • PL_TEXTFLAGS_TOP or PL_TEXTFLAGS_VCENTER or PL_TEXTFLAGS_BOTTOM
  • PL_TEXTFLAGS_LEFT or PL_TEXTFLAGS_CENTER or PL_TEXTFLAGS_RIGHT
  • PL_TEXTFLAGS_WORDBREAK or PL_TEXTFLAGS_SINGLELINE
  • PL_TEXTFLAGS_EXPANDTABS

 $mToolTip = FALSE
 Tooltip text, only for native windows, UTF8 String, optional.
 $plAction = FALSE
 Action object (PlAction), optional.
 $plCoordinate = FALSE
 Coordinate object (PlCoordinate), required.
 $plFont = FALSE
 Font object (PlFont), optional.


Constructor & Destructor Documentation

PlText.PlText  ) 
 

Constructor.


Member Function Documentation

PlText.readXML &$  xml  ) 
 

Read an XML descriptor.

PlText.writeXML &$  xml  ) 
 

Write the XML descriptor.


Member Data Documentation

PlText.$mBgColor = FALSE
 

Background color, fill color, integer, optional.

PlText.$mCaption = ""
 

Caption text, UTF8 String.

PlText.$mDrawflags = 0
 

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

  • PL_DRAWFLAGS_PLUGINWND or PL_DRAWFLAGS_DRAWWND or PL_DRAWFLAGS_IMAGE, draw the button on the PC screen
  • PL_DRAWFLAGS_LCD, draw the button on the tablet LCD

PlText.$mFgColor = FALSE
 

Foreground color, text color, integer, optional.

PlText.$mTextflags = 0
 

Text alignemnt and other flags, a combination of:

  • PL_TEXTFLAGS_TOP or PL_TEXTFLAGS_VCENTER or PL_TEXTFLAGS_BOTTOM
  • PL_TEXTFLAGS_LEFT or PL_TEXTFLAGS_CENTER or PL_TEXTFLAGS_RIGHT
  • PL_TEXTFLAGS_WORDBREAK or PL_TEXTFLAGS_SINGLELINE
  • PL_TEXTFLAGS_EXPANDTABS

PlText.$mToolTip = FALSE
 

Tooltip text, only for native windows, UTF8 String, optional.

PlText.$plAction = FALSE
 

Action object (PlAction), optional.

PlText.$plCoordinate = FALSE
 

Coordinate object (PlCoordinate), required.

PlText.$plFont = FALSE
 

Font object (PlFont), optional.


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