SetaPDF v2 API Reference

): \SetaPDF_Core_Document_Page_Annotation

Creates an annotation dictionary with default values.

Parameters

$rect : \SetaPDF_Core_DataStructure_Rectangle|array
$subtype : string

byObjectOrDictionary()

public static Annotation::byObjectOrDictionary (

\SetaPDF_Core_Type_Dictionary|\SetaPDF_Core_Type_IndirectObjectInterface $objectOrDictionary

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

Parameters

$objectOrDictionary : \SetaPDF_Core_Type_Dictionary|\SetaPDF_Core_Type_IndirectObjectInterface

Exceptions

createAnnotationDictionary()

public static FreeTextAnnotation::createAnnotationDictionary (

Creates an annotation dictionary.

Parameters

$rect : \SetaPDF_Core_DataStructure_Rectangle|array
$fontName : string: The font name, which is registered in the AcroForm DR dictionary.
$fontSize : int|float: The font size
$color : int|float|string|array|\SetaPDF_Core_Type_Array|\SetaPDF_Core_DataStructure_Color: See \setasign\SetaPDF2\Core\DataStructure\Color\AbstractColor::createByComponents() for more details.

Exceptions

Methods

__construct()

public FreeTextAnnotation::__construct (

array|\SetaPDF_Core_Type_AbstractType|\SetaPDF_Core_Type_Dictionary|\SetaPDF_Core_Type_IndirectObjectInterface $objectOrDictionary

)

The constructor.

If the parameter cannot be resolved as a dictionary all parameters were passed to the self::createAnnotationDictionary() method.

Parameters

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

Exceptions

_getReplies()

private MarkupAnnotation::_getReplies (

\SetaPDF_Core_Document_Page_Annotations $annotations,
bool $onlyCheckForExistance

): array|bool

Get all replies or checks for their existance.

Parameters

$annotations : \SetaPDF_Core_Document_Page_Annotations
$onlyCheckForExistance : bool

Exceptions

): \SetaPDF_Core_Document_Page_Annotation_Popup

addReply()

public MarkupAnnotation::addReply (

\SetaPDF_Core_Document_Page_Annotation_Markup $annotation

): void

Adds a reply to this annotation.

Parameters

$annotation : \SetaPDF_Core_Document_Page_Annotation_Markup

cleanUp()

public FreeTextAnnotation::cleanUp (

void

): void

Release cycled references.

createPopup()

public MarkupAnnotation::createPopup (

int|float $offsetX = 30,
int|float $offsetY = 20,
int|float $width = 150,
int|float $height = 100

Create a popup annotation object for this annotation.

If the x-offset value is less than zero the popup will be created at the left side of the main annotation. Otherwise on the right side. If the y-offset value is less than zero the popup will be create down below the main annotation. Otherwise above.

You need to re-add this new popup annotation to its origin annotation by passing it to the addPopup() method after assigning it to the page object.

Parameters

$offsetX : int|float
$offsetY : int|float
$width : int|float
$height : int|float

Exceptions

): \SetaPDF_Core_Document_Page_Annotation_AdditionalActions

getAdditionalActions()

public Annotation::getAdditionalActions (

void

Gets the additional actions object instance for this annotation.

getAlign()

public FreeTextAnnotation::getAlign (

void

): mixed|string

Get the form of quadding (justification / align) that shall be used in displaying the annotation’s text.

Exceptions

getAnnotationDictionary()

WARNING: This method is marked as deprecated!

public Annotation::getAnnotationDictionary (

void

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

): ?\SetaPDF_Core_Document_Page_Annotation_BorderEffect

getBorderEffect()

public FreeTextAnnotation::getBorderEffect (

bool $create = false

Get the border effect object.

Parameters

$create : bool

getBorderStyle()

public FreeTextAnnotation::getBorderStyle (

void

): \SetaPDF_Core_Document_Page_Annotation_BorderStyle

Get the border style object.

getCalloutLine()

public FreeTextAnnotation::getCalloutLine (

void

): ?array

Get the array of four or six numbers specifying a callout line attached to the free text annotation.

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

getCreationDate()

public MarkupAnnotation::getCreationDate (

bool $asString = true

): null|mixed|\SetaPDF_Core_DataStructure_Date

Get the creation date.

The date and time when the annotation was created.

Parameters

$asString : bool: Whether receive the value as a string (PDF date string) or as a \setasign\SetaPDF2\Core\DataStructure\Date instance.

Exceptions

Throws \Exception

See

PDF 32000-1:2008 - 12.5.6.2 - Table 170
MarkupAnnotation::setCreationDate()

getDictionary()

public Annotation::getDictionary (

void

): ?\SetaPDF_Core_DataStructure_Rectangle

Get the annotation dictionary.

getDifferencesRect()

public FreeTextAnnotation::getDifferencesRect (

void

Get the rectangle describing the difference between the Rect entry and the inner text rectangle.

getHeight()

public Annotation::getHeight (

void

): float|int

Get the height of the annotation.

Exceptions

): ?\SetaPDF_Core_Document_Page_Annotation

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."

getInReplyTo()

public MarkupAnnotation::getInReplyTo (

void

Get the in reply to annotation (if available).

Exceptions

): \SetaPDF_Core_Type_IndirectObjectInterface

See

MarkupAnnotation::setInReplyTo()
PDF 32000-1:2008 - 12.5.6.2 - Table 170

getIndirectObject()

public Annotation::getIndirectObject (

?\SetaPDF_Core_Document $document = null

Get the indirect object of this annotation.

Parameters

$document : ?\SetaPDF_Core_Document

getIntent()

public FreeTextAnnotation::getIntent (

void

): string

Get the name describing the intent of the free text annotation.

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"

getLineEndingStyle()

public FreeTextAnnotation::getLineEndingStyle (

void

): string

Get the line ending style.

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."

getOpacity()

public MarkupAnnotation::getOpacity (

void

): float|mixed

Get the constant opacity value.

getPopup()

public MarkupAnnotation::getPopup (

void

): ?\SetaPDF_Core_Document_Page_Annotation_Popup

Get the associated popup object if available.

Exceptions

): \SetaPDF_Core_DataStructure_Rectangle

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

Get the rectangle object of this annotation.

getReplies()

public MarkupAnnotation::getReplies (

\SetaPDF_Core_Document_Page_Annotations $annotations

): array

Get all annotations which refer this annotation as an reply.

Parameters

$annotations : \SetaPDF_Core_Document_Page_Annotations

Exceptions

getSubject()

public MarkupAnnotation::getSubject (

string $encoding = 'UTF-8'

): ?string

Get the subject.

Text representing a short description of the subject being addressed by the annotation.

Parameters

$encoding : string

See

MarkupAnnotation::setSubject()
PDF 32000-1:2008 - 12.5.6.2 - Table 170

getTextLabel()

public MarkupAnnotation::getTextLabel (

string $encoding = 'UTF-8'

): ?string

Get the text label.

The text label that shall be displayed in the title bar of the annotation’s pop-up window when open and active. This entry shall identify the user who added the annotation.

Parameters

$encoding : string

See

MarkupAnnotation::setTextLabel()
PDF 32000-1:2008 - 12.5.6.2 - Table 170

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 Annotation::getWidth (

void

): float|int

Get the width of the annotation.

Exceptions

hasReplies()

public MarkupAnnotation::hasReplies (

\SetaPDF_Core_Document_Page_Annotations $annotations

): bool

Check whether this annotation has a reply or not.

Parameters

$annotations : \SetaPDF_Core_Document_Page_Annotations

Exceptions