Class Xml2PdfTag_footer

Description

<footer> tag.

The tag footer is used to add page footer to the document.

  1. <footer>
  2.   <numerotation align="right" />
  3.   <date align="left" />
  4.   <paragraph align="center">my document footer</paragraph>
  5. </footer>

Located in /plugins/tags/xml2pdf.tag.footer.php (line 36)

Xml2PdfTag
   |
   --Xml2PdfTextTag
      |
      --Xml2PdfTag_footer
Variable Summary
 string $align
 boolean $border
 string $borderColor
 string $drawColor
 object Xml2Pdf_tag_paragraph $elements
 integer $endPage
 boolean $fill
 string $fillColor
 float $left
 integer $startPage
 float $top
 float $width
 float $_height
Method Summary
 void __construct (object Pdf $pdf, array $attributes)
 void close ()
 boolean render ()
Variables
string $align = 'L' (line 79)

alignment type.

  • access: public
boolean $border = false (line 85)

show borders.

  • access: public
string $borderColor = '#000000' (line 67)

borders color.

  • access: public
string $drawColor = '#000000' (line 61)

lines color.

  • access: public
object Xml2Pdf_tag_paragraph $elements = array() (line 43)

footer elements.

  • access: public
integer $endPage = 0 (line 55)

last page with footer.

  • access: public
boolean $fill = false (line 91)

fill elements background.

  • access: public
string $fillColor = '#ffffff' (line 73)

fill color.

  • access: public
float $left = 0 (line 103)

left margin.

  • access: public
integer $startPage = 1 (line 49)

first page with footer.

  • access: public
float $top = 0 (line 97)

top margin.

  • access: public
float $width = 0 (line 109)

width.

  • access: public
float $_height = 0 (line 115)

footer height.

  • access: private

Inherited Variables

Inherited from Xml2PdfTextTag

Xml2PdfTextTag::$font
Xml2PdfTextTag::$fontColor
Xml2PdfTextTag::$fontSize
Xml2PdfTextTag::$fontStyle
Xml2PdfTextTag::$lineHeight
Xml2PdfTextTag::$styleStack
Xml2PdfTextTag::$textAlign
Xml2PdfTextTag::$useStyle
Xml2PdfTextTag::$_indent
Xml2PdfTextTag::$_x

Inherited from Xml2PdfTag

Xml2PdfTag::$content
Xml2PdfTag::$pdf
Methods
Constructor __construct (line 127)

Constructor.

  • access: public
void __construct (object Pdf $pdf, array $attributes)
  • object Pdf $pdf: object Pdf
  • array $attributes: tag properties.

Redefinition of:
Xml2PdfTextTag::__construct()
Constructor.
close (line 146)

Add the footer to the Pdf.

  • access: public
void close ()

Redefinition of:
Xml2PdfTextTag::close()
Manage the trext writing.
render (line 182)

Render the footer.

  • access: public
boolean render ()

Redefinition of:
Xml2PdfTextTag::render()
Text renderer.
_calcFooterHeight (line 273)

Calcul the footer height.

  • access: private
void _calcFooterHeight ()
_resetFontValues (line 159)

Initialize font properties.

  • access: private
void _resetFontValues ()

Inherited Methods

Inherited From Xml2PdfTextTag

 Xml2PdfTextTag::__construct()
 Xml2PdfTextTag::close()
 Xml2PdfTextTag::render()
 Xml2PdfTextTag::_cleanContent()
 Xml2PdfTextTag::_makeLine()
 Xml2PdfTextTag::_parseContent()
 Xml2PdfTextTag::_printLine()
 Xml2PdfTextTag::_setStyle()

Inherited From Xml2PdfTag

 Xml2PdfTag::__construct()
 Xml2PdfTag::addContent()
 Xml2PdfTag::close()

Documentation generated on Wed, 11 Oct 2006 22:27:21 +0200 by phpDocumentor 1.3.0