Skip to main content

Search Text and Add Hyperlink on Top of the Text in PDF in Java


This article demonstrates how to search particular text in a PDF document and add link annotations on top of the text occurrences found in Java. The following example uses Free Spire.PDF for Java library.


Dependencies


First of all, you need to add needed dependencies for including Free Spire.PDF for Java into your Java project. There are two ways to do that.


If you use maven, you need to add the following code to your project’s pom.xml file.

<repositories> 

        <repository> 

            <id>com.e-iceblue</id> 

            <name>e-iceblue</name> 

            <url>http://repo.e-iceblue.com/nexus/content/groups/public/</url> 

        </repository> 

</repositories> 

<dependencies> 

    <dependency> 

        <groupId>e-iceblue</groupId> 

        <artifactId>spire.pdf.free</artifactId> 

        <version>2.6.3</version> 

    </dependency> 

</dependencies> 

For non-maven projects, download the latest Free Spire.PDF for Java pack from this website and add Spire.PDF.jar in the lib folder into your project as a dependency.


Example Code

import com.spire.pdf.PdfDocument;
import com.spire.pdf.PdfPageBase;
import com.spire.pdf.annotations.PdfAnnotationBorder;
import com.spire.pdf.annotations.PdfUriAnnotation;
import com.spire.pdf.general.find.PdfTextFind;
import com.spire.pdf.graphics.PdfRGBColor;

public class AddHyperlinkToParticularText {
    public static void main(String[] args) throws Exception {
        //Load the sample PDF document
        PdfDocument pdf = new PdfDocument();
        pdf.loadFromFile("example.pdf");

        PdfTextFind[] result;
        //Loop through all pages in the PDF document
        for (PdfPageBase page : (Iterable<PdfPageBase>) pdf.getPages()) {
            //Search for the text "website"
            result = page.findText("website").getFinds();

            //Add link annotations to the top of the text occurrences found
            for (PdfTextFind find : result) {
                //Create a PdfUriAnnotation
                PdfUriAnnotation uri = new PdfUriAnnotation(find.getBounds());
                //Set link address
                uri.setUri("https://en.wikipedia.org/wiki/Hyperlink");
                //Set border of the annotation
                uri.setBorder(new PdfAnnotationBorder(1f));
                uri.setColor(new PdfRGBColor(0,0,255));
                //Add the annotation to page
                page.getAnnotationsWidget().add(uri);
            }
        }

        //Save the result document
        pdf.saveToFile("out.pdf");
    }
}

The following screenshot shows the output PDF document after adding link annotation to particular text:




Labels:

Comments

Post a Comment

Popular posts from this blog

3 Ways to Generate Word Documents from Templates in Java

A template is a document with pre-applied formatting like styles, tabs, line spacing and so on. You can quickly generate a batch of documents with the same structure based on the template. In this article, I am going to show you the different ways to generate Word documents from templates programmatically in Java using Free Spire.Doc for Java library. Prerequisite First of all, you need to add needed dependencies for including Free Spire.Doc for Java into your Java project. There are two ways to do that. If you use maven, you need to add the following code to your project’s pom.xml file. <repositories>               <repository>                   <id>com.e-iceblue</id>                   <name>e-iceblue</name>...
Post a Comment
Read more

Simple Java Code to Convert Excel to PDF in Java

This article demonstrates a simple solution to convert an Excel file to PDF in Java by using free Excel API – Free Spire.XLS for Java . The following examples illustrate two possibilities to convert Excel to PDF:      Convert the whole Excel file to PDF     Convert a particular Excel Worksheet to PDF Before start with coding, you need to Download Free Spire.XLS for Java package , unzip it and import Spire.Xls.jar file from the lib folder in your project as a denpendency. 1. Convert the whole Excel file to PDF Spire.XLS for Java provides saveToFile method in Workbook class that enables us to easily save a whole Excel file to PDF. import com.spire.xls.FileFormat; import com.spire.xls.Workbook; public class ExcelToPDF {     public static void main(String[] args){         //Create a Workbook         Workbook workbook = new Workbook();   ...
Post a Comment
Read more

Insert and Extract OLE objects in Word in Java

You can use OLE (Object Linking and Embedding) to include content from other programs, such as another Word document, an Excel or PowerPoint document to an existing Word document. This article demonstrates how to insert and extract embedded OLE objects in a Word document in Java by using Free Spire.Doc for Java API.   Add dependencies First of all, you need to add needed dependencies for including Free Spire.Doc for Java into your Java project. There are two ways to do that. If you use maven, you need to add the following code to your project’s pom.xml file.     <repositories>               <repository>                   <id>com.e-iceblue</id>                   <name>e-iceblue</name>    ...
Post a Comment
Read more