Pdf/Annotation/Markup.php

Show:

inherited

Classes
- \Zend_Pdf_Annotation_Markup

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: Annotation
Version: $Id$

\Zend_Pdf_Annotation_Markup
jump to top

Package: Zend_Pdf\Annotation

A markup annotation

An annotation associates an object such as a note, sound, or movie with a location on a page of a PDF document, or provides a way to interact with the user by means of the mouse and keyboard.

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

Constants

 
                SUBTYPE_HIGHLIGHT
                = 'Highlight'

Annotation subtypes

 
                SUBTYPE_UNDERLINE
                = 'Underline'

 
                SUBTYPE_SQUIGGLY
                = 'Squiggly'

 
                SUBTYPE_STRIKEOUT
                = 'StrikeOut'

Methods

__construct( $annotationDictionary) : void

Annotation object constructor

Parameters

Name	Type	Description
$annotationDictionary

Throws

Exception	Description
\Zend_Pdf_Exception

create(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).