Plugins
[ class tree: Plugins ] [ index: Plugins ] [ all elements ]

Class: CwFpdf

Source Location: /plugins/exportPdf/client/CwFpdf.php

Class Overview


FPDF implementation of PdfWriter.


Variables

Methods



Class Details

[line 161]
FPDF implementation of PdfWriter.



[ Top ]


Class Variables

$angle =  0

[line 213]

Angle for method rotate()



Tags:

access:  protected

Type:   float


[ Top ]

$blocks =

[line 192]



Tags:

access:  protected

Type:   array


[ Top ]

$format =

[line 182]



Tags:

access:  protected

Type:   PdfFormat


[ Top ]

$general =

[line 177]



Tags:

access:  protected

Type:   PdfGeneral


[ Top ]

$legendLevel =

[line 202]



Tags:

access:  protected

Type:   int


[ Top ]

$legendShift =

[line 207]



Tags:

access:  protected

Type:   float


[ Top ]

$log =

[line 166]



Tags:

access:  private

Type:   Logger


[ Top ]

$maxExtent =

[line 197]



Tags:

access:  protected

Type:   array


[ Top ]

$p =

[line 172]

PDF engine object (FPDF)



Tags:

access:  protected

Type:   cFPDF


[ Top ]

$space =

[line 187]



Tags:

access:  protected

Type:   SpaceManager


[ Top ]



Class Methods


constructor __construct [line 219]

CwFpdf __construct( ClientExportPdf $export)

Constructor.



Tags:

access:  public


Parameters:

ClientExportPdf   $export  

[ Top ]

method addGfxBlock [line 493]

void addGfxBlock( PdfBlock $block)



Tags:

access:  public
see:  PdfWriter::addGfxBlock()


Parameters:

PdfBlock   $block   graphical (image, PDF) block object

[ Top ]

method addImage [line 992]

void addImage( string $file, int $x, int $y, int $w, int $h, [string $type = ''], [string $link = ''])

Wraps FPDF Image() method and feeds it whith a local copy of argument

image if:

  • allowed in exportPdf.ini (general.importRemotePng parameter)
  • file is called through URL
  • file format is PNG




Tags:

access:  protected


Parameters:

string   $file   name of the image file
int   $x   abscissa of the upper-left corner
int   $y   ordinate of the upper-left corner
int   $w   image width
int   $h   image height
string   $type   JPG|JPEG|PNG, detected if left blank
string   $link   URL or FPDF resource (see FPDF doc)

[ Top ]

method addLegend [line 899]

void addLegend( PdfBlock $block)



Tags:

access:  public
see:  PdfWriter::addLegend()


Parameters:

PdfBlock   $block  

[ Top ]

method addLegendItem [line 788]

void addLegendItem( PdfBlock $block, array $layer)

Draws a legend element (icon + caption) line.



Tags:

access:  protected


Parameters:

PdfBlock   $block   legend block
array   $layer   legend element data

[ Top ]

method addNorthArrow [line 955]

void addNorthArrow( PdfBlock $block, mixed $angle)



Tags:

access:  public
see:  PdfWriter::addLegend()


Parameters:

PdfBlock   $block  

[ Top ]

method addPage [line 292]

void addPage( )



Tags:

access:  public
see:  PdfWriter::addPage()


[ Top ]

method addTable [line 728]

void addTable( PdfBlock $block)



Tags:

access:  public
see:  PdfWriter::addTable()


Parameters:

PdfBlock   $block  

[ Top ]

method addTableCaption [line 585]

void addTableCaption( TableElement $table)

Draws table title row (cf. HTML caption element).



Tags:

access:  protected


Parameters:

TableElement   $table  

[ Top ]

method addTableCell [line 521]

void addTableCell( string $text, float $width, float $height)



Tags:

access:  public
see:  PdfWriter::addTableCell()


Parameters:

string   $text   textual content
float   $width   width
float   $height   height

[ Top ]

method addTableHeaders [line 609]

void addTableHeaders( TableElement $table)

Draws table columns headers (columns titles) row.



Tags:

access:  protected


Parameters:

TableElement   $table  

[ Top ]

method addTableRow [line 558]

void addTableRow( PdfBlock $block, TableElement $table, array $row)



Tags:

access:  public
see:  PdfWriter::addTableRow()


Parameters:

PdfBlock   $block  
TableElement   $table  
array   $row   row data

[ Top ]

method addTextBlock [line 400]

void addTextBlock( PdfBlock $block)



Tags:

access:  public
see:  PdfWriter::addTextBlock()


Parameters:

PdfBlock   $block   text block object

[ Top ]

method closePage [line 1026]

void closePage( )

Performs recurrent actions (blocks displaying...) before current page is closed.



Tags:

access:  protected


[ Top ]

method convertCharset [line 1067]

string convertCharset( string $string)

Converts UTF8 strings in Latin1



Tags:

return:  converted string
access:  protected


Parameters:

string   $string   string to convert

[ Top ]

method finalizeDocument [line 1057]

void finalizeDocument( )



Tags:

access:  public
see:  PdfWriter::finalizeDocument()


[ Top ]

method getCharset [line 1078]

void getCharset( )

Returns used character set name.



Tags:

access:  public


[ Top ]

method getPageHeight [line 275]

float getPageHeight( )



Tags:

access:  public
see:  PdfWriter::getPageHeight()


[ Top ]

method getPageWidth [line 267]

float getPageWidth( )



Tags:

access:  public
see:  PdfWriter::getPageWidth()


[ Top ]

method getTextAlign [line 303]

string getTextAlign( string $align)

Translates config text-alignement keyword into FPDF one.



Tags:

return:  enum('C', 'R', 'L')
access:  protected


Parameters:

string   $align   horizontal alignment keyword

[ Top ]

method initializeDocument [line 282]

void initializeDocument( )



Tags:

access:  public
see:  PdfWriter::initializeDocument()


[ Top ]

method rotate [line 373]

void rotate( float $angle, [float $x = -1], [float $y = -1])

Sets rotation



Tags:

access:  protected


Parameters:

float   $angle  
float   $x  
float   $y  

[ Top ]

method setBoxLayout [line 360]

void setBoxLayout( PdfBlock $block)

Sets block container styles (border width and color, background color).



Tags:

access:  protected


Parameters:

PdfBlock   $block  

[ Top ]

method setDrawColor [line 315]

void setDrawColor( mixed $color)

Sets lines color.



Tags:

access:  protected


Parameters:

mixed   $color   color info (keyword, hex code, RGB array)

[ Top ]

method setFillColor [line 325]

void setFillColor( mixed $color)

Sets filling color (background).



Tags:

access:  protected


Parameters:

mixed   $color   color info (keyword, hex code, RGB array)

[ Top ]

method setLineWidth [line 334]

void setLineWidth( float $width)

Sets line width in PdfGeneral dist_unit.



Tags:

access:  protected


Parameters:

float   $width  

[ Top ]

method setTableMeta [line 622]

void setTableMeta( PdfBlock $block, TableElement $table, string $meta)

Sets table caption or headers blocks.



Tags:

access:  protected


Parameters:

PdfBlock   $block   main table block
TableElement   $table  
string   $meta   type of table block (headers|caption)

[ Top ]

method setTableWidth [line 641]

void setTableWidth( PdfBlock $block, TableElement $table)

Computes table columns widths using cells contents widths.



Tags:

access:  protected


Parameters:

PdfBlock   $block  
TableElement   $table  

[ Top ]

method setTextLayout [line 345]

void setTextLayout( PdfBlock $block)

Sets text styles (font, underline, bold, italic, color).



Tags:

access:  protected


Parameters:

PdfBlock   $block  

[ Top ]

method splitMultiPageTable [line 536]

boolean splitMultiPageTable( PdfBlock $block, float $height)

If there is not enough space to add a table row, adds a new page.



Tags:

return:  true if new page added, else false
access:  protected


Parameters:

PdfBlock   $block  
float   $height   height of next row

[ Top ]


Documentation generated on Mon, 13 Feb 2006 11:43:43 +0100 by phpDocumentor 1.3.0RC3