API Documentation

Zend/Pdf/Outline.php

Show: inherited
Table of Contents

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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Pdf  
Subpackage
Actions  
Version
$Id: Outline.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Pdf_Outline

Package: Zend\Pdf\Outlines

Abstract PDF outline representation class

Implements
Children
\Zend_Pdf_Outline_Created
\Zend_Pdf_Outline_Loaded
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Todo
Implement an ability to associate an outline item with a structure element (PDF 1.3 feature)  

Properties

Propertyprotectedboolean  $_open= 'false'

True if outline is open.

Default valuefalseDetails
Type
boolean
Propertypublicarray  $childOutlines= 'array()'

Array of child outlines (array of Zend_Pdf_Outline objects)

Default valuearray()Details
Type
array

Methods

methodpubliccount( ) : int

count()

Returns
Type Description
int
methodpubliccreate(  $param1,  $param2 = null ) : \Zend_Pdf_Outline
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

Parameters
Name Type Description
$param1
$param2
Returns
Type Description
\Zend_Pdf_Outline
Throws
Exception Description
\Zend_Pdf_Exception
methodpubliccurrent( ) : \Zend_Pdf_Outline

Returns the child outline.

Returns
Type Description
\Zend_Pdf_Outline
methodpublicdumpOutline( \Zend_Pdf_ElementFactory $factory, boolean $updateNavigation, \Zend_Pdf_Element $parent, \Zend_Pdf_Element $prev = null, \SplObjectStorage $processedOutlines = null ) : \Zend_Pdf_Element
abstract

Dump Outline and its child outlines into PDF structures

Returns dictionary indirect object or reference

Parameters
Name Type Description
$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
Type Description
\Zend_Pdf_Element
methodpublicgetChildren( ) : \Zend_Pdf_Outline|null

Returns the child outline.

Returns
Type Description
\Zend_Pdf_Outline|null
methodpublicgetColor( ) : \Zend_Pdf_Color_Rgb
abstract

Get outline text color.

Returns
Type Description
\Zend_Pdf_Color_Rgb
methodpublicgetOptions( ) : array

Get outline options

Returns
Type Description
array
methodpublicgetTarget( ) : \Zend_Pdf_Target
abstract

Get outline target.

Returns
Type Description
\Zend_Pdf_Target
methodpublicgetTitle( ) : string
abstract

Get outline title.

Returns
Type Description
string
methodpublichasChildren( ) : bool

Implements RecursiveIterator interface.

Returns
Type Description
bool whether container has any pages
methodpublicisBold( ) : boolean
abstract

Returns true if outline item is displayed in bold

Returns
Type Description
boolean
methodpublicisItalic( ) : boolean
abstract

Returns true if outline item is displayed in italic

Returns
Type Description
boolean
methodpublicisOpen( ) : boolean

Returns true if outline item is open by default

Returns
Type Description
boolean
methodpublickey( ) : integer

Returns current iterator key

Returns
Type Description
integer
methodpublicnext( ) : void

Go to next child

methodpublicrewind( ) : void

Rewind children

methodpublicsetColor( \Zend_Pdf_Color_Rgb $color ) : \Zend_Pdf_Outline
abstract

Set outline text color.

(null means default color which is black)

Parameters
Name Type Description
$color \Zend_Pdf_Color_Rgb
Returns
Type Description
\Zend_Pdf_Outline
methodpublicsetIsBold( boolean $isBold ) : \Zend_Pdf_Outline
abstract

Sets 'isBold' outline flag

Parameters
Name Type Description
$isBold boolean
Returns
Type Description
\Zend_Pdf_Outline
methodpublicsetIsItalic( boolean $isItalic ) : \Zend_Pdf_Outline
abstract

Sets 'isItalic' outline flag

Parameters
Name Type Description
$isItalic boolean
Returns
Type Description
\Zend_Pdf_Outline
methodpublicsetIsOpen( boolean $isOpen ) : \Zend_Pdf_Outline

Sets 'isOpen' outline flag

Parameters
Name Type Description
$isOpen boolean
Returns
Type Description
\Zend_Pdf_Outline
methodpublicsetOptions( array $options ) : \Zend_Pdf_Action

Set outline options

Parameters
Name Type Description
$options array
Returns
Type Description
\Zend_Pdf_Action
Throws
Exception Description
\Zend_Pdf_Exception
methodpublicsetTarget( \Zend_Pdf_Target|string $target = null ) : \Zend_Pdf_Outline
abstract

Set outline target.

Null means no target

Parameters
Name Type Description
$target \Zend_Pdf_Target|string
Returns
Type Description
\Zend_Pdf_Outline
methodpublicsetTitle( string $title ) : \Zend_Pdf_Outline
abstract

Set outline title

Parameters
Name Type Description
$title string
Returns
Type Description
\Zend_Pdf_Outline
methodpublicvalid( ) : boolean

Check if current position is valid

Returns
Type Description
boolean
Documentation was generated by DocBlox 0.15.1.