Public Member Functions
	getTitle ()
	Get outline title.

	setTitle ($title)
	Set outline title.

	isOpen ()
	Returns true if outline item is open by default.

	setIsOpen ($isOpen)
	Sets 'isOpen' outline flag.

	isItalic ()
	Returns true if outline item is displayed in italic.

	setIsItalic ($isItalic)
	Sets 'isItalic' outline flag.

	isBold ()
	Returns true if outline item is displayed in bold.

	setIsBold ($isBold)
	Sets 'isBold' outline flag.

	getColor ()
	Get outline text color.

	setColor (Zend_Pdf_Color_Rgb $color)
	Set outline text color.

	getTarget ()
	Get outline target.

	setTarget ($target=null)
	Set outline target.

	getOptions ()
	Get outline options.

	setOptions (array $options)
	Set outline options.

	openOutlinesCount ()
	Returns number of the total number of open items at all levels of the outline.

	dumpOutline (Zend_Pdf_ElementFactory_Interface $factory, $updateNavigation, Zend_Pdf_Element $parent, Zend_Pdf_Element $prev=null, SplObjectStorage $processedOutlines=null)
	Dump Outline and its child outlines into PDF structures.

	current ()
	Returns the child outline.

	key ()
	Returns current iterator key.

	next ()
	Go to next child.

	rewind ()
	Rewind children.

	valid ()
	Check if current position is valid.

	getChildren ()
	Returns the child outline.

	hasChildren ()
	Implements RecursiveIterator interface.

	count ()
	count()

Static Public Member Functions
static	create ($param1, $param2=null)
	Create new Outline object.

Public Attributes
	$childOutlines = array()

Protected Attributes
	$_open = false

Member Function Documentation

count ( )

count()

Returns: int

static create	(	$param1,
		$param2 = `null`
	)

static

Create new Outline object.

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

Returns: Zend_Pdf_Outline

Exceptions

Zend_Pdf_Exception

current ( )

Returns the child outline.

Returns: Zend_Pdf_Outline

dumpOutline	(	Zend_Pdf_ElementFactory_Interface	$factory,
			$updateNavigation,
		Zend_Pdf_Element	$parent,
		Zend_Pdf_Element	$prev = `null`,
		SplObjectStorage	$processedOutlines = `null`
	)

abstract

Dump Outline and its child outlines into PDF structures.

Returns dictionary indirect object or reference

Parameters

Zend_Pdf_ElementFactory	$factory	object factory for newly created indirect objects
boolean	$updateNavigation	Update navigation flag
Zend_Pdf_Element	$parent	Parent outline dictionary reference
Zend_Pdf_Element	$prev	Previous outline dictionary reference
SplObjectStorage	$processedOutlines	List of already processed outlines

Returns: Zend_Pdf_Element

getChildren ( )

Returns the child outline.

Returns: Zend_Pdf_Outline|null

getColor ( )

abstract

Get outline text color.

Returns: Zend_Pdf_Color_Rgb

getOptions ( )

Get outline options.

Returns: array

getTarget ( )

abstract

Get outline target.

Returns: Zend_Pdf_Target

getTitle ( )

abstract

Get outline title.

Returns: string

hasChildren ( )

Implements RecursiveIterator interface.

Returns: bool whether container has any pages

isBold ( )

abstract

Returns true if outline item is displayed in bold.

Returns: boolean

isItalic ( )

abstract

Returns true if outline item is displayed in italic.

Returns: boolean

isOpen ( )

Returns true if outline item is open by default.

Returns: boolean

key ( )

Returns current iterator key.

Returns: integer

next ( )

Go to next child.

openOutlinesCount ( )

Returns number of the total number of open items at all levels of the outline.

rewind ( )

Rewind children.

setColor ( Zend_Pdf_Color_Rgb $color )

abstract

Set outline text color.

(null means default color which is black)

Parameters

Zend_Pdf_Color_Rgb $color

Returns: Zend_Pdf_Outline

setIsBold ( $isBold )

abstract

Sets 'isBold' outline flag.

Parameters

boolean $isBold

Returns: Zend_Pdf_Outline

setIsItalic ( $isItalic )

abstract

Sets 'isItalic' outline flag.

Parameters

boolean $isItalic

Returns: Zend_Pdf_Outline

setIsOpen ( $isOpen )

Sets 'isOpen' outline flag.

Parameters

boolean $isOpen

Returns: Zend_Pdf_Outline

setOptions ( array $options )

Set outline options.

Parameters

array $options

Returns: Zend_Pdf_Action

Exceptions

Zend_Pdf_Exception

setTarget ( $target = null )

abstract

Set outline target.

Null means no target

Parameters

Zend_Pdf_Target | string $target

Returns: Zend_Pdf_Outline

setTitle ( $title )

abstract

Set outline title.

Parameters

string $title

Returns: Zend_Pdf_Outline

valid ( )

Check if current position is valid.

Returns: boolean

Member Data Documentation

$_open = false

protected

$childOutlines = array()

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Attributes

Member Function Documentation

Member Data Documentation