Index

  1. \setasign\SetaPDF2
    1. Core
      1. Document
      2. Document
        1. Page
        2. Page
          1. Annotation
            1. AdditionalActions
            2. Annotation
            3. AppearanceCharacteristics
            4. BorderEffect
            5. BorderStyle
            6. CaretAnnotation
            7. CircleAnnotation
            8. FileAttachmentAnnotation
            9. Flags
            10. FreeTextAnnotation
            11. HighlightAnnotation
            12. InkAnnotation
            13. LineAnnotation
            14. LineEndingStyle
            15. LinkAnnotation
            16. MarkupAnnotation
            17. PolyLineAnnotation
            18. PolygonAnnotation
            19. PopupAnnotation
            20. QuadPointsTrait
            21. ScreenAnnotation
            22. SquareAnnotation
            23. SquigglyAnnotation
            24. StampAnnotation
            25. StrikeOutAnnotation
            26. TextAnnotation
            27. TextMarkupAnnotation
            28. UnderlineAnnotation
            29. Widget
            30. WidgetAnnotation

setasign\SetaPDF2\Core\Document\Page\Annotation

WidgetAnnotation Class representing a widget annotation

File: /SetaPDF v2/Core/Document/Page/Annotation/WidgetAnnotation.php
Old class name (alias): \SetaPDF_Core_Document_Page_Annotation_Widget

See PDF 32000-1:2008 - 12.5.6.19

Class hierarchy

Summary

Static Methods

Methods

Properties

Constants

Constants

TYPE_3D

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

Annotation type

TYPE_CARET

public const string Annotation::TYPE_CARET = 'Caret'

Annotation type

TYPE_CIRCLE

public const string Annotation::TYPE_CIRCLE = 'Circle'

Annotation type

TYPE_FILE_ATTACHMENT

public const string Annotation::TYPE_FILE_ATTACHMENT = 'FileAttachment'

Annotation type

TYPE_FREE_TEXT

public const string Annotation::TYPE_FREE_TEXT = 'FreeText'

Annotation type

TYPE_HIGHLIGHT

public const string Annotation::TYPE_HIGHLIGHT = 'Highlight'

Annotation type

TYPE_INK

public const string Annotation::TYPE_INK = 'Ink'

Annotation type

TYPE_LINE

public const string Annotation::TYPE_LINE = 'Line'

Annotation type

TYPE_LINK

public const string Annotation::TYPE_LINK = 'Link'

Annotation type

TYPE_MOVIE

public const string Annotation::TYPE_MOVIE = 'Movie'

Annotation type

TYPE_POLYGON

public const string Annotation::TYPE_POLYGON = 'Polygon'

Annotation type

TYPE_POLY_LINE

public const string Annotation::TYPE_POLY_LINE = 'PolyLine'

Annotation type

TYPE_POPUP

public const string Annotation::TYPE_POPUP = 'Popup'

Annotation type

TYPE_PRINTER_MARK

public const string Annotation::TYPE_PRINTER_MARK = 'PrinterMark'

Annotation type

TYPE_REDACT

public const string Annotation::TYPE_REDACT = 'Redact'

Annotation type

TYPE_SCREEN

public const string Annotation::TYPE_SCREEN = 'Screen'

Annotation type

TYPE_SOUND

public const string Annotation::TYPE_SOUND = 'Sound'

Annotation type

TYPE_SQUARE

public const string Annotation::TYPE_SQUARE = 'Square'

Annotation type

TYPE_SQUIGGLY

public const string Annotation::TYPE_SQUIGGLY = 'Squiggly'

Annotation type

TYPE_STAMP

public const string Annotation::TYPE_STAMP = 'Stamp'

Annotation type

TYPE_STRIKE_OUT

public const string Annotation::TYPE_STRIKE_OUT = 'StrikeOut'

Annotation type

TYPE_TEXT

public const string Annotation::TYPE_TEXT = 'Text'

Annotation type

TYPE_TRAP_NET

public const string Annotation::TYPE_TRAP_NET = 'TrapNet'

Annotation type

TYPE_UNDERLINE

public const string Annotation::TYPE_UNDERLINE = 'Underline'

Annotation type

TYPE_WATERMARK

public const string Annotation::TYPE_WATERMARK = 'Watermark'

Annotation type

TYPE_WIDGET

public const string Annotation::TYPE_WIDGET = 'Widget'

Annotation type


Properties

$_additionalActions

protected \SetaPDF_Core_Document_Page_Annotation_AdditionalActions Annotation::$_additionalActions

$_annotationDictionary

protected \SetaPDF_Core_Type_Dictionary Annotation::$_annotationDictionary

The annotation dictionary

$_borderStyle

protected \SetaPDF_Core_Document_Page_Annotation_BorderStyle WidgetAnnotation::$_borderStyle

$_indirectReference

protected \SetaPDF_Core_Type_IndirectObjectInterface Annotation::$_indirectReference

$_rect

protected \SetaPDF_Core_DataStructure_Rectangle Annotation::$_rect

The rectangle


Static Methods

_createAnnotationDictionary()

protected static 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 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 \setasign\SetaPDF2\Core\Type\Exception

Throws \InvalidArgumentException

createAnnotationDictionary()

public static WidgetAnnotation::createAnnotationDictionary (): \SetaPDF_Core_Type_Dictionary

Creates a widget annotation dictionary.

Parameters
$rect : \SetaPDF_Core_DataStructure_Rectangle|array
 
Exceptions

Throws \InvalidArgumentException


Methods

__construct()

public WidgetAnnotation::__construct ()

The constructor.

A widget annotation instance can be created by an existing dictionary, indirect object/reference or by passing the same parameter as for createAnnotationDictionary().

Parameters
$objectOrDictionary : array|\SetaPDF_Core_Type_AbstractType|\SetaPDF_Core_Type_Dictionary|\SetaPDF_Core_Type_IndirectObjectInterface
 
Exceptions

Throws \InvalidArgumentException

Throws \setasign\SetaPDF2\Core\Type\Exception

cleanUp()

public WidgetAnnotation::cleanUp (
void
): void

Release memory/cycled references.

getAction()

public WidgetAnnotation::getAction (
void
): bool|\SetaPDF_Core_Document_Action

Get the action of the annotation.

If no action is defined false will be returned.

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

getAdditionalActions()

public WidgetAnnotation::getAdditionalActions (
void
): \SetaPDF_Core_Document_Page_Annotation_Widget_AdditionalActions

Gets the additional actions object instance for this annotation.

getAnnotationDictionary()

WARNING: This method is marked as deprecated!

public Annotation::getAnnotationDictionary (
void
): \SetaPDF_Core_Type_Dictionary

Get the annotation dictionary.

getAppearance()

public Annotation::getAppearance (
string $type = 'N',
?string $subName = null
): ?\SetaPDF_Core_XObject_Form

Get the annotation appearance stream.

Parameters
$type : string
 
$subName : ?string
 
Exceptions

Throws \InvalidArgumentException

getAppearanceCharacteristics()

public WidgetAnnotation::getAppearanceCharacteristics (
bool $create = false
): ?\SetaPDF_Core_Document_Page_Annotation_AppearanceCharacteristics

Get the appearance characteristics object.

Parameters
$create : bool
 
Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

getBorderStyle()

public WidgetAnnotation::getBorderStyle (
void
): \SetaPDF_Core_Document_Page_Annotation_BorderStyle

Get the border style object.

getColor()

public Annotation::getColor (
void
): ?\SetaPDF_Core_DataStructure_Color

Get the color of the annotation.

getContents()

public Annotation::getContents (
string $encoding = 'UTF-8'
): ?string

Get the contents of the annotation.

Parameters
$encoding : string
 

getDictionary()

public Annotation::getDictionary (
void
): \SetaPDF_Core_Type_Dictionary

Get the annotation dictionary.

getHeight()

public WidgetAnnotation::getHeight (
bool $ignoreRotation = false
): float|int

Get the height of the annotation.

If the annotation is rotated width and height will be changed accordingly. This can be affected by the $ignoreRotation parameter.

Parameters
$ignoreRotation : bool
 
Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

getHiddenFlag()

public Annotation::getHiddenFlag (
void
): bool

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 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 Annotation::getInvisibleFlag (
void
): bool

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 Annotation::getLockedContents (
void
): bool

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 Annotation::getLockedFlag (
void
): bool

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 Annotation::getModificationDate (
bool $asString = true
): mixed|null|\SetaPDF_Core_DataStructure_Date

Get the modification date.

Parameters
$asString : bool
 
Exceptions

Throws \Exception

getName()

public Annotation::getName (
string $encoding = 'UTF-8'
): ?string

Get the name of the annotation.

Parameters
$encoding : string
 

getNoRotateFlag()

public Annotation::getNoRotateFlag (
void
): bool

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 Annotation::getNoViewFlag (
void
): bool

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 Annotation::getNoZoomFlag (
void
): bool

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 Annotation::getPrintFlag (
void
): bool

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 Annotation::getReadOnlyFlag (
void
): bool

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 Annotation::getRect (
void
): \SetaPDF_Core_DataStructure_Rectangle

Get the rectangle object of this annotation.

getToggleNoView()

public Annotation::getToggleNoView (
void
): bool

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 Annotation::getType (
void
): string

Get the annotation type specified in the Subtype entry.

getWidth()

public WidgetAnnotation::getWidth (
bool $ignoreRotation = false
): float|int

Get the width of the annotation.

If the annotation is rotated width and height will be changed accordingly. This can be affected by the $ignoreRotation parameter.

Parameters
$ignoreRotation : bool
 
Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

isAnnotationFlagSet()

public Annotation::isAnnotationFlagSet (
int $flag
): bool

Checks if a specific annotation flag is set.

Parameters
$flag : int
 

setAction()

public WidgetAnnotation::setAction (): void

Set the action of the annotation.

The action could be an instance of \setasign\SetaPDF2\Core\Document\Action\Action or a plain dictionary representing the action.

Parameters
$action : \SetaPDF_Core_Document_Action|\SetaPDF_Core_Type_Dictionary
 
Exceptions

Throws \InvalidArgumentException

setAnnotationFlags()

public Annotation::setAnnotationFlags (
int $flags,
bool $set = true
): void

Sets an annotation flag.

Parameters
$flags : int
 
$set : bool

Set or unset

setAppearance()

public Annotation::setAppearance (
\SetaPDF_Core_XObject_Form $xObject,
string $type = 'N',
?string $subState = null
): void

Set the annotation appearance stream.

Parameters
$xObject : \SetaPDF_Core_XObject_Form
 
$type : string
 
$subState : ?string
 

setColor()

public 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 Annotation::setContents (
?string $contents,
string $encoding = 'UTF-8'
): void

Set the contents of the annotation.

Parameters
$contents : ?string
 
$encoding : string
 

setHiddenFlag()

public Annotation::setHiddenFlag (
bool $hidden = true
): void

Set the "Hidden" flag.

Parameters
$hidden : bool
 
See

setInvisibleFlag()

public Annotation::setInvisibleFlag (
bool $invisible = true
): void

Set the "Invisible" flag.

Parameters
$invisible : bool
 
See

setLocked()

public Annotation::setLocked (
bool $locked = true
): void

Set the "Locked" flag.

Parameters
$locked : bool
 
See

setLockedContents()

public Annotation::setLockedContents (
bool $lockedContents = true
): void

Set the "LockedContents" flag.

Parameters
$lockedContents : bool
 
See

setModificationDate()

public 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 Annotation::setName (
?string $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
 
$encoding : string
 

setNoRotateFlag()

public Annotation::setNoRotateFlag (
bool $noRotate = true
): void

Set the "NoRotate" flag.

Parameters
$noRotate : bool
 
See

setNoViewFlag()

public Annotation::setNoViewFlag (
bool $noView = true
): void

Set the "NoView" flag.

Parameters
$noView : bool
 
See

setNoZoomFlag()

public Annotation::setNoZoomFlag (
bool $noZoom = true
): void

Set the "NoZoom" flag.

Parameters
$noZoom : bool
 
See

setPrintFlag()

public Annotation::setPrintFlag (
bool $print = true
): void

Set the "Print" flag.

Parameters
$print : bool
 
See

setReadOnlyFlag()

public Annotation::setReadOnlyFlag (
bool $readOnly = true
): void

Set the "ReadOnly" flag.

Parameters
$readOnly : bool
 
See

setRect()

public Annotation::setRect (): void

Set the rectangle object.

Parameters
$rect : \SetaPDF_Core_DataStructure_Rectangle
 

setToggleNoView()

public Annotation::setToggleNoView (
bool $toggleNoView = true
): void

Set the "ToggleNoView" flag.

Parameters
$toggleNoView : bool
 
See

unsetAnnotationFlags()

public Annotation::unsetAnnotationFlags (
int $flags
): void

Removes a field flag.

Parameters
$flags : int
 

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