Pdf/Destination/Zoom.php

Show: PublicProtectedPrivateinherited
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-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Pdf  
Subpackage
Destination  
Version
$Id$  

\Zend_Pdf_Destination_Zoom

Package: Zend_Pdf\Destination
Zend_Pdf_Destination_Zoom explicit detination
Destination array: [page /XYZ left top zoom] Display the page designated by page, with the coordinates (left, top) positioned at the upper-left corner of the window and the contents of the page magnified by the factor zoom. A null value for any of the parameters left, top, or zoom specifies that the current value of that parameter is to be retained unchanged. A zoom value of 0 has the same meaning as a null value.
Parent(s)
\Zend_Pdf_Destination_Explicit < \Zend_Pdf_Destination < \Zend_Pdf_Target
Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Methods

methodpubliccreate(\Zend_Pdf_Page | integer $page, float $left = null, float $top = null, float $zoom = null) : \Zend_Pdf_Destination_Zoom
static

Create destination object

Parameters
NameTypeDescription
$page\Zend_Pdf_Page | integer

Page object or page number

$leftfloat

Left edge of displayed page

$topfloat

Top edge of displayed page

$zoomfloat

Zoom factor

Returns
TypeDescription
\Zend_Pdf_Destination_Zoom
Throws
ExceptionDescription
\Zend_Pdf_Exception
methodpublicgetLeftEdge() : float

Get left edge of the displayed page (null means viewer application 'current value')

Returns
TypeDescription
float
methodpublicgetTopEdge() : float

Get top edge of the displayed page (null means viewer application 'current value')

Returns
TypeDescription
float
methodpublicgetZoomFactor() : float

Get ZoomFactor of the displayed page (null or 0 means viewer application 'current value')

Returns
TypeDescription
float
methodpublicsetLeftEdge(float $left) : \Zend_Pdf_Action_Zoom

Set left edge of the displayed page (null means viewer application 'current value')

Parameters
NameTypeDescription
$leftfloat
Returns
TypeDescription
\Zend_Pdf_Action_Zoom
methodpublicsetTopEdge(float $top) : \Zend_Pdf_Action_Zoom

Set top edge of the displayed page (null means viewer application 'current viewer')

Parameters
NameTypeDescription
$topfloat
Returns
TypeDescription
\Zend_Pdf_Action_Zoom
methodpublicsetZoomFactor(float $zoom) : \Zend_Pdf_Action_Zoom

Set ZoomFactor of the displayed page (null or 0 means viewer application 'current viewer')

Parameters
NameTypeDescription
$zoomfloat
Returns
TypeDescription
\Zend_Pdf_Action_Zoom
Documentation was generated by phpDocumentor 2.2.0 .