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.
Traceable PDF outline representation class
Instances of this class trace object update uperations. That allows to avoid outlines PDF tree update which should be performed at each document update otherwise.

array
$_originalChildOutlines= 'array'
original array of child outlines
array
Details
create(
$param1, $param2
=
null
)
:
\Zend_Pdf_Outline
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 |

current(
)
:
\Zend_Pdf_Outline
Returns the child outline.
Inherited from: \Zend_Pdf_Outline::current()Type | Description |
---|---|
\Zend_Pdf_Outline |

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

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

getOptions(
)
:
array
Get outline options
Inherited from: \Zend_Pdf_Outline::getOptions()Type | Description |
---|---|
array |

hasChildren(
)
:
bool
Implements RecursiveIterator interface.
Inherited from: \Zend_Pdf_Outline::hasChildren()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 |

isOpen(
)
:
boolean
Returns true if outline item is open by default
Inherited from: \Zend_Pdf_Outline::isOpen()Type | Description |
---|---|
boolean |

key(
)
:
integer
Returns current iterator key
Inherited from: \Zend_Pdf_Outline::key()Type | Description |
---|---|
integer |

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_Actions_Traceable
Set outline options
Name | Type | Description |
---|---|---|
$options | array |
Type | Description |
---|---|
\Zend_Pdf_Actions_Traceable |
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 |
Exception | Description |
---|---|
\Zend_Pdf_Exception |

valid(
)
:
boolean
Check if current position is valid
Inherited from: \Zend_Pdf_Outline::valid()Type | Description |
---|---|
boolean |