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
inherited_from \Zend_Pdf_Outline

 Methods

Object constructor

__construct(array $options = array()

Parameters

$options

array

Exceptions

\Zend_Pdf_Exception

count()

count() : integer
Inherited

Returns

integer

Create new Outline object

create($param1, $param2 = null) : \Zend_Pdf_Outline
InheritedStatic

It provides two forms of input parameters:

  1. Zend_Pdf_Outline::create(string $title[, Zend_Pdf_Target $target])
  2. Zend_Pdf_Outline::create(array $options)

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

Parameters

$param1

$param2

Exceptions

\Zend_Pdf_Exception

Returns

\Zend_Pdf_Outline

Returns the child outline.

current() : \Zend_Pdf_Outline
Inherited

Returns

\Zend_Pdf_Outline

Dump Outline and its child outlines into PDF structures

dumpOutline(\Zend_Pdf_ElementFactory $factory, boolean $updateNavigation, \Zend_Pdf_Element $parent, \Zend_Pdf_Element $prev = null, \SplObjectStorage $processedOutlines = null) : \Zend_Pdf_Element
Inherited

Returns dictionary indirect object or reference

Parameters

$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

Returns

\Zend_Pdf_Element

Returns the child outline.

getChildren() : \Zend_Pdf_Outline | null
Inherited

Returns

\Zend_Pdf_Outlinenull

Get outline text color.

getColor() : \Zend_Pdf_Color_Rgb
inherited_from \Zend_Pdf_Outline::getColor()

Returns

\Zend_Pdf_Color_Rgb

Get outline text color.

getColor() : \Zend_Pdf_Color_Rgb
Inherited

Returns

\Zend_Pdf_Color_Rgb

Get outline options

getOptions() : array
Inherited

Returns

array

Get outline target.

getTarget() : \Zend_Pdf_Target
inherited_from \Zend_Pdf_Outline::getTarget()

Returns

\Zend_Pdf_Target

Get outline target.

getTarget() : \Zend_Pdf_Target
Inherited

Returns

\Zend_Pdf_Target

Get outline title.

getTitle() : string
inherited_from \Zend_Pdf_Outline::getTitle()

Returns

string

Get outline title.

getTitle() : string
Inherited

Returns

string

Implements RecursiveIterator interface.

hasChildren() : boolean
Inherited

Returns

booleanwhether container has any pages

Returns true if outline item is displayed in bold

isBold() : boolean
inherited_from \Zend_Pdf_Outline::isBold()

Returns

boolean

Returns true if outline item is displayed in bold

isBold() : boolean
Inherited

Returns

boolean

Returns true if outline item is displayed in italic

isItalic() : boolean
inherited_from \Zend_Pdf_Outline::isItalic()

Returns

boolean

Returns true if outline item is displayed in italic

isItalic() : boolean
Inherited

Returns

boolean

Returns true if outline item is open by default

isOpen() : boolean
Inherited

Returns

boolean

Returns current iterator key

key() : integer
Inherited

Returns

integer

Go to next child

next() 
Inherited

Rewind children

rewind() 
Inherited

Set outline text color.

setColor(\Zend_Pdf_Color_Rgb $color) : \Zend_Pdf_Outline

(null means default color which is black)

inherited_from \Zend_Pdf_Outline::setColor()

Parameters

$color

\Zend_Pdf_Color_Rgb

Returns

\Zend_Pdf_Outline

Set outline text color.

setColor(\Zend_Pdf_Color_Rgb $color) : \Zend_Pdf_Outline
Inherited

(null means default color which is black)

Parameters

$color

\Zend_Pdf_Color_Rgb

Returns

\Zend_Pdf_Outline

Sets 'isBold' outline flag

setIsBold(boolean $isBold) : \Zend_Pdf_Outline
inherited_from \Zend_Pdf_Outline::setIsBold()

Parameters

$isBold

boolean

Returns

\Zend_Pdf_Outline

Sets 'isBold' outline flag

setIsBold(boolean $isBold) : \Zend_Pdf_Outline
Inherited

Parameters

$isBold

boolean

Returns

\Zend_Pdf_Outline

Sets 'isItalic' outline flag

setIsItalic(boolean $isItalic) : \Zend_Pdf_Outline
inherited_from \Zend_Pdf_Outline::setIsItalic()

Parameters

$isItalic

boolean

Returns

\Zend_Pdf_Outline

Sets 'isItalic' outline flag

setIsItalic(boolean $isItalic) : \Zend_Pdf_Outline
Inherited

Parameters

$isItalic

boolean

Returns

\Zend_Pdf_Outline

Sets 'isOpen' outline flag

setIsOpen(boolean $isOpen) : \Zend_Pdf_Outline
Inherited

Parameters

$isOpen

boolean

Returns

\Zend_Pdf_Outline

Set outline options

setOptions(array $options) : \Zend_Pdf_Action
Inherited

Parameters

$options

array

Exceptions

\Zend_Pdf_Exception

Returns

\Zend_Pdf_Action

Set outline target.

setTarget(\Zend_Pdf_Target|string $target = null) : \Zend_Pdf_Outline

Null means no target

inherited_from \Zend_Pdf_Outline::setTarget()

Parameters

$target

\Zend_Pdf_Targetstring

Exceptions

\Zend_Pdf_Exception

Returns

\Zend_Pdf_Outline

Set outline target.

setTarget(\Zend_Pdf_Target|string $target = null) : \Zend_Pdf_Outline
Inherited

Null means no target

Parameters

$target

\Zend_Pdf_Targetstring

Returns

\Zend_Pdf_Outline

Set outline title

setTitle(string $title) : \Zend_Pdf_Outline
inherited_from \Zend_Pdf_Outline::setTitle()

Parameters

$title

string

Returns

\Zend_Pdf_Outline

Set outline title

setTitle(string $title) : \Zend_Pdf_Outline
Inherited

Parameters

$title

string

Returns

\Zend_Pdf_Outline

Check if current position is valid

valid() : boolean
Inherited

Returns

boolean

 Properties

 

Array of child outlines (array of Zend_Pdf_Outline objects)

$childOutlines : array

Default

array()
 

True if outline item is displayed in bold.

$_bold : boolean

Default

false

Default value is false.

 

Color to be used for the outline entry’s text.

$_color : \Zend_Pdf_Color_Rgb

Default

null

It uses the DeviceRGB color space for color representation. Null means default value - black ([0.0 0.0 0.0] in RGB representation).

 

True if outline item is displayed in italic.

$_italic : boolean

Default

false

Default value is false.

 

True if outline is open.

$_open : boolean

Default

false
 

Target destination or action.

$_target : \Zend_Pdf_Destination | \Zend_Pdf_Action

Default

null

String means named destination

Null means no target.

 

Outline title.

$_title : string

Default