API Documentation

Pdf/Outline.php

Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Pdf
subpackage
Actions
version
$Id: Outline.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Pdf_Outline

Description

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.

Zend_Pdf_Outline
jump to top

Implements
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Pdf
subpackage
Outlines
todo
Implement an ability to associate an outline item with a structure element (PDF 1.3 feature)
Properties
$_open
$childOutlines
Methods
getTitle
setTitle
isOpen
setIsOpen
isItalic
setIsItalic
isBold
setIsBold
getColor
setColor
getTarget
setTarget
getOptions
setOptions
create
openOutlinesCount
dumpOutline
current
key
next
rewind
valid
getChildren
hasChildren
count

Description

Abstract PDF outline representation class

Properties

$_open
jump to class

boolean $_open = 'false'

True if outline is open.

Details

$_open
boolean
visibility
protected
default
false
final
false
static
false

$childOutlines
jump to class

array $childOutlines = 'array'

Array of child outlines (array of Zend_Pdf_Outline objects)

Details

$childOutlines
array
visibility
public
default
array
final
false
static
false

Methods

count
jump to class

count( ) : int

count()

Output
int
Details
visibility
public
final
false
static
false

create
jump to class

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

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

Arguments
$param1
$param2
Output
Zend_Pdf_Outline
Details
visibility
public
final
false
static
true
throws

current
jump to class

current( ) : Zend_Pdf_Outline

Returns the child outline.

Output
Zend_Pdf_Outline
Details
visibility
public
final
false
static
false

dumpOutline
jump to class

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

Dump Outline and its child outlines into PDF structures

Returns dictionary indirect object or reference

Arguments
$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
Output
Zend_Pdf_Element
Details
visibility
public
final
false
static
false

getChildren
jump to class

getChildren( ) : Zend_Pdf_Outline|null

Returns the child outline.

Output
Zend_Pdf_Outline|null
Details
visibility
public
final
false
static
false

getColor
jump to class

getColor( ) : Zend_Pdf_Color_Rgb

Get outline text color.

Output
Zend_Pdf_Color_Rgb
Details
visibility
public
final
false
static
false

getOptions
jump to class

getOptions( ) : array

Get outline options

Output
array
Details
visibility
public
final
false
static
false

getTarget
jump to class

getTarget( ) : Zend_Pdf_Target

Get outline target.

Output
Zend_Pdf_Target
Details
visibility
public
final
false
static
false

getTitle
jump to class

getTitle( ) : string

Get outline title.

Output
string
Details
visibility
public
final
false
static
false

hasChildren
jump to class

hasChildren( ) : bool

Implements RecursiveIterator interface.

Output
bool
whether container has any pages
Details
visibility
public
final
false
static
false

isBold
jump to class

isBold( ) : boolean

Returns true if outline item is displayed in bold

Output
boolean
Details
visibility
public
final
false
static
false

isItalic
jump to class

isItalic( ) : boolean

Returns true if outline item is displayed in italic

Output
boolean
Details
visibility
public
final
false
static
false

isOpen
jump to class

isOpen( ) : boolean

Returns true if outline item is open by default

Output
boolean
Details
visibility
public
final
false
static
false

key
jump to class

key( ) : integer

Returns current iterator key

Output
integer
Details
visibility
public
final
false
static
false

next
jump to class

next( ) :

Go to next child

Details
visibility
public
final
false
static
false

openOutlinesCount
jump to class

openOutlinesCount( ) : integer

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

Output
integer
Details
visibility
public
final
false
static
false
internal

rewind
jump to class

rewind( ) :

Rewind children

Details
visibility
public
final
false
static
false

setColor
jump to class

setColor( Zend_Pdf_Color_Rgb $color ) : Zend_Pdf_Outline

Set outline text color.

(null means default color which is black)

Arguments
$color
Zend_Pdf_Color_Rgb
Output
Zend_Pdf_Outline
Details
visibility
public
final
false
static
false

setIsBold
jump to class

setIsBold( boolean $isBold ) : Zend_Pdf_Outline

Sets 'isBold' outline flag

Arguments
$isBold
boolean
Output
Zend_Pdf_Outline
Details
visibility
public
final
false
static
false

setIsItalic
jump to class

setIsItalic( boolean $isItalic ) : Zend_Pdf_Outline

Sets 'isItalic' outline flag

Arguments
$isItalic
boolean
Output
Zend_Pdf_Outline
Details
visibility
public
final
false
static
false

setIsOpen
jump to class

setIsOpen( boolean $isOpen ) : Zend_Pdf_Outline

Sets 'isOpen' outline flag

Arguments
$isOpen
boolean
Output
Zend_Pdf_Outline
Details
visibility
public
final
false
static
false

setOptions
jump to class

setOptions( array $options ) : Zend_Pdf_Action

Set outline options

Arguments
$options
array
Output
Zend_Pdf_Action
Details
visibility
public
final
false
static
false
throws

setTarget
jump to class

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

Set outline target.

Null means no target

Arguments
$target
Zend_Pdf_Targetstring
Output
Zend_Pdf_Outline
Details
visibility
public
final
false
static
false

setTitle
jump to class

setTitle( string $title ) : Zend_Pdf_Outline

Set outline title

Arguments
$title
string
Output
Zend_Pdf_Outline
Details
visibility
public
final
false
static
false

valid
jump to class

valid( ) : boolean

Check if current position is valid

Output
boolean
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.