API Documentation

Zend/Pdf/Annotation/Markup.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 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
Annotation  
Version
$Id: Markup.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Pdf_Annotation_Markup

Package: Zend\Pdf\Annotation

A markup annotation

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

Constants

Constant  SUBTYPE_HIGHLIGHT = 'Highlight'

Annotation subtypes

Constant  SUBTYPE_UNDERLINE = 'Underline'
Constant  SUBTYPE_SQUIGGLY = 'Squiggly'
Constant  SUBTYPE_STRIKEOUT = 'StrikeOut'

Methods

methodpublic__construct(  $annotationDictionary ) : void

Annotation object constructor

Parameters
Name Type Description
$annotationDictionary
Throws
Exception Description
\Zend_Pdf_Exception
methodpubliccreate( float $x1, float $y1, float $x2, float $y2, string $text, string $subType, array $quadPoints ) : \Zend_Pdf_Annotation_Markup
static

Create markup annotation object

Text markup annotations appear as highlights, underlines, strikeouts or jagged ("squiggly") underlines in the text of a document. When opened, they display a pop-up window containing the text of the associated note.

$subType parameter may contain Zend_Pdf_Annotation_Markup::SUBTYPE_HIGHLIGHT Zend_Pdf_Annotation_Markup::SUBTYPE_UNDERLINE Zend_Pdf_Annotation_Markup::SUBTYPE_SQUIGGLY Zend_Pdf_Annotation_Markup::SUBTYPE_STRIKEOUT for for a highlight, underline, squiggly-underline, or strikeout annotation, respectively.

$quadPoints is an array of 8xN numbers specifying the coordinates of N quadrilaterals default user space. Each quadrilateral encompasses a word or group of contiguous words in the text underlying the annotation. The coordinates for each quadrilateral are given in the order x1 y1 x2 y2 x3 y3 x4 y4 specifying the quadrilateral’s four vertices in counterclockwise order starting from left bottom corner. The text is oriented with respect to the edge connecting points (x1, y1) and (x2, y2).

Parameters
Name Type Description
$x1 float
$y1 float
$x2 float
$y2 float
$text string
$subType string
$quadPoints array

[x1 y1 x2 y2 x3 y3 x4 y4]

Returns
Type Description
\Zend_Pdf_Annotation_Markup
Throws
Exception Description
\Zend_Pdf_Exception
Documentation was generated by DocBlox 0.15.1.