Abstract PDF outline representation class
todo | Implement an ability to associate an outline item with a structure element (PDF 1.3 feature) |
---|---|
package | Zend_Pdf |
subpackage | Outlines |
copyright | Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com) |
license | New BSD License |
count() : integer
integer
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
\Zend_Pdf_Exception |
---|
\Zend_Pdf_Outline
current() : \Zend_Pdf_Outline
\Zend_Pdf_Outline
dumpOutline(\Zend_Pdf_ElementFactory $factory, boolean $updateNavigation, \Zend_Pdf_Element $parent, \Zend_Pdf_Element $prev= null
, \SplObjectStorage $processedOutlines= null
) : \Zend_Pdf_Element
Returns dictionary indirect object or reference
\Zend_Pdf_ElementFactory
object factory for newly created indirect objects
boolean
Update navigation flag
\Zend_Pdf_Element
Parent outline dictionary reference
\Zend_Pdf_Element
Previous outline dictionary reference
\SplObjectStorage
List of already processed outlines
\Zend_Pdf_Element
getChildren() : \Zend_Pdf_Outline | null
\Zend_Pdf_Outline
null
getColor() : \Zend_Pdf_Color_Rgb
\Zend_Pdf_Color_Rgb
getOptions() : array
array
getTarget() : \Zend_Pdf_Target
\Zend_Pdf_Target
getTitle() : string
string
hasChildren() : boolean
boolean
whether container has any pagesisBold() : boolean
boolean
isItalic() : boolean
boolean
isOpen() : boolean
boolean
key() : integer
integer
next()
rewind()
setColor(\Zend_Pdf_Color_Rgb $color) : \Zend_Pdf_Outline
(null means default color which is black)
\Zend_Pdf_Color_Rgb
\Zend_Pdf_Outline
setIsBold(boolean $isBold) : \Zend_Pdf_Outline
boolean
\Zend_Pdf_Outline
setIsItalic(boolean $isItalic) : \Zend_Pdf_Outline
boolean
\Zend_Pdf_Outline
setIsOpen(boolean $isOpen) : \Zend_Pdf_Outline
boolean
\Zend_Pdf_Outline
setOptions(array $options) : \Zend_Pdf_Action
array
\Zend_Pdf_Exception |
---|
\Zend_Pdf_Action
setTarget(\Zend_Pdf_Target|string $target = null
) : \Zend_Pdf_Outline
Null means no target
\Zend_Pdf_Target
string
\Zend_Pdf_Outline
setTitle(string $title) : \Zend_Pdf_Outline
string
\Zend_Pdf_Outline
valid() : boolean
boolean
$childOutlines : array
array()
$_open : boolean
false