Pdf/Destination/Zoom.php
Show:
inherited
inherited
Classes
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-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
create(\Zend_Pdf_Page | integer $page, float $left = null, float $top = null, float $zoom = null) : \Zend_Pdf_Destination_Zoomstatic
Create destination object
Parameters
Returns
Throws
| 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 |
| Type | Description |
|---|---|
| \Zend_Pdf_Destination_Zoom |
| Exception | Description |
|---|---|
| \Zend_Pdf_Exception |
getLeftEdge() : floatGet left edge of the displayed page (null means viewer application 'current value')
Returns
| Type | Description |
|---|---|
| float |
getTopEdge() : floatGet top edge of the displayed page (null means viewer application 'current value')
Returns
| Type | Description |
|---|---|
| float |
getZoomFactor() : floatGet ZoomFactor of the displayed page (null or 0 means viewer application 'current value')
Returns
| Type | Description |
|---|---|
| float |
setLeftEdge(float $left) : \Zend_Pdf_Action_ZoomSet left edge of the displayed page (null means viewer application 'current value')
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $left | float |
| Type | Description |
|---|---|
| \Zend_Pdf_Action_Zoom |
setTopEdge(float $top) : \Zend_Pdf_Action_ZoomSet top edge of the displayed page (null means viewer application 'current viewer')
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $top | float |
| Type | Description |
|---|---|
| \Zend_Pdf_Action_Zoom |
setZoomFactor(float $zoom) : \Zend_Pdf_Action_ZoomSet ZoomFactor of the displayed page (null or 0 means viewer application 'current viewer')
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $zoom | float |
| Type | Description |
|---|---|
| \Zend_Pdf_Action_Zoom |