SetaPDF_Core_Document_Page_Annotation_Polygon Class representing a polygon annotation
File: /SetaPDF v2/Core/Document/Page/Annotation/Polygon.php
See PDF 32000-1:2008 - 12.5.6.13
Class hierarchy
Summary
Methods
- __construct()
- _getReplies()
- addReply()
- cleanUp()
- createPopup()
- getAdditionalActions()
- getAnnotationDictionary()
- getAppearance()
- getBorderEffect()
- getBorderStyle()
- getColor()
- getContents()
- getCreationDate()
- getDictionary()
- getHeight()
- getHiddenFlag()
- getInReplyTo()
- getIndirectObject()
- getInteriorColor()
- getInvisibleFlag()
- getLockedContents()
- getLockedFlag()
- getModificationDate()
- getName()
- getNoRotateFlag()
- getNoViewFlag()
- getNoZoomFlag()
- getOpacity()
- getPopup()
- getPrintFlag()
- getReadOnlyFlag()
- getRect()
- getReplies()
- getSubject()
- getTextLabel()
- getToggleNoView()
- getType()
- getVertices()
- getWidth()
- hasReplies()
- isAnnotationFlagSet()
- isReplyTo()
- setAnnotationFlags()
- setAppearance()
- setColor()
- setContents()
- setCreationDate()
- setHiddenFlag()
- setInReplyTo()
- setIndirectObject()
- setInteriorColor()
- setInvisibleFlag()
- setLocked()
- setLockedContents()
- setModificationDate()
- setName()
- setNoRotateFlag()
- setNoViewFlag()
- setNoZoomFlag()
- setOpacity()
- setPopup()
- setPrintFlag()
- setReadOnlyFlag()
- setRect()
- setSubject()
- setTextLabel()
- setToggleNoView()
- setVertices()
- unsetAnnotationFlags()
Constants
- TYPE_3D
- TYPE_CARET
- TYPE_CIRCLE
- TYPE_FILE_ATTACHMENT
- TYPE_FREE_TEXT
- TYPE_HIGHLIGHT
- TYPE_INK
- TYPE_LINE
- TYPE_LINK
- TYPE_MOVIE
- TYPE_POLYGON
- TYPE_POLY_LINE
- TYPE_POPUP
- TYPE_PRINTER_MARK
- TYPE_REDACT
- TYPE_SCREEN
- TYPE_SOUND
- TYPE_SQUARE
- TYPE_SQUIGGLY
- TYPE_STAMP
- TYPE_STRIKE_OUT
- TYPE_TEXT
- TYPE_TRAP_NET
- TYPE_UNDERLINE
- TYPE_WATERMARK
- TYPE_WIDGET
Constants
TYPE_3D
Annotation type
TYPE_CARET
Annotation type
TYPE_CIRCLE
Annotation type
TYPE_FILE_ATTACHMENT
Annotation type
TYPE_FREE_TEXT
Annotation type
TYPE_HIGHLIGHT
Annotation type
TYPE_INK
Annotation type
TYPE_LINE
Annotation type
TYPE_LINK
Annotation type
TYPE_MOVIE
Annotation type
TYPE_POLYGON
Annotation type
TYPE_POLY_LINE
Annotation type
TYPE_POPUP
Annotation type
TYPE_PRINTER_MARK
Annotation type
TYPE_REDACT
Annotation type
TYPE_SCREEN
Annotation type
TYPE_SOUND
Annotation type
TYPE_SQUARE
Annotation type
TYPE_SQUIGGLY
Annotation type
TYPE_STAMP
Annotation type
TYPE_STRIKE_OUT
Annotation type
TYPE_TEXT
Annotation type
TYPE_TRAP_NET
Annotation type
TYPE_UNDERLINE
Annotation type
TYPE_WATERMARK
Annotation type
TYPE_WIDGET
Annotation type
Properties
$_annotationDictionary
The annotation dictionary
Static Methods
_createAnnotationDictionary()
Creates an annotation dictionary with default values.
Parameters
- $rect
- $subtype
byObjectOrDictionary()
Creates an annotation object by an annotation dictionary or its parent object.
Parameters
- $objectOrDictionary : SetaPDF_Core_Type_AbstractType
Exceptions
Throws InvalidArgumentException
createAnnotationDictionary()
Methods
__construct()
_getReplies()
Get all replies or checks for their existance.
Parameters
- $annotations : SetaPDF_Core_Document_Page_Annotations
- $onlyCheckForExistance
addReply()
Adds a reply to this annotation.
Parameters
- $annotation : SetaPDF_Core_Document_Page_Annotation_Markup
createPopup()
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
- $offsetY
- $width
- $height
getAppearance()
Get the annotation appearance stream.
Parameters
- $type
- $subName
Exceptions
Throws InvalidArgumentException
getCreationDate()
Get the creation date.
The date and time when the annotation was created.Parameters
- $asString
Whether receive the value as a string (PDF date string) or as a SetaPDF_Core_DataStructure_Date instance.
See
- SetaPDF_Core_Document_Page_Annotation_Markup::setCreationDate()
- PDF 32000-1:2008 - 12.5.6.2 - Table 170
getHiddenFlag()
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()
Get the in reply to annotation (if available).
See
- SetaPDF_Core_Document_Page_Annotation_Markup::setInReplyTo()
- PDF 32000-1:2008 - 12.5.6.2 - Table 170
getIndirectObject()
Get the indirect object of this annotation.
Parameters
- $document : SetaPDF_Core_Document|null
getInvisibleFlag()
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()
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()
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."
getNoRotateFlag()
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()
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()
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()
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()
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"
getReplies()
Get all annotations which refer this annotation as an reply.
Parameters
- $annotations : SetaPDF_Core_Document_Page_Annotations
getSubject()
Get the subject.
Text representing a short description of the subject being addressed by the annotation.Parameters
- $encoding
See
- SetaPDF_Core_Document_Page_Annotation_Markup::setSubject()
- PDF 32000-1:2008 - 12.5.6.2 - Table 170
getTextLabel()
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
See
- SetaPDF_Core_Document_Page_Annotation_Markup::setTextLabel()
- PDF 32000-1:2008 - 12.5.6.2 - Table 170
getToggleNoView()
Checks for the "ToggleNoView" flag.
PDF 32000-1:2008 - Table 165: "If set, invert the interpretation of the NoView flag for certain events."
hasReplies()
Check whether this annotation has a reply or not.
Parameters
- $annotations : SetaPDF_Core_Document_Page_Annotations
setAppearance()
Set the annotation appearance stream.
Parameters
- $xObject : SetaPDF_Core_XObject_Form
- $type
- $subState
setContents()
Set the contents of the annotation.
Parameters
- $contents
- $encoding
setCreationDate()
Set the creation date.
Parameters
- $date
See
- PDF 32000-1:2008 - 12.5.6.2 - Table 170
- SetaPDF_Core_Document_Page_Annotation_Markup::getCreationDate()
setInReplyTo()
Set the in reply to annotation object.
Parameters
- $annotation : SetaPDF_Core_Document_Page_Annotation_Markup
Exceptions
Throws InvalidArgumentException
See
- SetaPDF_Core_Document_Page_Annotation_Markup::getInReplyTo()
- PDF 32000-1:2008 - 12.5.6.2 - Table 170
setIndirectObject()
Set the indirect object of this annotation.
Parameters
- $indirectReference : SetaPDF_Core_Type_IndirectObjectInterface
setLockedContents()
Set the "LockedContents" flag.
Parameters
- $lockedContents
See
setModificationDate()
Set the modification date.
Parameters
- $date
If true is passed, the current date and time will be used.
setName()
Set the name of the annotation.
The annotation name, a text string uniquely identifying it among all the annotations on its page.
Parameters
- $name
- $encoding
setPopup()
Set the pop-up annotation object.
Parameters
- $annotation : SetaPDF_Core_Document_Page_Annotation_Popup
Exceptions
Throws InvalidArgumentException
setRect()
setSubject()
Get the subject.
Parameters
- $subject
- $encoding
See
- SetaPDF_Core_Document_Page_Annotation_Markup::getSubject()
- PDF 32000-1:2008 - 12.5.6.2 - Table 170
setTextLabel()
Set the text label.
Parameters
- $textLabel
- $encoding
See
- SetaPDF_Core_Document_Page_Annotation_Markup::getTextLabel()
- PDF 32000-1:2008 - 12.5.6.2 - Table 170