Add highlight annotation

On this page

Highlight annotation highlights and comments selected text as shown in the picture below:

You can use the following methods to set the properties of the HighlightAnnotation class:

To add a highlight annotation, follow these steps:

  1. Instantiate the Annotator class. Specify the input document path or stream.
  2. Instantiate HighlightAnnotation class. Specify the appropriate properties (position, page number, etc).
  3. Call the add() method. Specify the HighlightAnnotation class.
  4. Call the save() method. Specify the output document path or stream.

The following code snippet shows how to add HighlightAnnotation to the document:

// This example demonstrates adding text highlight annotation.

// Create an instance of Annotator class
Annotator annotator = new Annotator("inputPath");
try {
    // Create an instance of Reply class and add comments
    Reply reply1 = new Reply();
    reply1.setComment("First comment");
    reply1.setRepliedOn(Calendar.getInstance().getTime());

    Reply reply2 = new Reply();
    reply2.setComment("Second comment");
    reply2.setRepliedOn(Calendar.getInstance().getTime());

    java.util.List<Reply> replies =  new ArrayList<Reply>();
    replies.add(reply1);
    replies.add(reply2);

    Point point1 = new Point(80, 730);
    Point point2 = new Point(240, 730);
    Point point3 = new Point(80, 650);
    Point point4 = new Point(240, 650);

    List<Point> points = new ArrayList<Point>();
    points.add(point1);
    points.add(point2);
    points.add(point3);
    points.add(point4);

    // Create an instance of HighlightAnnotation class and set options
    HighlightAnnotation highlight = new HighlightAnnotation();
    highlight.setBackgroundColor(65535);
    highlight.setCreatedOn(Calendar.getInstance().getTime());
    highlight.setFontColor(0);
    highlight.setMessage("This is highlight annotation");
    highlight.setOpacity(0.5);
    highlight.setPageNumber(0);
    highlight.setPoints(points);
    highlight.setReplies(replies);
    
    // Add annotation and save to file
    annotator.add(highlight);
    annotator.save("outputPath");
} finally {
    if (annotator != null) {
        annotator.dispose();
    }
}

On this page