Package com.ironsoftware.ironpdf.internal.staticapi

Class Annotation_Api

java.lang.Object

com.ironsoftware.ironpdf.internal.staticapi.Annotation_Api

public final class Annotation_Api
extends Object

The type Annotation api.

Constructor Summary

Constructors

Constructor	Description
Annotation_Api()

Method Summary

Modifier and Type	Method	Description
static void	addTextAnnotation(InternalPdfDocument internalPdfDocument, TextAnnotation textAnnotation)	Adds an annotation to a page of this InternalPdfDocument
static void	addTextAnnotation(InternalPdfDocument internalPdfDocument, TextAnnotation textAnnotation, int pageIndex, int x, int y)	Adds an annotation to a page of this InternalPdfDocument
static void	addTextAnnotation(InternalPdfDocument internalPdfDocument, TextAnnotation textAnnotation, int pageIndex, int x, int y, int width)	Adds an annotation to a page of this InternalPdfDocument
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
static List<TextAnnotation>	getAnnotaionList(InternalPdfDocument internalPdfDocument)
static int	getAnnotationCount(InternalPdfDocument internalPdfDocument, int pageIndex)	Retrieve the number of annotations contained on the specified page

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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.

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.

addTextAnnotation

public static void addTextAnnotation(InternalPdfDocument internalPdfDocument,
                                     TextAnnotation textAnnotation)

Adds an annotation to a page of this InternalPdfDocument

Parameters:

internalPdfDocument - the internal pdf document

textAnnotation - The annotation as a TextAnnotation object.

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

getAnnotaionList

public static List<TextAnnotation> getAnnotaionList(InternalPdfDocument internalPdfDocument)