Pdf/Outline/Loaded.php
Show:
inherited
inherited
Classes
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.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Pdf
- Subpackage
- Actions
- Version
- $Id$
\Zend_Pdf_Outline_Loaded
Package: Zend_Pdf\Outlines
Returns
Returns
Throws
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.
- Parent(s)
- \Zend_Pdf_Outline
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
array $_originalChildOutlines = array()original array of child outlines
Default value
array()Details- Type
- array
\Zend_Pdf_Element_Dictionary|\Zend_Pdf_Element_Object|\Zend_Pdf_Element_Reference $_outlineDictionaryOutline dictionary object
Methods
dump( $level = 0) : voidParameters
| Name | Type | Description |
|---|---|---|
| $level |
getTarget() : \Zend_Pdf_TargetGet outline target.
Returns
Throws
| Type | Description |
|---|---|
| \Zend_Pdf_Target |
| Exception | Description |
|---|---|
| \Zend_Pdf_Exception |
getTitle() : stringGet outline title.
Returns
Throws
| Type | Description |
|---|---|
| string |
| Exception | Description |
|---|---|
| \Zend_Pdf_Exception |
isBold() : booleanReturns true if outline item is displayed in bold
Returns
| Type | Description |
|---|---|
| boolean |
isItalic() : booleanReturns true if outline item is displayed in italic
Returns
| Type | Description |
|---|---|
| boolean |
setColor(\Zend_Pdf_Color_Rgb $color) : \Zend_Pdf_OutlineSet outline text color.
(null means default color which is black)
Parameters| Name | Type | Description |
|---|---|---|
| $color | \Zend_Pdf_Color_Rgb |
| Type | Description |
|---|---|
| \Zend_Pdf_Outline |
setIsBold(boolean $isBold) : \Zend_Pdf_OutlineSets 'isBold' outline flag
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $isBold | boolean |
| Type | Description |
|---|---|
| \Zend_Pdf_Outline |
setIsItalic(boolean $isItalic) : \Zend_Pdf_OutlineSets 'isItalic' outline flag
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $isItalic | boolean |
| Type | Description |
|---|---|
| \Zend_Pdf_Outline |
setIsOpen(boolean $isOpen) : \Zend_Pdf_OutlineSets 'isOpen' outline flag
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $isOpen | boolean |
| Type | Description |
|---|---|
| \Zend_Pdf_Outline |
setOptions(array $options) : \Zend_Pdf_Actions_TraceableSet outline options
Parameters
Returns
Throws
| 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_OutlineSet outline target.
Null means no target
Parameters| Name | Type | Description |
|---|---|---|
| $target | \Zend_Pdf_Target | string |
| Type | Description |
|---|---|
| \Zend_Pdf_Outline |
| Exception | Description |
|---|---|
| \Zend_Pdf_Exception |
setTitle(string $title) : \Zend_Pdf_OutlineSet outline title
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $title | string |
| Type | Description |
|---|---|
| \Zend_Pdf_Outline |