phpDocumentor SpoolTemplate
[ Back ] [ class tree: SpoolTemplate ] [ index: SpoolTemplate ] [ all elements ]

Class: CPagePdf

Source Location: /sptpl_clsPagePdf.php

Class CPagePdf

Class Overview

Page manager extension with support to Pdf output

Require: R&OS pdf class (http://www.ros.co.nz/pdf) sptpl_clsPageManager.php

Located in /sptpl_clsPagePdf.php [line 38]

CPageMgr
   |
   --CPagePdf
Author(s): Information Tags:
Version:  $Header: d:\cvs/classistd/sptpl/sptpl_clsPagePdf.php,v 2.5 2005/03/17 12:46:48 Darvin Exp $
Copyright:  sptpl_clsPagePdf.php is part of Sptpl project http://www.andrioli.com/en/sptpl.html and it is LGPL

Properties

Methods

[ Top ]
Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From CPageMgr

CPageMgr::$clsDataManager
CPageMgr::$ColumnSet
CPageMgr::$CurrentColumnSetId
CPageMgr::$CurrentLine
CPageMgr::$CurrentPage
CPageMgr::$DefinedColumnSet
CPageMgr::$Fonts
CPageMgr::$FooterColSet
CPageMgr::$HeaderColSet
CPageMgr::$LineHeight
CPageMgr::$Margins
CPageMgr::$OutputFp
CPageMgr::$PageData
CPageMgr::$PageFormat
CPageMgr::$PageSize
CPageMgr::$Report
CPageMgr::$tblFormatIso
CPageMgr::$TopPageLine

Inherited From CPageMgr

CPageMgr::CPageMgr()
Class constructor. It initalize all configuration varaibale
CPageMgr::BeginReport()
Start to printout the report. OPen the output file, initialize some variable.
CPageMgr::CloseReport()
Perform the requested job for ending the report.
CPageMgr::EndParseXml()
Function executed at the end of the xml parsing. I run the final configuration
CPageMgr::MvAbsolutePos()
Move the currentline to nRow. It return TRUE on success,
CPageMgr::MvBottom()
Move to the last row before the bottom margin It return TRUE on success,
CPageMgr::MvRelativePos()
Move the currentline up or down of nRow rows. It return TRUE on success,
CPageMgr::MvTop()
Move to the first row after the top margin It return TRUE on success,
CPageMgr::NewColumnSet()
Set new columnset. Each block may hve its own columnset. Before write the text, the
CPageMgr::NewFont()
Create an istance of the CFont class based on configuration file.
CPageMgr::NewPage()
Begin a new page. Close the previous, if any, and printout the 'openpage' text if specified
CPageMgr::ParseXml()
Parse the configuration node for a new information about the layout
CPageMgr::PrintColumnsHeader()
loop over all columns inside the current columnset and print the column's header, if set
CPageMgr::WriteOut()
Pass the text to the appropriate column. It returns a CUnit object containing
CPageMgr::WriteOutFooterRow()
Print out the text row (used only for the closepage row)
CPageMgr::WriteOutHeaderRow()
Print out the text row (used only for the closepage row)
CPageMgr::_EndReport()
Print out the 'closereport' text
CPageMgr::_StartReport()
Print out the 'beginreport' text
CPageMgr::__php5()
Return True if the current PHP version is 5

[ Top ]
Property Summary
object Cpdf   $clsCpdf   Class Pdf instance
array   $FontsId   The array holds the handlers returnt by Aprint's CreateFont
mixed   $OutFile  

[ Top ]
Method Summary
CPagePdf   CPagePdf()   Class constructor. Call the parent class (CPageMgr) constructor
void   BeginReport()   Start to printout the report. OPen the output file, initialize some variable.
void   CheckMargins()   Check whether the margins are placed inside or outside the page No check is made by this module. I haven't information about paper size.
void   CloseReport()   Perform the requested job to end the report.
void   EndParseXml()   Function executd at the end of the xml parsing. I run the final configuration
void   NewFont()   Create an istance of the CFont class based on configuration file.
void   NewPage()   Begin a new page. Close the previous, if any, and printout the 'openpage' text if specified

[ Top ]
Properties
object Cpdf   $clsCpdf [line 44]

Class Pdf instance


[ Top ]
array   $FontsId [line 52]

The array holds the handlers returnt by Aprint's CreateFont

API Tags:
See:  _DownloadFont()


[ Top ]
mixed   $OutFile [line 46]

[ Top ]
Methods
Constructor CPagePdf  [line 58]

  CPagePdf CPagePdf( object CDataStorage &$DataMgr  )

Class constructor. Call the parent class (CPageMgr) constructor

Parameters:
object CDataStorage   &$DataMgr:  Reference to the DataStorage istance

API Tags:
Access:  public


[ Top ]
BeginReport  [line 149]

  void BeginReport( string $OutFile  )

Start to printout the report. OPen the output file, initialize some variable.

Parameters:
string   $OutFile:  output printer name

API Tags:
Access:  public


Redefinition of:
CPageMgr::BeginReport()
Start to printout the report. OPen the output file, initialize some variable.

[ Top ]
CheckMargins  [line 113]

  void CheckMargins( )

Check whether the margins are placed inside or outside the page No check is made by this module. I haven't information about paper size.

The Aprint module will made the checks.



[ Top ]
CloseReport  [line 163]

  void CloseReport( )

Perform the requested job to end the report.

Print the end report text, close the current page and the output file


API Tags:
Access:  public


Redefinition of:
CPageMgr::CloseReport()
Perform the requested job for ending the report.

[ Top ]
EndParseXml  [line 122]

  void EndParseXml( )

Function executd at the end of the xml parsing. I run the final configuration

checks and complete the configration data


API Tags:
Access:  public


Redefinition of:
CPageMgr::EndParseXml()
Function executed at the end of the xml parsing. I run the final configuration

[ Top ]
NewFont  [line 135]

  void NewFont( object CXml2Array $node  )

Create an istance of the CFont class based on configuration file.

Parameters:
object CXml2Array   $node:  Node with font configuration

API Tags:
Access:  public


Redefinition of:
CPageMgr::NewFont()
Create an istance of the CFont class based on configuration file.

[ Top ]
NewPage  [line 181]

  void NewPage( [mixed $FromComposeRow = FALSE]  )

Begin a new page. Close the previous, if any, and printout the 'openpage' text if specified


API Tags:
Access:  public


Redefinition of:
CPageMgr::NewPage()
Begin a new page. Close the previous, if any, and printout the 'openpage' text if specified

[ Top ]

Documentation generated on Mon, 28 Mar 2005 15:13:19 +0200 by phpDocumentor 1.3.0RC3