API Documentation

Pdf/Destination/FitBoundingBoxHorizontally.php

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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Pdf  
subpackage
Destination  
version
$Id: FitBoundingBoxHorizontally.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_Pdf_Destination_FitBoundingBoxHorizontally

Zend_Pdf_Destination_FitBoundingBoxHorizontally explicit detination

Destination array: [page /FitBH top]

(PDF 1.1) Display the page designated by page, with the vertical coordinate top positioned at the top edge of the window and the contents of the page magnified just enough to fit the entire width of its bounding box within the window.

Extends from
\Zend_Pdf_Destination_Explicit
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Pdf  
subpackage
Destination  

Methods

methodpublic__construct( \Zend_Pdf_Element $destinationArray ) : void

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 $top ) : \Zend_Pdf_Destination_FitBoundingBoxHorizontally
static

Create destination object

Parameters
Name Type Description
$page \Zend_Pdf_Page|integer Page object or page number
$top float Top edge of displayed page
Returns
Type Description
\Zend_Pdf_Destination_FitBoundingBoxHorizontally
Throws
Exception Description
\Zend_Pdf_Exception
methodpublicgetTopEdge( ) : float

Get top edge of the displayed page

Returns
Type Description
float
methodpublicisRemote( ) : boolean

Returns true if it's a remote destination

Inherited from: \Zend_Pdf_Destination_Explicit::isRemote()
Returns
Type Description
boolean
methodpublicsetTopEdge( float $top ) : \Zend_Pdf_Action_FitBoundingBoxHorizontally

Set top edge of the displayed page

Parameters
Name Type Description
$top float
Returns
Type Description
\Zend_Pdf_Action_FitBoundingBoxHorizontally
Documentation was generated by DocBlox 0.13.3.