Zend_Pdf_Annotation_Markup Class Reference

Public Member Functions
	__construct (Zend_Pdf_Element $annotationDictionary)
	Annotation object constructor.
Public Member Functions inherited from Zend_Pdf_Annotation
	getResource ()
	Get annotation dictionary.
	setBottom ($bottom)
	Set bottom edge of the annotation rectangle.
	getBottom ()
	Get bottom edge of the annotation rectangle.
	setTop ($top)
	Set top edge of the annotation rectangle.
	getTop ()
	Get top edge of the annotation rectangle.
	setRight ($right)
	Set right edge of the annotation rectangle.
	getRight ()
	Get right edge of the annotation rectangle.
	setLeft ($left)
	Set left edge of the annotation rectangle.
	getLeft ()
	Get left edge of the annotation rectangle.
	getText ()
	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.
	setText ($text)
	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.
	__construct (Zend_Pdf_Element $annotationDictionary)
	Annotation object constructor.

Static Public Member Functions
static	create ($x1, $y1, $x2, $y2, $text, $subType, $quadPoints)
	Create markup annotation object.
Static Public Member Functions inherited from Zend_Pdf_Annotation
static	load (Zend_Pdf_Element $resource)
	Load Annotation object from a specified resource.

Public Attributes
const	SUBTYPE_HIGHLIGHT = 'Highlight'
	Annotation subtypes.
const	SUBTYPE_UNDERLINE = 'Underline'
const	SUBTYPE_SQUIGGLY = 'Squiggly'
const	SUBTYPE_STRIKEOUT = 'StrikeOut'

Additional Inherited Members
Protected Attributes inherited from Zend_Pdf_Annotation
	$_annotationDictionary

Constructor & Destructor Documentation

__construct

(

Zend_Pdf_Element

$annotationDictionary

)

Annotation object constructor.

Exceptions

Zend_Pdf_Exception

Member Function Documentation

static create (   $x1,   $y1,   $x2,   $y2,   $text,   $subType,   $quadPoints  )

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

float	$x1
float	$y1
float	$x2
float	$y2
string	$text
string	$subType
array	$quadPoints	[x1 y1 x2 y2 x3 y3 x4 y4]

Returns

Zend_Pdf_Annotation_Markup

Exceptions

Zend_Pdf_Exception

Member Data Documentation

const SUBTYPE_HIGHLIGHT = 'Highlight'

Annotation subtypes.

const SUBTYPE_SQUIGGLY = 'Squiggly'

const SUBTYPE_STRIKEOUT = 'StrikeOut'

const SUBTYPE_UNDERLINE = 'Underline'