- Getting Started
- Memory Usage
- Readers and Writers
- The Document Class
- Page Layout and Mode
- Viewer Preferences
- Document Outline
- Page Labels
- Embedded File Streams
- Colors and Color Spaces
- Page Formats and Boundaries
- Standard and Public Key Encryption
- Fonts and Encodings
- Corrupted Documents
- Reader Enabled Documents
- Refactor Old SetaPDF Code
- API Reference
Markup Annotation Class
Many annotation types are defined as markup annotations because they are used primarily to mark up PDF documents. You may know these annotation types as entries in the comments pane in your PDF reader. To manage these annotation types the SetaPDF-Core component offers the SetaPDF_Core_Document_Page_Annotation_Markup class.
Following annotations are markup annotations:
- Free text annotations (no Popup)
- Sound (no Popup)
All annotations which are not explicit linked (high level implementation available) are still available through an instance of the SetaPDF_Core_Document_Page_Annotation_Markup class.
The class implements getter and setter methods to access markup specific annotation data:
Adds a reply to this annotation.
Create a popup annotation object for this annotation.
Get the creation date.
Get the in reply to annotation (if available).
Get the associated popup object if available.
Get all annotations which refer this annotation as an reply.
Get the subject.
Get the text label.
Check whether this annotation has a reply or not.
Checks if this annotation is a reply to another annotation.
Set the creation date.
Set the in reply to annotation object.
Set the pop-up annotation object.
Get the subject.
Set the text label.
As you may have noticed, by the available method names, it is possible to create a kind of comment structure for these annotation types. Following a demo, that dumps the comments outline from this document: