API Documentation

Zend/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 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: Created.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Pdf_Outline_Created

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

Methods

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

Object constructor

Parameters
Name Type Description
$options array
Throws
Exception Description
\Zend_Pdf_Exception
methodpublicgetColor( ) : \Zend_Pdf_Color_Rgb

Get outline text color.

Returns
Type Description
\Zend_Pdf_Color_Rgb
methodpublicgetTarget( ) : \Zend_Pdf_Target

Get outline target.

Returns
Type Description
\Zend_Pdf_Target
methodpublicgetTitle( ) : string

Get outline title.

Returns
Type Description
string
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
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
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
Documentation was generated by DocBlox 0.15.1.