Pdf/Destination/Zoom.php

Show:

inherited

Classes
- \Zend_Pdf_Destination_Zoom

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

\Zend_Pdf_Destination_Zoom
jump to top

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-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Properties

\Zend_Pdf_Element_Array $_destinationArray

inherited

Destination description array

Inherited from: \Zend_Pdf_Destination_Explicit::$$_destinationArray

Details

Type: \Zend_Pdf_Element_Array
Inherited_from: \Zend_Pdf_Destination_Explicit::$$_destinationArray

boolean $_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

__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

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

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
$top	float	Top edge of displayed page
$zoom	float	Zoom factor

Returns

Type	Description
\Zend_Pdf_Destination_Zoom

Throws

Exception	Description
\Zend_Pdf_Exception

getLeftEdge() : float

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

Returns

Type	Description
float

getTopEdge() : float

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

Returns

Type	Description
float

getZoomFactor() : float

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

Returns

Type	Description
float

isRemote() : boolean

inherited

Returns true if it's a remote destination

Inherited from: \Zend_Pdf_Destination_Explicit::isRemote()

Returns

Type	Description
boolean

setLeftEdge(float $left) : \Zend_Pdf_Action_Zoom

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

Parameters

Name	Type	Description
$left	float

Returns

Type	Description
\Zend_Pdf_Action_Zoom

setTopEdge(float $top) : \Zend_Pdf_Action_Zoom

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

Parameters

Name	Type	Description
$top	float

Returns

Type	Description
\Zend_Pdf_Action_Zoom

setZoomFactor(float $zoom) : \Zend_Pdf_Action_Zoom

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

Parameters

Name	Type	Description
$zoom	float

Returns

Type	Description
\Zend_Pdf_Action_Zoom

Pdf/Destination/Zoom.php

\Zend_Pdf_Destination_Zoomjump to top

Properties

Methods

\Zend_Pdf_Destination_Zoom
jump to top