Index

  1. Installation
  2. Getting Started
  3. Memory Usage
  4. Readers and Writers
  5. The Document Class
  6. Metadata
  7. Pages
  8. Canvas
  9. Page Layout and Mode
  10. Viewer Preferences
  11. Document Outline
  12. Page Labels
  13. Actions
  14. Destinations
  15. Annotations
    1. Introduction
    2. The Annotations Helper
    3. Annotation Class
      1. Introduction
      2. Methods
    4. Markup Annotation Class
    5. Text Annotation Class
    6. Link Annotation Class
    7. Square and Circle Annotation Classes
    8. Text Markup Annotation Classes
    9. Rubber Stamp Annotation Class
    10. Widget Annotation Class
    11. File Attachment Annotation Class
  16. Embedded File Streams
  17. Colors and Color Spaces
  18. Page Formats and Boundaries
  19. Standard and Public Key Encryption
  20. Fonts and Encodings
  21. Corrupted Documents
  22. Reader Enabled Documents
  23. Refactor Old SetaPDF Code
  24. API Reference

Annotation Class The base annotation class extended by all available annotation implementations

Table of Contents

  1. Introduction
    1. Methods

      Introduction

      All annotation classes will extend the SetaPDF_Core_Document_Page_Annotation class. 

      Methods

      This basis class offers several getter and setter methods allowing you to access all common annotation data:

      getAdditionalActions()

      Gets the additional actions object instance for this annotation.

      getAppearance()

      Get the annotation appearance stream.

      getColor()

      Get the color of the annotation.

      getContents()

      Get the contents of the annotation.

      getDictionary()

      Get the annotation dictionary.

      getHeight()

      Get the height of the annotation.

      getHiddenFlag()

      Checks for the "Hidden" flag.

      getInvisibleFlag()

      Checks for the "Invisible" flag.

      getLockedContents()

      Checks for the "LockedContents" flag.

      getLockedFlag()

      Checks the "Locked" flag.

      getModificationDate()

      Get the modification date.

      getName()

      Get the name of the annotation.

      getNoRotateFlag()

      Checks fo the "NoRotate" flag.

      getNoViewFlag()

      Checks for the "NoView" flag.

      getNoZoomFlag()

      Checks fo the "NoZoom" flag.

      getPrintFlag()

      Checks for the "Print" flag.

      getReadOnlyFlag()

      Checks the "ReadOnly" flag.

      getRect()

      Get the rectangle object of this annotation.

      getToggleNoView()

      Checks for the "ToggleNoView" flag.

      getWidth()

      Get the width of the annotation.

      setAppearance()

      Set the annotation appearance stream.

      setColor()

      Set the color of the annotation.

      setContents()

      Set the contents of the annotation.

      setHiddenFlag()

      Set the "Hidden" flag.

      setInvisibleFlag()

      Set the "Invisible" flag.

      setLocked()

      Set the "Locked" flag.

      setLockedContents()

      Set the "LockedContents" flag.

      setModificationDate()

      Set the modification date.

      setName()

      Set the name of the annotation.

      setNoRotateFlag()

      Set the "NoRotate" flag.

      setNoViewFlag()

      Set the "NoView" flag.

      setNoZoomFlag()

      Set the "NoZoom" flag.

      setPrintFlag()

      Set the "Print" flag.

      setReadOnlyFlag()

      Set the "ReadOnly" flag.

      setRect()

      Set the rectangle object.

      setToggleNoView()

      Set the "ToggleNoView" flag.

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