API Documentation

Pdf/Outline/Created.php

Includes 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: Created.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Pdf_Outline_Created

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_Created
jump to top

Extends from
Zend_Pdf_Outline
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
$_title
$_color
$_italic
$_bold
$_target
Methods
getTitle
setTitle
isItalic
setIsItalic
isBold
setIsBold
getColor
setColor
getTarget
setTarget
__construct
dumpOutline

Description

PDF outline representation class

Properties

$_bold
jump to class

boolean $_bold = 'false'

True if outline item is displayed in bold.

Default value is false.

Details

$_bold
boolean
visibility
protected
default
false
final
false
static
false

$_color
jump to class

Zend_Pdf_Color_Rgb $_color = 'null'

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

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

Details

$_color
Zend_Pdf_Color_Rgb
visibility
protected
default
null
final
false
static
false

$_italic
jump to class

boolean $_italic = 'false'

True if outline item is displayed in italic.

Default value is false.

Details

$_italic
boolean
visibility
protected
default
false
final
false
static
false

$_target
jump to class

Zend_Pdf_Destination|Zend_Pdf_Action $_target = 'null'

Target destination or action.

String means named destination

Null means no target.

Details

$_target
Zend_Pdf_Destination|Zend_Pdf_Action
visibility
protected
default
null
final
false
static
false

$_title
jump to class

string $_title = ''

Outline title.

Details

$_title
string
visibility
protected
default
final
false
static
false

Methods

__construct
jump to class

__construct( array $options = array ) :

Object constructor

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

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
internal
throws

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

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

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

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

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
throws

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
Documentation was generated by DocBlox.