Abstract base class for additional PDF parts
Parts can be new elements in a PDF page, which can hook into the rendering of the PDF page, like footers or headers.
This abstract part abse class offers a list of hooks which will be called, if an instance of this class is registered in the renderer, these hooks are:
Source for this file: /Document/src/document/pdf/part.php
Version: | //autogen// |
Child Class | Description |
---|---|
ezcDocumentPdfFooterPdfPart | Basic foot class, which renders a simple page footer including information from the document. |
protected ezcDocumentPdfDriver |
$driver
Reference to driver |
protected ezcDocumentPdfMainRenderer |
$renderer
Reference to main renderer |
protected ezcDocumentPcssStyleInferencer |
$styles
Reference to style inferencer |
public void |
hookDocumentCreation(
$element
)
Hook on document creation |
public void |
hookDocumentRendering(
)
Hook on document rendering |
public void |
hookPageCreation(
$page
)
Hook on page creation |
public void |
hookPageRendering(
$page
)
Hook on page rendering |
public void |
registerContext(
$renderer
, $driver
, $styles
)
Registration function called by the renderer. |
Hook on document creation
Hook called when a new document is created.
Name | Type | Description |
---|---|---|
$element |
ezcDocumentLocateableDomElement |
Method | Description |
---|---|
ezcDocumentPdfFooterPdfPart::hookDocumentCreation() |
Hook on document creation |
Hook on document rendering
Hook called once a document is completely rendered.
Hook on page creation
Hook called on page creation, so that certain areas might be reserved or it already may render stuff on the frshly created page.
Name | Type | Description |
---|---|---|
$page |
ezcDocumentPdfPage |
Method | Description |
---|---|
ezcDocumentPdfFooterPdfPart::hookPageCreation() |
Hook on page creation |
Hook on page rendering
Hook called on page rendering, which means, that a page is complete, by all knowledge of the main renderer.
Name | Type | Description |
---|---|---|
$page |
ezcDocumentPdfPage |
Registration function called by the renderer.
Function called by the renderer, to set its properties, which pass the relevant state objects to the part.
Name | Type | Description |
---|---|---|
$renderer |
ezcDocumentPdfMainRenderer | |
$driver |
ezcDocumentPdfDriver | |
$styles |
ezcDocumentPcssStyleInferencer |