iText - Textanmerkung

In diesem Kapitel erfahren Sie, wie Sie einem PDF-Dokument mithilfe der iText-Bibliothek Textanmerkungen hinzufügen.

Erstellen einer Textanmerkung in einer PDF

Sie können ein leeres PDF-Dokument erstellen, indem Sie das instanziieren DocumentKlasse. Während Sie diese Klasse instanziieren, müssen Sie a bestehenPdfDocument Objekt als Parameter für seinen Konstruktor.

Um Textanmerkungen in Ihrem PDF-Dokument zu verwenden, müssen Sie ein Objekt von erstellen PdfTextAnnotation Klasse und fügen Sie dies der PdfPage.

Im Folgenden finden Sie die Schritte zum Verwenden von Textanmerkungen im PDF-Dokument.

Schritt 1: Erstellen eines PdfWriter-Objekts

Das PdfWriterKlasse repräsentiert den DocWriter für ein PDF. Diese Klasse gehört zum Paketcom.itextpdf.kernel.pdf. Der Konstruktor dieser Klasse akzeptiert eine Zeichenfolge, die den Pfad der Datei darstellt, in der die PDF erstellt werden soll.

Instanziieren Sie die PdfWriter-Klasse, indem Sie einen Zeichenfolgenwert (der den Pfad darstellt, in dem Sie eine PDF-Datei erstellen müssen) an ihren Konstruktor übergeben (siehe Abbildung unten).

// Creating a PdfWriter 
String dest = "C:/itextExamples/textAnnotation.pdf"; 
PdfWriter writer = new PdfWriter(dest);

Wenn ein Objekt dieses Typs an ein PdfDocument (Klasse) übergeben wird, wird jedes zu diesem Dokument hinzugefügte Element in die angegebene Datei geschrieben.

Schritt 2: Erstellen eines PdfDocument-Objekts

Das PdfDocumentKlasse ist die Klasse, die das PDF-Dokument in iText darstellt. Diese Klasse gehört zum Paketcom.itextpdf.kernel.pdf. Um diese Klasse zu instanziieren (im Schreibmodus), müssen Sie ein Objekt der Klasse übergebenPdfWriter zu seinem Konstruktor.

Instanziieren Sie die PdfDocument Klasse durch das Bestehen der PdfWriter Objekt zu seinem Konstruktor, wie unten gezeigt.

// Creating a PdfDocument  
PdfDocument pdfDoc = new PdfDocument(writer);

Sobald ein PdfDocument-Objekt erstellt wurde, können Sie verschiedene Elemente wie Seite, Schriftart, Dateianhang und Ereignishandler mit den entsprechenden Methoden seiner Klasse hinzufügen.

Schritt 3: Erstellen des Dokumentobjekts

Das Document Klasse des Pakets com.itextpdf.layoutist das Stammelement beim Erstellen einer autarken PDF-Datei. Einer der Konstruktoren dieser Klasse akzeptiert ein Objekt der KlassePdfDocument.

Instanziieren Sie die Document Klasse durch Übergeben des Objekts der Klasse PdfDocument in den vorherigen Schritten erstellt, wie unten gezeigt.

// Creating a Document   
Document document = new Document(pdfDoc);

Schritt 4: Erstellen eines PdfAnnotation-Objekts

Das PdfAnnotation Klasse des Pakets com.itextpdf.kernel.pdf.annot repräsentiert die Oberklasse aller Anmerkungen.

Unter seinen abgeleiteten Klassen, PdfTextAnnotationKlasse repräsentiert die Textanmerkung. Erstellen Sie ein Objekt dieser Klasse wie unten gezeigt.

// Creating PdfAnnotation 
Rectangle rect = new Rectangle(20, 800, 0, 0); 
PdfAnnotation ann = new PdfTextAnnotation(rect);

Schritt 5: Festlegen der Farbe der Anmerkung

Stellen Sie die Farbe mit der Taste auf die Anmerkung ein setColor() Methode der PdfAnnotationKlasse. Übergeben Sie an diese Methode diecolor Objekt, das die Farbe der Anmerkung als Parameter darstellt.

// Setting color to the annotation 
ann.setColor(Color.GREEN);

Schritt 6: Festlegen des Titels und des Inhalts der Anmerkung

Stellen Sie den Titel und den Inhalt der Anmerkung mit der Taste ein setTitle() und setContents() Methoden der PdfAnnotation Klasse jeweils wie unten gezeigt.

// Setting title to the annotation 
ann.setTitle(new PdfString("Hello"));        

// Setting contents of the annotation 
ann.setContents("Hi welcome to Tutorialspoint.");

Schritt 7: Hinzufügen der Anmerkung zu einer Seite

Erstelle eine neue PdfPage Klasse mit der addNewPage() Methode der PdfDocument-Klasse und fügen Sie die obige Annotation mit der hinzu addAnnotation() Methode von PdfPage Klasse, wie unten gezeigt.

// Creating a new page PdfPage page = 
pdf.addNewPage();        

// Adding annotation to a page in a PDF 
page.addAnnotation(ann);

Schritt 8: Schließen des Dokuments

Schließen Sie das Dokument mit der close() Methode der Document Klasse, wie unten gezeigt.

// Closing the document 
document.close();

Beispiel

Das folgende Java-Programm zeigt, wie Sie mithilfe der iText-Bibliothek Textanmerkungen zu einem PDF-Dokument hinzufügen. Es wird ein PDF-Dokument mit dem Namen erstellttextAnnotation.pdf, fügt eine Textanmerkung hinzu und speichert sie im Pfad C:/itextExamples/

Speichern Sie diesen Code in einer Datei mit dem Namen TextAnnotation.java.

import com.itextpdf.kernel.color.Color; 
import com.itextpdf.kernel.geom.Rectangle; 
import com.itextpdf.kernel.pdf.PdfDocument;
import com.itextpdf.kernel.pdf.PdfPage; 
import com.itextpdf.kernel.pdf.PdfString; 
import com.itextpdf.kernel.pdf.PdfWriter; 
import com.itextpdf.kernel.pdf.annot.PdfAnnotation; 
import com.itextpdf.kernel.pdf.annot.PdfTextAnnotation; 
import com.itextpdf.layout.Document;  

public class TextAnnotation {    
   public static void main(String args[]) throws Exception {        
      // Creating a PdfWriter       
      String dest = "C:/itextExamples/textAnnotation.pdf";       
      PdfWriter writer = new PdfWriter(dest);               
      
      // Creating a PdfDocument       
      PdfDocument pdf = new PdfDocument(writer);               
      
      // Creating a Document        
      Document document = new Document(pdf);             
      
      // Creating PdfTextAnnotation object
      Rectangle rect = new Rectangle(20, 800, 0, 0);       
      PdfAnnotation ann = new PdfTextAnnotation(rect);              
      
      // Setting color to the annotation
      ann.setColor(Color.GREEN);              
      
      // Setting title to the annotation 
      ann.setTitle(new PdfString("Hello"));              
      
      // Setting contents of the annotation       
      ann.setContents("Hi welcome to Tutorialspoint.");              
      
      // Creating a new page       
      PdfPage page =  pdf.addNewPage();              
      
      // Adding annotation to a page in a PDF
      page.addAnnotation(ann);

      // Closing the document       
      document.close();       
      
      System.out.println("Annotation added successfully");    
   } 
}

Kompilieren Sie die gespeicherte Java-Datei und führen Sie sie mit den folgenden Befehlen an der Eingabeaufforderung aus.

javac TextAnnotation.java 
java TextAnnotation

Bei der Ausführung erstellt das obige Programm ein PDF-Dokument mit der folgenden Meldung.

Annotation added successfully

Wenn Sie den angegebenen Pfad überprüfen, finden Sie das erstellte PDF-Dokument wie unten gezeigt.