SetaPDF_Core_Document_Page_Annotations Helper class for handling annotations of a page

File: /SetaPDF/Core/Document/Page/Annotations.php

Class hierarchy

Summary

Constants

TAB_ORDER_ANNOTATIONS_ARRAY

Constant specifying the annotations array tab order

TAB_ORDER_COLUMN

Constant specifying the column tab order

TAB_ORDER_ROW

Constant specifying the row tab order

TAB_ORDER_STRUCTURE

Constant specifying the structure tab order

TAB_ORDER_WIDGET

Constant specifying the widget tab order


Properties


Methods

__construct()

cleanUp()

Release memory/resources.

getAll()

Get all annotations of this page.

Optionally the results can be filtered by the subtype parameter.

Parameters
$subtype : string

See SetaPDF_Core_Document_Page_Annotation::TYPE_* constants for possible values.

getArray()

public false|SetaPDF_Core_Type_Array SetaPDF_Core_Document_Page_Annotations::getArray ( [ boolean $create = false ] )

Returns the Annots array if available or creates a new one.

Parameters
$create : boolean
 

getByName()

public bool|SetaPDF_Core_Document_Page_Annotation SetaPDF_Core_Document_Page_Annotations::getByName ( string $name [, string $encoding = 'UTF-8' ] )

Get an annotation by its name (NM entry)

Parameters
$name : string

The name of the annotation.

$encoding : string
 

getTabOrder()

Get the tab order that shall be used for annotations on the page.

remove()

Removes an annotation from the annotation array of the page.

Parameters
$annotation : SetaPDF_Core_Document_Page_Annotation
 

setTabOrder()

public void SetaPDF_Core_Document_Page_Annotations::setTabOrder ( string|null $tabOrder )

Set the tab order that shall be used for annotations on the page.

Parameters
$tabOrder : string|null