Class fpdf_multicelltag

Description

MultiCellTag Class The intern functions are prefaced with mt_, not be be overwritten

  • author: andy@interpid.eu
  • version: 1.4

Located in /class.multicelltag.php (line 62)

FPDF
   |
   --fpdf_multicelltag
Variable Summary
Method Summary
 void afterAddPage ()
 void beforeAddPage ()
 void mt_ApplyStyle (string $tag)
 struct mt_DivideByTags (string $pStr, [boolean $return = false])
 array mt_MakeLine (numeric $w)
 void mt_PrintLine (numeric $w, numeric $h, string $aTxt, [string $align = 'J'])
 void mt_Reset_Datas (none 0)
 void mt_SaveCurrentStyle (none 0)
 array mt_StringToLines ([numeric $w = 0], string $pStr)
 void MultiCellTag (numeric $w, numeric $h, string $pData, [string $border = 0], [string $align = 'J'], [numeric $fill = 0], [numeric $pad_left = 0], [numeric $pad_top = 0], [numeric $pad_right = 0], [numeric $pad_bottom = 0], [boolean $pDataIsString = true])
 void MultiCellTagSec (numeric $w, numeric $h, string $pData, [string $border = 0], [string $align = 'J'], [numeric $fill = 0], [numeric $pad_left = 0], [numeric $pad_top = 0], [numeric $pad_right = 0], [numeric $pad_bottom = 0], [boolean $pDataIsString = true])
 void SetStyle (string $tag, string $family, string $style, numeric $size, array $color)
 void setTagWidthMax ([numeric $iWidth = 10])
Variables
boolean $wt_bDoubleTags = false (line 119)

== true if a tag was more times defined.

  • access: protected
string $wt_Current_Tag = '' (line 78)

The current active tag

  • access: protected
struct $wt_DataExtraInfo (line 102)

Data Extra Info

  • access: protected
struct $wt_DataInfo (line 94)

Parsed string data info

  • access: protected
struct $wt_FontInfo (line 86)

Tags Font Information

  • access: protected
integer $wt_TagWidthMax = 10 (line 70)

Valid Tag Maximum Width

  • access: protected
struct $wt_TempData (line 110)

Temporary Info

  • access: protected
Methods
afterAddPage (line 947)

Function executed AFTER a new page is added for pre - actions on the current page.

Usually overwritted.

  • access: public
void afterAddPage ()
beforeAddPage (line 934)

Function executed BEFORE a new page is added for further actions on the current page.

Usually overwritted.

  • access: public
void beforeAddPage ()
mt_ApplyStyle (line 194)

Sets current tag to specified style

  • if the tag name is not in the tag list then de "DEFAULT" tag is saved.

This includes a fist call of the function mt_SaveCurrentStyle()

  • access: protected
void mt_ApplyStyle (string $tag)
  • string $tag: - tag name
mt_DivideByTags (line 763)

This method divides the string into the tags and puts the result into wt_DataInfo variable.

  • return: or void
  • access: protected
struct mt_DivideByTags (string $pStr, [boolean $return = false])
  • string $pStr: - string to be parsed
  • boolean $return: - ==TRUE if the result is returned or not
mt_MakeLine (line 247)

Divides $this->wt_DataInfo and returnes a line from this variable

  • return: - array() -> contains informations to draw a line
  • access: protected
array mt_MakeLine (numeric $w)
  • numeric $w: - the width of the text
mt_PrintLine (line 826)

Draws a Tag Based formatted line returned from mt_MakeLine function into the pdf document

  • access: protected
void mt_PrintLine (numeric $w, numeric $h, string $aTxt, [string $align = 'J'])
  • numeric $w: - width of the text
  • numeric $h: - height of a line
  • string $aTxt: - text to be draw
  • string $align: - align of the text
mt_Reset_Datas (line 141)

Resets the current class internal variables to default values

  • access: protected
void mt_Reset_Datas (none 0)
  • none 0
mt_SaveCurrentStyle (line 231)

Save the current settings as a tag default style under the DEFAUTLT tag name

  • access: protected
void mt_SaveCurrentStyle (none 0)
  • none 0
mt_StringToLines (line 787)

This method parses the current text and return an array that contains the text information for each line that will be drawed.

  • return: - contains parsed text information.
  • access: protected
array mt_StringToLines ([numeric $w = 0], string $pStr)
  • numeric $w: - width of the line
  • string $pStr: - String to be parsed
MultiCellTag (line 515)

Draws a MultiCell with TAG recognition parameters

  • access: public
void MultiCellTag (numeric $w, numeric $h, string $pData, [string $border = 0], [string $align = 'J'], [numeric $fill = 0], [numeric $pad_left = 0], [numeric $pad_top = 0], [numeric $pad_right = 0], [numeric $pad_bottom = 0], [boolean $pDataIsString = true])
  • numeric $w: - with of the cell
  • numeric $h: - height of the lines in the cell
  • string $pData: - string or formatted data to be putted in the multicell
  • string $align: - Sets the text alignment Possible values: L: left R: right C: center J: justified
  • numeric $fill: - Indicates if the cell background must be painted (1) or transparent (0). Default value: 0.
  • numeric $pad_left: - Left pad
  • numeric $pad_top: - Top pad
  • numeric $pad_right: - Right pad
  • numeric $pad_bottom: - Bottom pad
  • boolean $pDataIsString:
    • true if $pData is a string
    • false if $pData is an array containing lines formatted with $this->mt_MakeLine($w) function (the false option is used in relation with mt_StringToLines, to avoid double formatting of a string
  • string $border: or numeric $border Indicates if borders must be drawn around the cell block. The value can be either a number:
    1. = no border
    2. = frame border
    or a string containing some or all of the following characters (in any order): L: left T: top R: right B: bottom
MultiCellTagSec (line 582)

Draws a MultiCell with TAG recognition parameters

  • access: protected
void MultiCellTagSec (numeric $w, numeric $h, string $pData, [string $border = 0], [string $align = 'J'], [numeric $fill = 0], [numeric $pad_left = 0], [numeric $pad_top = 0], [numeric $pad_right = 0], [numeric $pad_bottom = 0], [boolean $pDataIsString = true])
  • numeric $w: - with of the cell
  • numeric $h: - height of the lines in the cell
  • string $pData: - string or formatted data to be putted in the multicell
  • string $align: - Sets the text alignment Possible values: L: left R: right C: center J: justified
  • numeric $fill: - Indicates if the cell background must be painted (1) or transparent (0). Default value: 0.
  • numeric $pad_left: - Left pad
  • numeric $pad_top: - Top pad
  • numeric $pad_right: - Right pad
  • numeric $pad_bottom: - Bottom pad
  • boolean $pDataIsString:
    • true if $pData is a string
    • false if $pData is an array containing lines formatted with $this->mt_MakeLine($w) function (the false option is used in relation with mt_StringToLines, to avoid double formatting of a string
  • string $border: or numeric $border Indicates if borders must be drawn around the cell block. The value can be either a number:
    1. = no border
    2. = frame border
    or a string containing some or all of the following characters (in any order): L: left T: top R: right B: bottom
SetStyle (line 168)

Sets current tag to specified style

  • access: public
void SetStyle (string $tag, string $family, string $style, numeric $size, array $color)
  • string $tag: - tag name
  • string $family: - text font family name
  • string $style: - text font style
  • numeric $size: - text font size
  • array $color: - text color
setTagWidthMax (line 129)

Sets the Tags Maximum width

  • access: public
void setTagWidthMax ([numeric $iWidth = 10])
  • numeric $iWidth: - the width of the tags

Documentation generated on Wed, 04 Feb 2009 22:01:33 +0100 by phpDocumentor 1.4.0a2