Pdf/Destination/FitRectangle.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
Destination  
Version
$Id: FitRectangle.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Pdf_Destination_FitRectangle

Package: Zend\Pdf\Destination

Zend_Pdf_Destination_FitRectangle explicit detination

Destination array: [page /FitR left bottom right top]

Display the page designated by page, with its contents magnified just enough to fit the rectangle specified by the coordinates left, bottom, right, and top entirely within the window both horizontally and vertically. If the required horizontal and vertical magnification factors are different, use the smaller of the two, centering the rectangle within the window in the other dimension.

Parent(s)
\Zend_Pdf_Destination_Explicit < \Zend_Pdf_Destination < \Zend_Pdf_Target
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotected\Zend_Pdf_Element_Array $_destinationArray =
inherited

Destination description array

Inherited from: \Zend_Pdf_Destination_Explicit::$$_destinationArray
Propertyprotectedboolean $_isRemote =
inherited

True if it's a remote destination

Inherited from: \Zend_Pdf_Destination_Explicit::$$_isRemote
Details
Type
boolean
Inherited_from
\Zend_Pdf_Destination_Explicit::$$_isRemote  

Methods

methodpublic__construct(\Zend_Pdf_Element $destinationArray) : void
inherited

Explicit destination object constructor

Inherited from: \Zend_Pdf_Destination_Explicit::__construct()
Parameters
Name Type Description
$destinationArray \Zend_Pdf_Element
Throws
Exception Description
\Zend_Pdf_Exception
methodpubliccreate(\Zend_Pdf_Page | integer $page, float $left, float $bottom, float $right, float $top) : \Zend_Pdf_Destination_FitRectangle
static

Create destination object

Parameters
Name Type Description
$page \Zend_Pdf_Page | integer

Page object or page number

$left float

Left edge of displayed page

$bottom float

Bottom edge of displayed page

$right float

Right edge of displayed page

$top float

Top edge of displayed page

Returns
Type Description
\Zend_Pdf_Destination_FitRectangle
Throws
Exception Description
\Zend_Pdf_Exception
methodpublicgetBottomEdge() : float

Get bottom edge of the displayed page

Returns
Type Description
float
methodpublicgetLeftEdge() : float

Get left edge of the displayed page

Returns
Type Description
float
methodpublicgetRightEdge() : float

Get right edge of the displayed page

Returns
Type Description
float
methodpublicgetTopEdge() : float

Get top edge of the displayed page

Returns
Type Description
float
methodpublicisRemote() : boolean
inherited

Returns true if it's a remote destination

Inherited from: \Zend_Pdf_Destination_Explicit::isRemote()
Returns
Type Description
boolean
methodpublicsetBottomEdge(float $bottom) : \Zend_Pdf_Action_FitRectangle

Set bottom edge of the displayed page

Parameters
Name Type Description
$bottom float
Returns
Type Description
\Zend_Pdf_Action_FitRectangle
methodpublicsetLeftEdge(float $left) : \Zend_Pdf_Action_FitRectangle

Set left edge of the displayed page

Parameters
Name Type Description
$left float
Returns
Type Description
\Zend_Pdf_Action_FitRectangle
methodpublicsetRightEdge(float $right) : \Zend_Pdf_Action_FitRectangle

Set right edge of the displayed page

Parameters
Name Type Description
$right float
Returns
Type Description
\Zend_Pdf_Action_FitRectangle
methodpublicsetTopEdge(float $top) : \Zend_Pdf_Action_FitRectangle

Set top edge of the displayed page

Parameters
Name Type Description
$top float
Returns
Type Description
\Zend_Pdf_Action_FitRectangle
Documentation was generated by phpDocumentor 2.0.0a8.