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 [email protected] 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 24593 2012-01-05 20:35:02Z matthew $

\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-2012 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'

Properties

\Zend_Pdf_Element_Dictionary|\Zend_Pdf_Element_Object|\Zend_Pdf_Element_Reference $_annotationDictionary =

inherited

Annotation dictionary

Inherited from: \Zend_Pdf_Annotation::$$_annotationDictionary

Details

Type: \Zend_Pdf_Element_Dictionary | \Zend_Pdf_Element_Object | \Zend_Pdf_Element_Reference
Inherited_from: \Zend_Pdf_Annotation::$$_annotationDictionary

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

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

getBottom() : float

inherited

Get bottom edge of the annotation rectangle.

Inherited from: \Zend_Pdf_Annotation::getBottom()

Returns

Type	Description
float

getLeft() : float

inherited

Get left edge of the annotation rectangle.

Inherited from: \Zend_Pdf_Annotation::getLeft()

Returns

Type	Description
float

getRight() : float

inherited

Get right edge of the annotation rectangle.

Inherited from: \Zend_Pdf_Annotation::getRight()

Returns

Type	Description
float

getText() : string

inherited

Return text to be displayed for the annotation or, if this type of annotation does not display text, an alternate description of the annotation’s contents in human-readable form.

Inherited from: \Zend_Pdf_Annotation::getText()

Returns

Type	Description
string

getTop() : float

inherited

Get top edge of the annotation rectangle.

Inherited from: \Zend_Pdf_Annotation::getTop()

Returns

Type	Description
float

setBottom(float $bottom) : \Zend_Pdf_Annotation

inherited

Set bottom edge of the annotation rectangle.

Inherited from: \Zend_Pdf_Annotation::setBottom()

Parameters

Name	Type	Description
$bottom	float

Returns

Type	Description
\Zend_Pdf_Annotation

setLeft(float $left) : \Zend_Pdf_Annotation

inherited

Set left edge of the annotation rectangle.

Inherited from: \Zend_Pdf_Annotation::setLeft()

Parameters

Name	Type	Description
$left	float

Returns

Type	Description
\Zend_Pdf_Annotation

setRight(float $right) : \Zend_Pdf_Annotation

inherited

Set right edge of the annotation rectangle.

Inherited from: \Zend_Pdf_Annotation::setRight()

Parameters

Name	Type	Description
$right	float

Returns

Type	Description
\Zend_Pdf_Annotation

setText(string $text) : \Zend_Pdf_Annotation

inherited

Set text to be displayed for the annotation or, if this type of annotation does not display text, an alternate description of the annotation’s contents in human-readable form.

Inherited from: \Zend_Pdf_Annotation::setText()

Parameters

Name	Type	Description
$text	string

Returns

Type	Description
\Zend_Pdf_Annotation

setTop(float $top) : \Zend_Pdf_Annotation

inherited

Set top edge of the annotation rectangle.

Inherited from: \Zend_Pdf_Annotation::setTop()

Parameters

Name	Type	Description
$top	float

Returns

Type	Description
\Zend_Pdf_Annotation

Pdf/Annotation/Markup.php

\Zend_Pdf_Annotation_Markupjump to top

Constants

Properties

Methods

\Zend_Pdf_Annotation_Markup
jump to top