Pdf/Annotation/Markup.php
- category
- Zend
- copyright
- Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
- license
- http://framework.zend.com/license/new-bsd New BSD License
- package
- Zend_Pdf
- subpackage
- Annotation
- Classes
- Zend_Pdf_Annotation_Markup
Description
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.
Zend_Pdf_Annotation_Markup
- Extends from
- Zend_Pdf_Annotation
- copyright
- Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
- license
- http://framework.zend.com/license/new-bsd New BSD License
- package
- Zend_Pdf
- subpackage
- Annotation
- Constants
- SUBTYPE_HIGHLIGHT
- SUBTYPE_UNDERLINE
- SUBTYPE_SQUIGGLY
- SUBTYPE_STRIKEOUT
- Methods
- __construct
- create
Description
A markup annotation
Constants
SUBTYPE_HIGHLIGHT
SUBTYPE_HIGHLIGHT = 'Highlight'
Annotation subtypes
Details
- value
- Highlight
SUBTYPE_UNDERLINE
SUBTYPE_UNDERLINE = 'Underline'
Details
- value
- Underline
SUBTYPE_SQUIGGLY
SUBTYPE_SQUIGGLY = 'Squiggly'
Details
- value
- Squiggly
SUBTYPE_STRIKEOUT
SUBTYPE_STRIKEOUT = 'StrikeOut'
Details
- value
- StrikeOut
Methods
__construct
__construct(
$annotationDictionary
)
:
Annotation object constructor
Arguments
- $annotationDictionary
Details
- visibility
- public
- final
- false
- static
- false
- throws
create
create(
float $x1, float $y1, float $x2, float $y2, string $text, string $subType, array $quadPoints
)
:
Zend_Pdf_Annotation_MarkupCreate 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).
Arguments
- $x1
- float
- $y1
- float
- $x2
- float
- $y2
- float
- $text
- string
- $subType
- string
- $quadPoints
- array
[x1 y1 x2 y2 x3 y3 x4 y4]
Output
Details
- visibility
- public
- final
- false
- static
- true
- throws