Class Xml2PdfTag_header

Description

<header> tag.

Tag header is used to add page header in the document.

  1. <header>
  2.     <date align="C" />
  3.     <image file="logo_clair.png" top="10" left="0" />
  4.     <paragraph width="50" top="20" left="10" 
  5.       position="absolute" border="1">first header paragraph</paragraph>
  6.     <paragraph width="50" top="20" left="150" 
  7.       position="absolute" border="1">second header paragraph</paragraph>
  8. </header>

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

Xml2PdfTag
   |
   --Xml2PdfTextTag
      |
      --Xml2PdfTag_header
Variable Summary
 string $align
 boolean $border
 string $borderColor
 array $elements
 int $endPage
 boolean $fill
 string $fillColor
 float $left
 float $top
 float $_height
Method Summary
 void __construct (object Pdf $pdf, array $tagProperties)
 void close ()
 boolean render ()
 void _resetValues ()
Variables
string $align = 'L' (line 79)

elements alignment.

  • access: protected
boolean $border = false (line 55)

draw borders.

  • access: protected
string $borderColor = '#000000' (line 61)

borders color.

  • access: protected
array $elements = array() (line 97)

elements array.

  • access: public
int $endPage = 0 (line 91)

header end page.

  • access: protected
boolean $fill = false (line 43)

fill the elements background.

  • access: protected
string $fillColor = '#ffffff' (line 49)

fill color.

  • access: protected
float $left = 0 (line 67)

left margin.

  • access: protected
int $startPage = 1 (line 85)

header start page.

  • access: protected
float $top (line 73)

top margin.

  • access: protected
float $_height (line 103)

header 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 115)

Constructor.

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

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

Add the header to the Pdf.

  • access: public
void close ()

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

Render the header.

  • access: public
boolean render ()

Redefinition of:
Xml2PdfTextTag::render()
Text renderer.
_renderComplexHeader (line 238)

Render a full header.

Render header with Xml2PdfTag elements like :

  • Xml2PdfTag_paragraph
  • Xml2PdfTag_image
  • Xml2PdfTag_numerotation
  • Xml2PdfTag_date

  • access: private
void _renderComplexHeader ()
_renderSimpleHeader (line 203)

Render a simple header using <pdf> tag properties.

  • access: private
void _renderSimpleHeader ()
_resetValues (line 341)

Reset header values.

  • access: private
void _resetValues ()

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:24 +0200 by phpDocumentor 1.3.0