Zend Framework
LICENSE
This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.
Abstract PDF outline representation class

create(
$param1, $param2
=
null
)
:
\Zend_Pdf_Outline
Create new Outline object
It provides two forms of input parameters:
Second form allows to provide outline options as an array. The followed options are supported: 'title' - string, outline title, required 'open' - boolean, true if outline entry is open (default value is false) 'color' - Zend_Pdf_Color_Rgb object, true if outline entry is open (default value is null - black) 'italic' - boolean, true if outline entry is displayed in italic (default value is false) 'bold' - boolean, true if outline entry is displayed in bold (default value is false) 'target' - Zend_Pdf_Target object or string, outline item destination
Name | Type | Description |
---|---|---|
$param1 | ||
$param2 |
Type | Description |
---|---|
\Zend_Pdf_Outline |
Exception | Description |
---|---|
\Zend_Pdf_Exception |

dumpOutline(
\Zend_Pdf_ElementFactory $factory, boolean $updateNavigation, \Zend_Pdf_Element $parent, \Zend_Pdf_Element $prev
=
null, \SplObjectStorage $processedOutlines
=
null
)
:
\Zend_Pdf_Element
Dump Outline and its child outlines into PDF structures
Returns dictionary indirect object or reference
Name | Type | Description |
---|---|---|
$factory | \Zend_Pdf_ElementFactory | object factory for newly created indirect objects |
$updateNavigation | boolean | Update navigation flag |
$parent | \Zend_Pdf_Element | Parent outline dictionary reference |
$prev | \Zend_Pdf_Element | Previous outline dictionary reference |
$processedOutlines | \SplObjectStorage | List of already processed outlines |
Type | Description |
---|---|
\Zend_Pdf_Element |

getChildren(
)
:
\Zend_Pdf_Outline|null
Returns the child outline.
Type | Description |
---|---|
\Zend_Pdf_Outline|null |

getColor(
)
:
\Zend_Pdf_Color_Rgb
Get outline text color.
Type | Description |
---|---|
\Zend_Pdf_Color_Rgb |

getTarget(
)
:
\Zend_Pdf_Target
Get outline target.
Type | Description |
---|---|
\Zend_Pdf_Target |

hasChildren(
)
:
bool
Implements RecursiveIterator interface.
Type | Description |
---|---|
bool | whether container has any pages |

isBold(
)
:
boolean
Returns true if outline item is displayed in bold
Type | Description |
---|---|
boolean |

isItalic(
)
:
boolean
Returns true if outline item is displayed in italic
Type | Description |
---|---|
boolean |

setColor(
\Zend_Pdf_Color_Rgb $color
)
:
\Zend_Pdf_Outline
Set outline text color.
(null means default color which is black)
Name | Type | Description |
---|---|---|
$color | \Zend_Pdf_Color_Rgb |
Type | Description |
---|---|
\Zend_Pdf_Outline |

setOptions(
array $options
)
:
\Zend_Pdf_Action
Set outline options
Name | Type | Description |
---|---|---|
$options | array |
Type | Description |
---|---|
\Zend_Pdf_Action |
Exception | Description |
---|---|
\Zend_Pdf_Exception |

setTarget(
\Zend_Pdf_Target|string $target
=
null
)
:
\Zend_Pdf_Outline
Set outline target.
Null means no target
Name | Type | Description |
---|---|---|
$target | \Zend_Pdf_Target|string |
Type | Description |
---|---|
\Zend_Pdf_Outline |