Class SetaPDF_Core_Document_Page_Annotations in SetaPDF v2 API Reference

Index

\SetaPDF
1. Core
2. Core
  1. Document
  2. Document
    1. Page
    2. Page

SetaPDF_Core_Document_Page_Annotations Helper class for handling annotations of a page

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

Class hierarchy

SetaPDF_Core_Document_Page_Annotations

Summary

Constants

TAB_ORDER_ANNOTATIONS_ARRAY

public const string SetaPDF_Core_Document_Page_Annotations::TAB_ORDER_ANNOTATIONS_ARRAY = 'A'

Constant specifying the annotations array tab order

TAB_ORDER_COLUMN

public const string SetaPDF_Core_Document_Page_Annotations::TAB_ORDER_COLUMN = 'C'

Constant specifying the column tab order

TAB_ORDER_ROW

public const string SetaPDF_Core_Document_Page_Annotations::TAB_ORDER_ROW = 'R'

Constant specifying the row tab order

TAB_ORDER_STRUCTURE

public const string SetaPDF_Core_Document_Page_Annotations::TAB_ORDER_STRUCTURE = 'S'

Constant specifying the structure tab order

TAB_ORDER_WIDGET

public const string SetaPDF_Core_Document_Page_Annotations::TAB_ORDER_WIDGET = 'W'

Constant specifying the widget tab order

Properties

$_page

protected SetaPDF_Core_Document_Page SetaPDF_Core_Document_Page_Annotations::$_page

The page object

Methods

__construct()

public SetaPDF_Core_Document_Page_Annotations::__construct (

SetaPDF_Core_Document_Page $page

)

The constructor.

Parameters

$page : SetaPDF_Core_Document_Page

add()

public SetaPDF_Core_Document_Page_Annotations::add (

SetaPDF_Core_Document_Page_Annotation $annotation

): SetaPDF_Core_Type_IndirectObjectInterface

Adds an annotation to the page.

Parameters

$annotation : SetaPDF_Core_Document_Page_Annotation

Exceptions

Throws SetaPDF_Core_Type_Exception

cleanUp()

public SetaPDF_Core_Document_Page_Annotations::cleanUp (

void

): void

Release memory/resources.

getAll()

public SetaPDF_Core_Document_Page_Annotations::getAll (

[ string $subtype = null ]

): SetaPDF_Core_Document_Page_Annotation[]

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.

Exceptions

Throws SetaPDF_Core_Type_Exception

getArray()

public SetaPDF_Core_Document_Page_Annotations::getArray (

[ boolean $create = false ]

): false|SetaPDF_Core_Type_Array

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

Parameters

$create : boolean

Exceptions

Throws SetaPDF_Core_Type_Exception

getByName()

public SetaPDF_Core_Document_Page_Annotations::getByName (

string $name [, string $encoding = 'UTF-8' ]

): bool|SetaPDF_Core_Document_Page_Annotation

Get an annotation by its name (NM entry)

Parameters

$name : string: The name of the annotation.
$encoding : string

Exceptions

Throws SetaPDF_Core_Document_ObjectNotFoundException

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Core_Type_IndirectReference_Exception

getPage()

public SetaPDF_Core_Document_Page_Annotations::getPage (

void

): SetaPDF_Core_Document_Page

Get the page.

getTabOrder()

public SetaPDF_Core_Document_Page_Annotations::getTabOrder (

void

): string|null

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

Exceptions

Throws SetaPDF_Core_Type_Exception

remove()

public SetaPDF_Core_Document_Page_Annotations::remove (

SetaPDF_Core_Document_Page_Annotation $annotation

): bool

Removes an annotation from the annotation array of the page.

Parameters

$annotation : SetaPDF_Core_Document_Page_Annotation

Exceptions

Throws SetaPDF_Core_Type_Exception

setTabOrder()

public SetaPDF_Core_Document_Page_Annotations::setTabOrder (

string|null $tabOrder

): void

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

Parameters

$tabOrder : string|null

Exceptions

Throws SetaPDF_Core_Type_Exception