Pdf/Outline/Created.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 [email protected] 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: Created.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Pdf_Outline_Created
jump to top

Package: Zend\Pdf\Outlines

PDF outline representation class

Parent(s)
\Zend_Pdf_Outline
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 $_bold = false

True if outline item is displayed in bold.

Default value is false.

Default valuefalseDetails
Type
boolean
Propertyprotected\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).

Default valuenullDetails
Type
\Zend_Pdf_Color_Rgb
Propertyprotectedboolean $_italic = false

True if outline item is displayed in italic.

Default value is false.

Default valuefalseDetails
Type
boolean
Propertyprotectedboolean $_open = false
inherited

True if outline is open.

Inherited from: \Zend_Pdf_Outline::$$_open
Default valuefalseDetails
Type
boolean
Inherited_from
\Zend_Pdf_Outline::$$_open  
Propertyprotected\Zend_Pdf_Destination|\Zend_Pdf_Action $_target = null

Target destination or action.

String means named destination

Null means no target.

Default valuenullDetails
Type
\Zend_Pdf_Destination | \Zend_Pdf_Action
Propertyprotectedstring $_title =

Outline title.

Details
Type
string
Propertypublicarray $childOutlines = array()
inherited

Array of child outlines (array of Zend_Pdf_Outline objects)

Inherited from: \Zend_Pdf_Outline::$$childOutlines
Default valuearray()Details
Type
array
Inherited_from
\Zend_Pdf_Outline::$$childOutlines  

Methods

methodpublic__construct(array $options = array()) : void

Object constructor

Parameters
Name Type Description
$options array
Throws
Exception Description
\Zend_Pdf_Exception
methodpubliccount() : int
inherited

count()

Inherited from: \Zend_Pdf_Outline::count()
Returns
Type Description
int
methodpubliccreate( $param1,  $param2 = null) : \Zend_Pdf_Outline
staticinherited

Create new Outline object

Inherited from: \Zend_Pdf_Outline::create()

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
inherited

Returns the child outline.

Inherited from: \Zend_Pdf_Outline::current()
Returns
Type Description
\Zend_Pdf_Outline
methodpublicgetChildren() : \Zend_Pdf_Outline | null
inherited

Returns the child outline.

Inherited from: \Zend_Pdf_Outline::getChildren()
Returns
Type Description
\Zend_Pdf_Outline | null
methodpublicgetColor() : \Zend_Pdf_Color_Rgb

Get outline text color.

Returns
Type Description
\Zend_Pdf_Color_Rgb
methodpublicgetOptions() : array
inherited

Get outline options

Inherited from: \Zend_Pdf_Outline::getOptions()
Returns
Type Description
array
methodpublicgetTarget() : \Zend_Pdf_Target

Get outline target.

Returns
Type Description
\Zend_Pdf_Target
methodpublicgetTitle() : string

Get outline title.

Returns
Type Description
string
methodpublichasChildren() : bool
inherited

Implements RecursiveIterator interface.

Inherited from: \Zend_Pdf_Outline::hasChildren()
Returns
Type Description
bool whether container has any pages
methodpublicisBold() : boolean

Returns true if outline item is displayed in bold

Returns
Type Description
boolean
methodpublicisItalic() : boolean

Returns true if outline item is displayed in italic

Returns
Type Description
boolean
methodpublicisOpen() : boolean
inherited

Returns true if outline item is open by default

Inherited from: \Zend_Pdf_Outline::isOpen()
Returns
Type Description
boolean
methodpublickey() : integer
inherited

Returns current iterator key

Inherited from: \Zend_Pdf_Outline::key()
Returns
Type Description
integer
methodpublicnext() : void
inherited

Go to next child

Inherited from: \Zend_Pdf_Outline::next()
methodpublicrewind() : void
inherited

Rewind children

Inherited from: \Zend_Pdf_Outline::rewind()
methodpublicsetColor(\Zend_Pdf_Color_Rgb $color) : \Zend_Pdf_Outline

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

Sets 'isBold' outline flag

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

Sets 'isItalic' outline flag

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

Sets 'isOpen' outline flag

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

Set outline options

Inherited from: \Zend_Pdf_Outline::setOptions()
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

Set outline target.

Null means no target

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

Set outline title

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

Check if current position is valid

Inherited from: \Zend_Pdf_Outline::valid()
Returns
Type Description
boolean
Documentation was generated by phpDocumentor 2.0.0a8.