Class Annotation_Api


  • public final class Annotation_Api
    extends Object
    The type Annotation api.
    • Constructor Detail

      • Annotation_Api

        public Annotation_Api()
    • Method Detail

      • addTextAnnotation

        public static void addTextAnnotation​(InternalPdfDocument internalPdfDocument,
                                             TextAnnotation textAnnotation,
                                             int pageIndex,
                                             int x,
                                             int y,
                                             int width)
        Adds an annotation to a page of this InternalPdfDocument
        Parameters:
        internalPdfDocument - the internal pdf document
        textAnnotation - The annotation as a TextAnnotation object.
        pageIndex - Index of the page to add the annotation. The first page has a PageIndex of 0
        x - The horizontal X position of the annotation on your page in pixels
        y - The vertical Y position of the annotation on your page in pixels. Measured from bottom upwards.
        width - The width of your annotation's icon and interactive area in pixels
      • addTextAnnotation

        public static void addTextAnnotation​(InternalPdfDocument internalPdfDocument,
                                             TextAnnotation textAnnotation,
                                             int pageIndex,
                                             int x,
                                             int y,
                                             int width,
                                             int height)
        Adds an annotation to a page of this InternalPdfDocument
        Parameters:
        internalPdfDocument - the internal pdf document
        textAnnotation - The annotation as a TextAnnotation object.
        pageIndex - Index of the page to add the annotation. The first page has a PageIndex of 0
        x - The horizontal X position of the annotation on your page in pixels
        y - The vertical Y position of the annotation on your page in pixels. Measured from bottom upwards.
        width - The width of your annotation's icon and interactive area in pixels
        height - The height of your annotation's icon and interactive area in pixels
      • addTextAnnotation

        public static void addTextAnnotation​(InternalPdfDocument internalPdfDocument,
                                             TextAnnotation textAnnotation,
                                             int pageIndex,
                                             int x,
                                             int y)
        Adds an annotation to a page of this InternalPdfDocument
        Parameters:
        internalPdfDocument - the internal pdf document
        textAnnotation - The annotation as a TextAnnotation object.
        pageIndex - Index of the page to add the annotation. The first page has a PageIndex of 0
        x - The horizontal X position of the annotation on your page in pixels
        y - The vertical Y position of the annotation on your page in pixels. Measured from bottom upwards.
      • getAnnotationCount

        public static int getAnnotationCount​(InternalPdfDocument internalPdfDocument,
                                             int pageIndex)
        Retrieve the number of annotations contained on the specified page
        Parameters:
        internalPdfDocument - the internal pdf document
        pageIndex - Page index
        Returns:
        Number of annotations contained on the page