Class SetaPDF_Core_Document_Page_Annotation_FreeText in SetaPDF v2 API Reference

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

Throws SetaPDF_Core_Type_Exception

getAdditionalActions()

public SetaPDF_Core_Document_Page_Annotation::getAdditionalActions (

void

): SetaPDF_Core_Document_Page_Annotation_AdditionalActions

Gets the additional actions object instance for this annotation.

getAlign()

public SetaPDF_Core_Document_Page_Annotation_FreeText::getAlign (

void

): mixed|string

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

Exceptions

Throws SetaPDF_Core_Type_Exception

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

getBorderEffect()

public SetaPDF_Core_Document_Page_Annotation_FreeText::getBorderEffect (

[ bool $create = false ]

): null|SetaPDF_Core_Document_Page_Annotation_BorderEffect

Get the border effect object.

Parameters

$create : bool

getBorderStyle()

public SetaPDF_Core_Document_Page_Annotation_FreeText::getBorderStyle (

void

): SetaPDF_Core_Document_Page_Annotation_BorderStyle

Get the border style object.

getCalloutLine()

public SetaPDF_Core_Document_Page_Annotation_FreeText::getCalloutLine (

void

): array|null

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

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

getCreationDate()

public SetaPDF_Core_Document_Page_Annotation_Markup::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 SetaPDF_Core_DataStructure_Date instance.

Exceptions

Throws Exception

See

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

getDictionary()

public SetaPDF_Core_Document_Page_Annotation::getDictionary (

void

): SetaPDF_Core_Type_Dictionary

Get the annotation dictionary.

getDifferencesRect()

public SetaPDF_Core_Document_Page_Annotation_FreeText::getDifferencesRect (

void

): null|SetaPDF_Core_DataStructure_Rectangle

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

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

getInReplyTo()

public SetaPDF_Core_Document_Page_Annotation_Markup::getInReplyTo (

void

): null|SetaPDF_Core_Document_Page_Annotation

Get the in reply to annotation (if available).

Exceptions

Throws SetaPDF_Core_Type_Exception

See

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

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

getIntent()

public SetaPDF_Core_Document_Page_Annotation_FreeText::getIntent (

void

): string

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

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"

getLineEndingStyle()

public SetaPDF_Core_Document_Page_Annotation_FreeText::getLineEndingStyle (

void

): string

Get the line ending style.

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

getOpacity()

public SetaPDF_Core_Document_Page_Annotation_Markup::getOpacity (

void

): float|mixed

Get the constant opacity value.

getPopup()

public SetaPDF_Core_Document_Page_Annotation_Markup::getPopup (

void

): null|SetaPDF_Core_Document_Page_Annotation_Popup

Get the associated popup object if available.

Exceptions

Throws SetaPDF_Core_Type_Exception

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.

getReplies()

public SetaPDF_Core_Document_Page_Annotation_Markup::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

Throws SetaPDF_Core_Type_Exception

getSubject()

public SetaPDF_Core_Document_Page_Annotation_Markup::getSubject (

[ string $encoding = 'UTF-8' ]

): null|string

Get the subject.

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

Parameters

$encoding : string

See

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

getTextLabel()

public SetaPDF_Core_Document_Page_Annotation_Markup::getTextLabel (

[ string $encoding = 'UTF-8' ]

): null|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

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

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

hasReplies()

public SetaPDF_Core_Document_Page_Annotation_Markup::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

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

isReplyTo()

public SetaPDF_Core_Document_Page_Annotation_Markup::isReplyTo (

void

): bool

Checks if this annotation is a reply to another annotation.

setAlign()

public SetaPDF_Core_Document_Page_Annotation_FreeText::setAlign (

string $align

): void

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

Parameters

$align : string

See

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

setCalloutLine()

public SetaPDF_Core_Document_Page_Annotation_FreeText::setCalloutLine (

): void

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

copy

Parameters

$x1OrPoints : array<int|float>|false
$y1 : null|int|float
$x2 : null|int|float
$y2 : null|int|float
$x3 : null|int|float
$y3 : null|int|float

setColor()

public SetaPDF_Core_Document_Page_Annotation::setColor (

): 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

setCreationDate()

public SetaPDF_Core_Document_Page_Annotation_Markup::setCreationDate (

): void

Set the creation date.

Parameters

$date : null|bool|string|DateTime|SetaPDF_Core_Type_String|SetaPDF_Core_DataStructure_Date

Exceptions

Throws Exception

See

PDF 32000-1:2008 - 12.5.6.2 - Table 170
SetaPDF_Core_Document_Page_Annotation_Markup::getCreationDate()

setDifferencesRect()

public SetaPDF_Core_Document_Page_Annotation_FreeText::setDifferencesRect (

SetaPDF_Core_DataStructure_Rectangle $differencesRect

): void

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

PDF 32000-1:2008 - Table 174

The four numbers correspond to the differences in default user space between the left, top, right, and bottom coordinates of Rect and those of the inner rectangle, respectively. Each value shall be greater than or equal to 0. The sum of the top and bottom differences shall be less than the height of Rect, and the sum of the left and right differences shall be less than the width of Rect.