Index

  1. \SetaPDF
    1. Core
    2. Core
      1. Document
      2. Document
        1. Page
        2. Page
          1. Annotation
          2. Annotation
            1. Widget
            2. Widget
            3. AdditionalActions
            4. AppearanceCharacteristics
            5. BorderEffect
            6. BorderStyle
            7. Caret
            8. Circle
            9. FileAttachment
            10. Flags
            11. FreeText
            12. Highlight
            13. Ink
            14. Line
            15. LineEndingStyle
            16. Link
            17. Markup
            18. PolyLine
            19. Polygon
            20. Popup
            21. QuadPointsTrait
            22. Screen
            23. Square
            24. Squiggly
            25. Stamp
            26. StrikeOut
            27. Text
            28. TextMarkup
            29. Underline

SetaPDF_Core_Document_Page_Annotation Class representing a PDF annotation

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

See PDF 32000-1:2008 - 12.5

Class hierarchy

Summary

Static Methods

Methods

Properties

Constants

Constants

TYPE_3D

public const string SetaPDF_Core_Document_Page_Annotation::TYPE_3D = '3D'

Annotation type

TYPE_CARET

public const string SetaPDF_Core_Document_Page_Annotation::TYPE_CARET = 'Caret'

Annotation type

TYPE_CIRCLE

public const string SetaPDF_Core_Document_Page_Annotation::TYPE_CIRCLE = 'Circle'

Annotation type

TYPE_FILE_ATTACHMENT

public const string SetaPDF_Core_Document_Page_Annotation::TYPE_FILE_ATTACHMENT = 'FileAttachment'

Annotation type

TYPE_FREE_TEXT

public const string SetaPDF_Core_Document_Page_Annotation::TYPE_FREE_TEXT = 'FreeText'

Annotation type

TYPE_HIGHLIGHT

public const string SetaPDF_Core_Document_Page_Annotation::TYPE_HIGHLIGHT = 'Highlight'

Annotation type

TYPE_INK

public const string SetaPDF_Core_Document_Page_Annotation::TYPE_INK = 'Ink'

Annotation type

TYPE_LINE

public const string SetaPDF_Core_Document_Page_Annotation::TYPE_LINE = 'Line'

Annotation type

TYPE_LINK

public const string SetaPDF_Core_Document_Page_Annotation::TYPE_LINK = 'Link'

Annotation type

TYPE_MOVIE

public const string SetaPDF_Core_Document_Page_Annotation::TYPE_MOVIE = 'Movie'

Annotation type

TYPE_POLYGON

public const string SetaPDF_Core_Document_Page_Annotation::TYPE_POLYGON = 'Polygon'

Annotation type

TYPE_POLY_LINE

public const string SetaPDF_Core_Document_Page_Annotation::TYPE_POLY_LINE = 'PolyLine'

Annotation type

TYPE_POPUP

public const string SetaPDF_Core_Document_Page_Annotation::TYPE_POPUP = 'Popup'

Annotation type

TYPE_PRINTER_MARK

public const string SetaPDF_Core_Document_Page_Annotation::TYPE_PRINTER_MARK = 'PrinterMark'

Annotation type

TYPE_REDACT

public const string SetaPDF_Core_Document_Page_Annotation::TYPE_REDACT = 'Redact'

Annotation type

TYPE_SCREEN

public const string SetaPDF_Core_Document_Page_Annotation::TYPE_SCREEN = 'Screen'

Annotation type

TYPE_SOUND

public const string SetaPDF_Core_Document_Page_Annotation::TYPE_SOUND = 'Sound'

Annotation type

TYPE_SQUARE

public const string SetaPDF_Core_Document_Page_Annotation::TYPE_SQUARE = 'Square'

Annotation type

TYPE_SQUIGGLY

public const string SetaPDF_Core_Document_Page_Annotation::TYPE_SQUIGGLY = 'Squiggly'

Annotation type

TYPE_STAMP

public const string SetaPDF_Core_Document_Page_Annotation::TYPE_STAMP = 'Stamp'

Annotation type

TYPE_STRIKE_OUT

public const string SetaPDF_Core_Document_Page_Annotation::TYPE_STRIKE_OUT = 'StrikeOut'

Annotation type

TYPE_TEXT

public const string SetaPDF_Core_Document_Page_Annotation::TYPE_TEXT = 'Text'

Annotation type

TYPE_TRAP_NET

public const string SetaPDF_Core_Document_Page_Annotation::TYPE_TRAP_NET = 'TrapNet'

Annotation type

TYPE_UNDERLINE

public const string SetaPDF_Core_Document_Page_Annotation::TYPE_UNDERLINE = 'Underline'

Annotation type

TYPE_WATERMARK

public const string SetaPDF_Core_Document_Page_Annotation::TYPE_WATERMARK = 'Watermark'

Annotation type

TYPE_WIDGET

public const string SetaPDF_Core_Document_Page_Annotation::TYPE_WIDGET = 'Widget'

Annotation type


Properties

$_additionalActions

protected SetaPDF_Core_Document_Page_Annotation_AdditionalActions SetaPDF_Core_Document_Page_Annotation::$_additionalActions

$_annotationDictionary

protected SetaPDF_Core_Type_Dictionary SetaPDF_Core_Document_Page_Annotation::$_annotationDictionary

The annotation dictionary

$_indirectReference

protected SetaPDF_Core_Type_IndirectObjectInterface SetaPDF_Core_Document_Page_Annotation::$_indirectReference

$_rect

protected SetaPDF_Core_DataStructure_Rectangle SetaPDF_Core_Document_Page_Annotation::$_rect

The rectangle


Static Methods

_createAnnotationDictionary()

protected static SetaPDF_Core_Document_Page_Annotation::_createAnnotationDictionary (
SetaPDF_Core_DataStructure_Rectangle|array $rect, string $subtype
): SetaPDF_Core_Type_Dictionary

Creates an annotation dictionary with default values.

Parameters
$rect : SetaPDF_Core_DataStructure_Rectangle|array
 
$subtype : string
 

byObjectOrDictionary()

public static SetaPDF_Core_Document_Page_Annotation::byObjectOrDictionary (): SetaPDF_Core_Document_Page_Annotation

Creates an annotation object by an annotation dictionary or its parent object.

Parameters
$objectOrDictionary : SetaPDF_Core_Type_Dictionary|SetaPDF_Core_Type_IndirectObjectInterface
 
Exceptions

Throws SetaPDF_Core_Type_Exception

Throws InvalidArgumentException


Methods

__construct()

public SetaPDF_Core_Document_Page_Annotation::__construct ()

The constructor.

Parameters
$objectOrDictionary : SetaPDF_Core_Type_Dictionary|SetaPDF_Core_Type_IndirectObject|SetaPDF_Core_Type_IndirectReference
 
Exceptions

Throws InvalidArgumentException

Throws SetaPDF_Core_Type_Exception

cleanUp()

public SetaPDF_Core_Document_Page_Annotation::cleanUp (
void
): void

Release memory/cycled references

getAdditionalActions()

public SetaPDF_Core_Document_Page_Annotation::getAdditionalActions (
void
): SetaPDF_Core_Document_Page_Annotation_AdditionalActions

Gets the additional actions object instance for this annotation.

getAnnotationDictionary()

WARNING: This method is marked as deprecated!

public SetaPDF_Core_Document_Page_Annotation::getAnnotationDictionary (
void
): SetaPDF_Core_Type_Dictionary

Get the annotation dictionary.

getAppearance()

public SetaPDF_Core_Document_Page_Annotation::getAppearance (
[ string $type = 'N' [, null|string $subName = null ]]
): null|SetaPDF_Core_XObject_Form

Get the annotation appearance stream.

Parameters
$type : string
 
$subName : null|string
 
Exceptions

Throws InvalidArgumentException

getColor()

public SetaPDF_Core_Document_Page_Annotation::getColor (
void
): null|SetaPDF_Core_DataStructure_Color

Get the color of the annotation.

getContents()

public SetaPDF_Core_Document_Page_Annotation::getContents (
[ string $encoding = 'UTF-8' ]
): null|string

Get the contents of the annotation.

Parameters
$encoding : string
 

getDictionary()

public SetaPDF_Core_Document_Page_Annotation::getDictionary (
void
): SetaPDF_Core_Type_Dictionary

Get the annotation dictionary.

getHeight()

public SetaPDF_Core_Document_Page_Annotation::getHeight (
void
): float|int

Get the height of the annotation.

Exceptions

Throws SetaPDF_Core_Type_Exception

getHiddenFlag()

public SetaPDF_Core_Document_Page_Annotation::getHiddenFlag (
void
): boolean

Checks for the "Hidden" flag.

PDF 32000-1:2008 - Table 165: "If set, do not display or print the annotation or allow it to interact with the user, regardless of its annotation type or whether an annotation handler is available."

getIndirectObject()

public SetaPDF_Core_Document_Page_Annotation::getIndirectObject (
[ SetaPDF_Core_Document $document = null ]
): SetaPDF_Core_Type_IndirectObjectInterface

Get the indirect object of this annotation.

Parameters
$document : SetaPDF_Core_Document
 

getInvisibleFlag()

public SetaPDF_Core_Document_Page_Annotation::getInvisibleFlag (
void
): boolean

Checks for the "Invisible" flag.

PDF 32000-1:2008 - Table 165: "If set, do not display the annotation if it does not belong to one of the standard annotation types and no annotation handler is available. If clear, display such an unknown annotation using an appearance stream specified by its appearance dictionary, if any"

getLockedContents()

public SetaPDF_Core_Document_Page_Annotation::getLockedContents (
void
): boolean

Checks for the "LockedContents" flag.

PDF 32000-1:2008 - Table 165: "If set, do not allow the contents of the annotation to be modified by the user. This flag does not restrict deletion of the annotation or changes to other annotation properties, such as position and size."

getLockedFlag()

public SetaPDF_Core_Document_Page_Annotation::getLockedFlag (
void
): boolean

Checks the "Locked" flag.

PDF 32000-1:2008 - Table 165: "If set, do not allow the annotation to be deleted or its properties (including position and size) to be modified by the user. However, this flag does not restrict changes to the annotation’s contents, such as the value of a form field."

getModificationDate()

public SetaPDF_Core_Document_Page_Annotation::getModificationDate (
[ bool $asString = true ]
): mixed|null|SetaPDF_Core_DataStructure_Date

Get the modification date.

Parameters
$asString : bool
 
Exceptions

Throws Exception

getName()

public SetaPDF_Core_Document_Page_Annotation::getName (
[ string $encoding = 'UTF-8' ]
): string|null

Get the name of the annotation.

Parameters
$encoding : string
 

getNoRotateFlag()

public SetaPDF_Core_Document_Page_Annotation::getNoRotateFlag (
void
): boolean

Checks fo the "NoRotate" flag.

PDF 32000-1:2008 - Table 165: "If set, do not rotate the annotation’s appearance to match the rotation of the page. The upper-left corner of the annotation rectangle shall remain in a fixed location on the page, regardless of the page rotation."

getNoViewFlag()

public SetaPDF_Core_Document_Page_Annotation::getNoViewFlag (
void
): boolean

Checks for the "NoView" flag.

PDF 32000-1:2008 - Table 165: "If set, do not display the annotation on the screen or allow it to interact with the user. The annotation may be printed (depending on the setting of the Print flag) but should be considered hidden for purposes of on-screen display and user interaction."

getNoZoomFlag()

public SetaPDF_Core_Document_Page_Annotation::getNoZoomFlag (
void
): boolean

Checks fo the "NoZoom" flag.

PDF 32000-1:2008 - Table 165: "If set, do not scale the annotation’s appearance to match the magnification of the page. The location of the annotation on the page (defined by the upper- left corner of its annotation rectangle) shall remain fixed, regardless of the page magnification."

getPrintFlag()

public SetaPDF_Core_Document_Page_Annotation::getPrintFlag (
void
): boolean

Checks for the "Print" flag.

PDF 32000-1:2008 - Table 165: "If set, print the annotation when the page is printed. If clear, never print the annotation, regardless of whether it is displayed on the screen."

getReadOnlyFlag()

public SetaPDF_Core_Document_Page_Annotation::getReadOnlyFlag (
void
): boolean

Checks the "ReadOnly" flag.

PDF 32000-1:2008 - Table 165: "If set, do not allow the annotation to interact with the user. The annotation may be displayed or printed (depending on the settings of the NoView and Print flags) but should not respond to mouse clicks or change its appearance in response to mouse motions.

This flag shall be ignored for widget annotations; its function is subsumed by the ReadOnly flag of the associated form field"

getRect()

public SetaPDF_Core_Document_Page_Annotation::getRect (
void
): SetaPDF_Core_DataStructure_Rectangle

Get the rectangle object of this annotation.

getToggleNoView()

public SetaPDF_Core_Document_Page_Annotation::getToggleNoView (
void
): boolean

Checks for the "ToggleNoView" flag.

PDF 32000-1:2008 - Table 165: "If set, invert the interpretation of the NoView flag for certain events."

getType()

public SetaPDF_Core_Document_Page_Annotation::getType (
void
): string

Get the annotation type specified in the Subtype entry.

getWidth()

public SetaPDF_Core_Document_Page_Annotation::getWidth (
void
): float|int

Get the width of the annotation.

Exceptions

Throws SetaPDF_Core_Type_Exception

isAnnotationFlagSet()

public SetaPDF_Core_Document_Page_Annotation::isAnnotationFlagSet (
integer $flag
): boolean

Checks if a specific annotation flag is set.

Parameters
$flag : integer
 

setAnnotationFlags()

public SetaPDF_Core_Document_Page_Annotation::setAnnotationFlags (
integer $flags [, boolean $set = true ]
): void

Sets an annotation flag.

Parameters
$flags : integer
 
$set : boolean

Set or unset

setAppearance()

public SetaPDF_Core_Document_Page_Annotation::setAppearance (
SetaPDF_Core_XObject_Form $xObject [, string $type = 'N' [, string|null $subState = null ]]
): void

Set the annotation appearance stream.

Parameters
$xObject : SetaPDF_Core_XObject_Form
 
$type : string
 
$subState : string|null
 

setColor()

public SetaPDF_Core_Document_Page_Annotation::setColor (
null|bool|int|float|string|array|SetaPDF_Core_DataStructure_Color $color
): void

Set the color of the annotation.

Parameters
$color : null|bool|int|float|string|array|SetaPDF_Core_DataStructure_Color
 

setContents()

public SetaPDF_Core_Document_Page_Annotation::setContents (
string|null $contents [, string $encoding = 'UTF-8' ]
): void

Set the contents of the annotation.

Parameters
$contents : string|null
 
$encoding : string
 

setHiddenFlag()

public SetaPDF_Core_Document_Page_Annotation::setHiddenFlag (
[ boolean $hidden = true ]
): void

Set the "Hidden" flag.

Parameters
$hidden : boolean
 
See

setInvisibleFlag()

public SetaPDF_Core_Document_Page_Annotation::setInvisibleFlag (
[ boolean $invisible = true ]
): void

Set the "Invisible" flag.

Parameters
$invisible : boolean
 
See

setLocked()

public SetaPDF_Core_Document_Page_Annotation::setLocked (
[ boolean $locked = true ]
): void

Set the "Locked" flag.

Parameters
$locked : boolean
 
See

setLockedContents()

public SetaPDF_Core_Document_Page_Annotation::setLockedContents (
[ boolean $lockedContents = true ]
): void

Set the "LockedContents" flag.

Parameters
$lockedContents : boolean
 
See

setModificationDate()

public SetaPDF_Core_Document_Page_Annotation::setModificationDate (
[ SetaPDF_Core_DataStructure_Date|DateTime|string|bool $date = true ]
): void

Set the modification date.

Parameters
$date : SetaPDF_Core_DataStructure_Date|DateTime|string|bool

If true is passed, the current date and time will be used.

Exceptions

Throws Exception

setName()

public SetaPDF_Core_Document_Page_Annotation::setName (
string|null $name [, string $encoding = 'UTF-8' ]
): void

Set the name of the annotation.

The annotation name, a text string uniquely identifying it among all the annotations on its page.

Parameters
$name : string|null
 
$encoding : string
 

setNoRotateFlag()

public SetaPDF_Core_Document_Page_Annotation::setNoRotateFlag (
[ boolean $noRotate = true ]
): void

Set the "NoRotate" flag.

Parameters
$noRotate : boolean
 
See

setNoViewFlag()

public SetaPDF_Core_Document_Page_Annotation::setNoViewFlag (
[ boolean $noView = true ]
): void

Set the "NoView" flag.

Parameters
$noView : boolean
 
See

setNoZoomFlag()

public SetaPDF_Core_Document_Page_Annotation::setNoZoomFlag (
[ boolean $noZoom = true ]
): void

Set the "NoZoom" flag.

Parameters
$noZoom : boolean
 
See

setPrintFlag()

public SetaPDF_Core_Document_Page_Annotation::setPrintFlag (
[ boolean $print = true ]
): void

Set the "Print" flag.

Parameters
$print : boolean
 
See

setReadOnlyFlag()

public SetaPDF_Core_Document_Page_Annotation::setReadOnlyFlag (
[ boolean $readOnly = true ]
): void

Set the "ReadOnly" flag.

Parameters
$readOnly : boolean
 
See

setRect()

public SetaPDF_Core_Document_Page_Annotation::setRect (): void

Set the rectangle object.

Parameters
$rect : SetaPDF_Core_DataStructure_Rectangle
 

setToggleNoView()

public SetaPDF_Core_Document_Page_Annotation::setToggleNoView (
[ boolean $toggleNoView = true ]
): void

Set the "ToggleNoView" flag.

Parameters
$toggleNoView : boolean
 
See

unsetAnnotationFlags()

public SetaPDF_Core_Document_Page_Annotation::unsetAnnotationFlags (
integer $flags
): void

Removes a field flag.

Parameters
$flags : integer
 

© 2024 Setasign GmbH & Co. KG · Contact / Imprint · Data Privacy Statement (German)