Pdf/Annotation.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
version: $Id: Annotation.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_Pdf_Annotation

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
jump to top

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
Properties: $_annotationDictionary
Methods: getResource; setBottom; getBottom; setTop; getTop; setRight; getRight; setLeft; getLeft; getText; setText; __construct; load

Description

Abstract PDF annotation representation class

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.

Properties

$_annotationDictionary
jump to class

Zend_Pdf_Element_Dictionary|Zend_Pdf_Element_Object|Zend_Pdf_Element_Reference $_annotationDictionary = ''

Annotation dictionary

Details

$_annotationDictionary: Zend_Pdf_Element_Dictionary|Zend_Pdf_Element_Object|Zend_Pdf_Element_Reference
visibility: protected
default
final: false
static: false

Methods

__construct
jump to class

__construct(
           $annotationDictionary
          )
        
        :

Annotation object constructor

Arguments

$annotationDictionary

Details

visibility: public
final: false
static: false
throws

getBottom
jump to class

getBottom(
          
          )
        
        :
        float

Get bottom edge of the annotation rectangle.

Output

float

Details

visibility: public
final: false
static: false

getLeft
jump to class

getLeft(
          
          )
        
        :
        float

Get left edge of the annotation rectangle.

Output

float

Details

visibility: public
final: false
static: false

getResource
jump to class

getResource(
          
          )
        
        :
        Zend_Pdf_Element

Get annotation dictionary

Output

Zend_Pdf_Element

Details

visibility: public
final: false
static: false
internal

getRight
jump to class

getRight(
          
          )
        
        :
        float

Get right edge of the annotation rectangle.

Output

float

Details

visibility: public
final: false
static: false

getText
jump to class

getText(
          
          )
        
        :
        string

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.

Output

string

Details

visibility: public
final: false
static: false

getTop
jump to class

getTop(
          
          )
        
        :
        float

Get top edge of the annotation rectangle.

Output

float

Details

visibility: public
final: false
static: false

load
jump to class

load(
           $resource
          )
        
        :
        Zend_Pdf_Annotation

Load Annotation object from a specified resource

Arguments

$resource

Output

Zend_Pdf_Annotation

Details

visibility: public
final: false
static: true
internal

setBottom
jump to class

setBottom(
          float $bottom
          )
        
        :
        Zend_Pdf_Annotation

Set bottom edge of the annotation rectangle.

Arguments

$bottom: float

Output

Zend_Pdf_Annotation

Details

visibility: public
final: false
static: false

setLeft
jump to class

setLeft(
          float $left
          )
        
        :
        Zend_Pdf_Annotation

Set left edge of the annotation rectangle.

Arguments

$left: float

Output

Zend_Pdf_Annotation

Details

visibility: public
final: false
static: false

setRight
jump to class

setRight(
          float $right
          )
        
        :
        Zend_Pdf_Annotation

Set right edge of the annotation rectangle.

Arguments

$right: float

Output

Zend_Pdf_Annotation

Details

visibility: public
final: false
static: false

setText
jump to class

setText(
          string $text
          )
        
        :
        Zend_Pdf_Annotation

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.

Arguments

$text: string

Output

Zend_Pdf_Annotation

Details

visibility: public
final: false
static: false

setTop
jump to class

setTop(
          float $top
          )
        
        :
        Zend_Pdf_Annotation

Set top edge of the annotation rectangle.

Arguments

$top: float

Output

Zend_Pdf_Annotation

Details

visibility: public
final: false
static: false

API Documentation

Pdf/Annotation.php

Description

Zend_Pdf_Annotationjump to top

Description

Properties

$_annotationDictionaryjump to class

Details

Methods

__constructjump to class

Arguments

Details

getBottomjump to class

Output

Details

getLeftjump to class

Output

Details

getResourcejump to class

Output

Details

getRightjump to class

Output

Details

getTextjump to class

Output

Details

getTopjump to class

Output

Details

loadjump to class

Arguments

Output

Details

setBottomjump to class

Arguments

Output

Details

setLeftjump to class

Arguments

Output

Details

setRightjump to class

Arguments

Output

Details

setTextjump to class

Arguments

Output

Details

setTopjump to class

Arguments

Output

Details

Zend_Pdf_Annotation
jump to top

$_annotationDictionary
jump to class

__construct
jump to class

getBottom
jump to class

getLeft
jump to class

getResource
jump to class

getRight
jump to class

getText
jump to class

getTop
jump to class

load
jump to class

setBottom
jump to class

setLeft
jump to class

setRight
jump to class

setText
jump to class

setTop
jump to class