Hinzufügen von PDF-Lesezeichen und Gliederung in Java

Was brauche ich, bevor ich anfange?

Bestätigen Sie vor der Implementierung von PDF-Lesezeichen, dass IronPDF in Ihrem Java-Projekt konfiguriert ist. Die Bibliothek erfordert Java 8 oder höher und integriert sich über Maven oder Gradle. Fügen Sie die IronPDF-Abhängigkeit zu Ihrer Projekt-Build-Datei hinzu. Für detaillierte Einrichtungshinweise beziehen Sie sich auf die Erste-Schritte-Übersicht.

Ein gültiger Lizenzschlüssel ist für die Entwicklung und den Einsatz in der Produktion erforderlich. Setzen Sie den Lizenzschlüssel zu Beginn Ihrer Anwendung, bevor Sie IronPDF-Methoden aufrufen. Für Informationen zu Lizenzierungsoptionen besuchen Sie den Lizenzierungsleitfaden.

Wie füge ich Gliederung und Lesezeichen zu einem PDF hinzu?

Die unten stehenden Beispiele verwenden dieses Beispiel-PDF, um die Erstellung von Gliederungen und Lesezeichen zu demonstrieren. Der Prozess umfasst das Laden eines vorhandenen PDF-Dokuments und die Verwendung von IronPDF's BookmarkManager, um Navigationselemente im gesamten Dokument hinzuzufügen.

//:path=/static-assets/ironpdf-java/content-code-examples/how-to/bookmarks/single-layer.java
import java.io.IOException;
import java.nio.file.Path;
import com.ironsoftware.ironpdf.License;
import com.ironsoftware.ironpdf.PdfDocument;
import com.ironsoftware.ironpdf.bookmark.BookmarkManager;

public class Main {
    public static void main(String[] args) throws IOException {
        // Set the license key for IronPDF
        License.setLicenseKey("IRONPDF-MYLICENSE-KEY-1EF01");

        // Load the PDF file
        PdfDocument pdf = PdfDocument.fromFile(Path.of("NovelSample.pdf"));

        // Get BookmarkManager object to manage bookmarks
        BookmarkManager bookmarks = pdf.getBookmark();

        // Add bookmarks at the end of the bookmark collection
        bookmarks.addBookMarkAtEnd("Title Page", 0);
        bookmarks.addBookMarkAtEnd("Table of Contents", 1);
        bookmarks.addBookMarkAtEnd("Dedication Page", 2);
        bookmarks.addBookMarkAtEnd("First Page", 3);
        bookmarks.addBookMarkAtStart("Page 4", 6);

        // Save the modified PDF with bookmarks
        pdf.saveAs(Path.of("bookmarked.pdf"));
    }
}

//:path=/static-assets/ironpdf-java/content-code-examples/how-to/bookmarks/single-layer.java
import java.io.IOException;
import java.nio.file.Path;
import com.ironsoftware.ironpdf.License;
import com.ironsoftware.ironpdf.PdfDocument;
import com.ironsoftware.ironpdf.bookmark.BookmarkManager;

public class Main {
    public static void main(String[] args) throws IOException {
        // Set the license key for IronPDF
        License.setLicenseKey("IRONPDF-MYLICENSE-KEY-1EF01");

        // Load the PDF file
        PdfDocument pdf = PdfDocument.fromFile(Path.of("NovelSample.pdf"));

        // Get BookmarkManager object to manage bookmarks
        BookmarkManager bookmarks = pdf.getBookmark();

        // Add bookmarks at the end of the bookmark collection
        bookmarks.addBookMarkAtEnd("Title Page", 0);
        bookmarks.addBookMarkAtEnd("Table of Contents", 1);
        bookmarks.addBookMarkAtEnd("Dedication Page", 2);
        bookmarks.addBookMarkAtEnd("First Page", 3);
        bookmarks.addBookMarkAtStart("Page 4", 6);

        // Save the modified PDF with bookmarks
        pdf.saveAs(Path.of("bookmarked.pdf"));
    }
}

Wie kann ich mehrere Ebenen von Lesezeichen erstellen?

Verschachtelte Lesezeichen sind die richtige Wahl für technische Dokumentationen, Forschungsberichte oder jedes Mehrkapitel-Dokument, bei dem Leser nicht nur zu Kapiteln, sondern auch zu Unterabschnitten innerhalb dieser Kapitel navigieren müssen. Beginnen Sie mit den gleichen flachen Lesezeichen, die im vorherigen Abschnitt erstellt wurden, und verwenden Sie dann insertBookmark, um Einträge auf neuen Ebenen hinzuzufügen.

Die Methode insertBookmark akzeptiert vier Parameter: den Lesezeichennamen, den Zielseiteindex, den übergeordneten Lesezeichennamen und den vorhergehenden Geschwister-Lesezeichennamen. Das Übergeben eines übergeordneten Lesezeichennamens erstellt einen untergeordneten Eintrag, der darunter geschachtelt ist. Wenn Sie den Geschwister-Parameter auf null setzen, wird der neue Eintrag als erstes Kind dieses Elternteils platziert.

//:path=/static-assets/ironpdf-java/content-code-examples/how-to/bookmarks/multi-layer.java
import java.io.IOException;
import java.nio.file.Path;
import com.ironsoftware.ironpdf.License;
import com.ironsoftware.ironpdf.PdfDocument;
import com.ironsoftware.ironpdf.bookmark.BookmarkManager;

public class Main {
    public static void main(String[] args) throws IOException {
        // Set the license key
        License.setLicenseKey("IRONPDF-MYLICENSE-KEY-1EF01");

        // Load the PDF file
        PdfDocument pdf = PdfDocument.fromFile(Path.of("NovelSample.pdf"));

        // Get BookmarkManager object
        BookmarkManager bookmarks = pdf.getBookmark();

        // Add top-level bookmarks at the end
        bookmarks.addBookMarkAtEnd("Title Page", 0);
        bookmarks.addBookMarkAtEnd("Table of Contents", 1);
        bookmarks.addBookMarkAtEnd("Dedication", 2);

        // Insert second-layer bookmarks as children of existing entries
        bookmarks.insertBookmark("First Page", 3, "Table of Contents", null);
        bookmarks.insertBookmark("Second Page", 4, "Table of Contents", "First Page");
        bookmarks.insertBookmark("End of Sample", 7, "Title Page", null);
        bookmarks.insertBookmark("Fourth page", 6, "Table of Contents", "Second Page");

        // Save the modified PDF with nested bookmarks
        pdf.saveAs(Path.of("multiLayer.pdf"));
    }
}

//:path=/static-assets/ironpdf-java/content-code-examples/how-to/bookmarks/multi-layer.java
import java.io.IOException;
import java.nio.file.Path;
import com.ironsoftware.ironpdf.License;
import com.ironsoftware.ironpdf.PdfDocument;
import com.ironsoftware.ironpdf.bookmark.BookmarkManager;

public class Main {
    public static void main(String[] args) throws IOException {
        // Set the license key
        License.setLicenseKey("IRONPDF-MYLICENSE-KEY-1EF01");

        // Load the PDF file
        PdfDocument pdf = PdfDocument.fromFile(Path.of("NovelSample.pdf"));

        // Get BookmarkManager object
        BookmarkManager bookmarks = pdf.getBookmark();

        // Add top-level bookmarks at the end
        bookmarks.addBookMarkAtEnd("Title Page", 0);
        bookmarks.addBookMarkAtEnd("Table of Contents", 1);
        bookmarks.addBookMarkAtEnd("Dedication", 2);

        // Insert second-layer bookmarks as children of existing entries
        bookmarks.insertBookmark("First Page", 3, "Table of Contents", null);
        bookmarks.insertBookmark("Second Page", 4, "Table of Contents", "First Page");
        bookmarks.insertBookmark("End of Sample", 7, "Title Page", null);
        bookmarks.insertBookmark("Fourth page", 6, "Table of Contents", "Second Page");

        // Save the modified PDF with nested bookmarks
        pdf.saveAs(Path.of("multiLayer.pdf"));
    }
}

JAVA

Das oben angezeigte PDF zeigt die Baumstruktur der von insertBookmark erstellten Lesezeichen. Erweitern Sie das Gliederungspanel, um zu überprüfen, wie sich jeder untergeordnete Eintrag unter seinem Elterneintrag schachtelt. Dieser geschichtete Ansatz eignet sich für Berichte mit Kapiteln, Unterkapiteln und Anhängen.

---

Meine Lieblingsbibliothek dieser Art ist IronPDF. Es ermöglicht eine schnelle und effiziente Bearbeitung von PDF-Dateien. Es verfügt auch über viele wertvolle Funktionen, wie das Exportieren in das PDF/A-Format und das digitale Signieren von PDF-Dokumenten.

Milan Jovanovic

Microsoft MVP

Fallstudie ansehen

IronOCR bedeutet, dass wir jährlich 40.000 $ durch manuelle Verarbeitung einsparen können, während die Produktivität gesteigert wird und Ressourcen für wichtige Aufgaben freigesetzt werden. Ich würde es sehr empfehlen.

Brent Matzelle

Technischer Leiter, OPYN

Fallstudie ansehen

Die Iron Suite spielt eine entscheidende Rolle in unseren Operationen. Diese Werkzeuge erhöhen die Effizienz im gesamten Unternehmen, einschließlich der Erstellung von Grundrissen und der Verbesserung des Bestandsmanagements.

David Jones

Leitender Software-Ingenieur, Agorus Build

Fallstudie ansehen

Wie kann ich vorhandene Lesezeichen aus einer PDF-Datei wiederherstellen?

Das Lesen von Lesezeichendaten aus einem PDF ist eine Voraussetzung, wenn Sie Dokumente aktualisieren möchten, ohne die gesamte Navigationsstruktur neu zu erstellen. IronPDF macht dies über das gleiche BookmarkManager-Interface zugänglich, das zum Hinzufügen von Lesezeichen verwendet wird. Laden Sie das PDF mit PdfDocument.fromFile(), greifen Sie auf das BookmarkManager zu und rufen Sie dann getBookmarks() auf, um alle obersten Lesezeichen abzurufen.

Verwenden Sie get(index), um über seine Position in der Liste auf ein bestimmtes Lesezeichen zuzugreifen. Die Methode getText() gibt das Anzeigeetikett des Lesezeichens zurück, während getPageIndex() die nullbasierte Seitennummer zurückgibt, auf die es abzielt. Untergeordnete Lesezeichen sind in der von getBookmarks() zurückgegebenen flachen Liste nicht enthalten; greifen Sie über die getChildren()-Methode jedes übergeordneten Lesezeichens auf sie zu.

//:path=/static-assets/ironpdf-java/content-code-examples/how-to/bookmarks/retrieve-bookmarks.java
import java.io.IOException;
import java.nio.file.Path;
import java.util.List;
import com.ironsoftware.ironpdf.License;
import com.ironsoftware.ironpdf.PdfDocument;
import com.ironsoftware.ironpdf.bookmark.Bookmark;
import com.ironsoftware.ironpdf.bookmark.BookmarkManager;

public class Main {
    public static void main(String[] args) throws IOException {
        // Set the license key
        License.setLicenseKey("IRONPDF-MYLICENSE-KEY-1EF01");

        // Load the PDF file with bookmarks
        PdfDocument pdf = PdfDocument.fromFile(Path.of("bookmarked.pdf"));

        // Retrieve the bookmark manager
        BookmarkManager bookmarks = pdf.getBookmark();

        // Retrieve list of all bookmarks (includes child bookmarks)
        List<Bookmark> bookmarkList = bookmarks.getBookmarks();

        // Access a specific bookmark by zero-based index
        Bookmark bookmark = bookmarkList.get(2);

        // Print bookmark details
        System.out.println("Bookmark Title: " + bookmark.getText());
        System.out.println("Page Number: " + bookmark.getPageIndex());

        // Check if bookmark has children
        if (bookmark.getChildren() != null && !bookmark.getChildren().isEmpty()) {
            System.out.println("Number of child bookmarks: " + bookmark.getChildren().size());
        }
    }
}

//:path=/static-assets/ironpdf-java/content-code-examples/how-to/bookmarks/retrieve-bookmarks.java
import java.io.IOException;
import java.nio.file.Path;
import java.util.List;
import com.ironsoftware.ironpdf.License;
import com.ironsoftware.ironpdf.PdfDocument;
import com.ironsoftware.ironpdf.bookmark.Bookmark;
import com.ironsoftware.ironpdf.bookmark.BookmarkManager;

public class Main {
    public static void main(String[] args) throws IOException {
        // Set the license key
        License.setLicenseKey("IRONPDF-MYLICENSE-KEY-1EF01");

        // Load the PDF file with bookmarks
        PdfDocument pdf = PdfDocument.fromFile(Path.of("bookmarked.pdf"));

        // Retrieve the bookmark manager
        BookmarkManager bookmarks = pdf.getBookmark();

        // Retrieve list of all bookmarks (includes child bookmarks)
        List<Bookmark> bookmarkList = bookmarks.getBookmarks();

        // Access a specific bookmark by zero-based index
        Bookmark bookmark = bookmarkList.get(2);

        // Print bookmark details
        System.out.println("Bookmark Title: " + bookmark.getText());
        System.out.println("Page Number: " + bookmark.getPageIndex());

        // Check if bookmark has children
        if (bookmark.getChildren() != null && !bookmark.getChildren().isEmpty()) {
            System.out.println("Number of child bookmarks: " + bookmark.getChildren().size());
        }
    }
}

Dieses Abrufmuster ist nützlich, wenn Sie die Navigationsstruktur eines vorhandenen PDFs vor der Verteilung prüfen oder ein Tool erstellen möchten, das prüfen muss, ob erforderliche Abschnitte vor der Veröffentlichung korrekt mit Lesezeichen versehen sind.

Wie kann ich ein Lesezeichen in einen bestimmten Index einfügen?

Das Einfügen von Lesezeichen an einer bestimmten Stelle ermöglicht es Ihnen, vorhandene PDFs schrittweise zu aktualisieren und neue Abschnitte hinzuzufügen, ohne die gesamte Gliederung von Grund auf neu aufzubauen. Dies ist besonders nützlich, wenn PDFs in einer Pipeline generiert oder geändert werden und neuer Inhalt stromabwärts angefügt wird.

Rufen Sie die flache Lesezeichenliste mit getBookmarks() ab, wählen Sie das Ziel-Lesezeichen anhand seines Listenindex aus und rufen Sie dann addNextBookmark auf, um unmittelbar danach ein neues Geschwister einzufügen. Verwenden Sie addChildBookmark, um einen neuen Eintrag eine Ebene tiefer unter dem ausgewählten Lesezeichen zu platzieren. Beide Methoden akzeptieren einen Titelstring und einen nullbasierten Seitenindex.

//:path=/static-assets/ironpdf-java/content-code-examples/how-to/bookmarks/insert-at-index.java
import java.io.IOException;
import java.nio.file.Path;
import java.util.List;
import com.ironsoftware.ironpdf.License;
import com.ironsoftware.ironpdf.PdfDocument;
import com.ironsoftware.ironpdf.bookmark.Bookmark;
import com.ironsoftware.ironpdf.bookmark.BookmarkManager;

public class Main {
    public static void main(String[] args) throws IOException {
        // Set the license key
        License.setLicenseKey("IRONPDF-MYLICENSE-KEY-1EF01");

        // Load the PDF modified in the multi-layer example
        PdfDocument pdf = PdfDocument.fromFile(Path.of("multiLayer.pdf"));

        // Get the BookmarkManager
        BookmarkManager bookmarks = pdf.getBookmark();

        // Retrieve the flat bookmark list
        List<Bookmark> bookmarkList = bookmarks.getBookmarks();

        // Select a bookmark at a specific index
        Bookmark bookmark = bookmarkList.get(5);

        // Insert a new bookmark after the selected entry
        bookmark.addNextBookmark("Fourth Page", 6);

        // Add a child bookmark under the selected entry
        bookmark.addChildBookmark("Section 1", 7);

        // Save the updated PDF
        pdf.saveAs(Path.of("specificIndex.pdf"));
    }
}

//:path=/static-assets/ironpdf-java/content-code-examples/how-to/bookmarks/insert-at-index.java
import java.io.IOException;
import java.nio.file.Path;
import java.util.List;
import com.ironsoftware.ironpdf.License;
import com.ironsoftware.ironpdf.PdfDocument;
import com.ironsoftware.ironpdf.bookmark.Bookmark;
import com.ironsoftware.ironpdf.bookmark.BookmarkManager;

public class Main {
    public static void main(String[] args) throws IOException {
        // Set the license key
        License.setLicenseKey("IRONPDF-MYLICENSE-KEY-1EF01");

        // Load the PDF modified in the multi-layer example
        PdfDocument pdf = PdfDocument.fromFile(Path.of("multiLayer.pdf"));

        // Get the BookmarkManager
        BookmarkManager bookmarks = pdf.getBookmark();

        // Retrieve the flat bookmark list
        List<Bookmark> bookmarkList = bookmarks.getBookmarks();

        // Select a bookmark at a specific index
        Bookmark bookmark = bookmarkList.get(5);

        // Insert a new bookmark after the selected entry
        bookmark.addNextBookmark("Fourth Page", 6);

        // Add a child bookmark under the selected entry
        bookmark.addChildBookmark("Section 1", 7);

        // Save the updated PDF
        pdf.saveAs(Path.of("specificIndex.pdf"));
    }
}

Die Methode addNextBookmark fügt den neuen Eintrag als Geschwister des ausgewählten Lesezeichens unmittelbar danach in die Liste ein. Die Methode addChildBookmark platziert den neuen Eintrag eine Ebene tiefer, unter dem ausgewählten Lesezeichen. Beide Methoden akzeptieren einen Titelstring und einen nullbasierten Seitenindex.

Was sind die nächsten Schritte für PDF-Lesezeichen in Java?

PDF-Lesezeichen bieten Benutzern einen direkten Navigationspfad durch komplexe Dokumente, ohne scrollen zu müssen. IronPDF's BookmarkManager behandelt den gesamten Bereich der Lesezeichenoperationen: Hinzufügen von flachen Eintragslisten, Erstellen von tiefen mehrstufigen Gliederungen, Abrufen bestehender Einträge und Einfügen an bestimmten Positionen.

Um weiterhin mit Dokumentstruktur- und Navigationsfunktionen zu arbeiten, erkunden Sie diese verwandten Ressourcen:

• PDFs in Java aufteilen: kleinere, in sich geschlossene Dokumente erstellen, die ihre eigene Lesezeichenstruktur tragen
• PDFs in Java drucken: markierte Dokumente an einen Drucker senden, wobei die Navigation erhalten bleibt
• Java PDF-Tutorials: zusätzliche vollständige Beispiele für häufige PDF-Arbeitsabläufe
• Anmerkungen zu PDFs in Java hinzufügen: Kommentare und Markups an bestimmten Seitenorten anhängen
• IronPDF for Java-Beispiele: Codebeispiele für die gesamte IronPDF Java API kopieren und einfügen

Starten Sie Ihre kostenlose Testversion, um Lesezeichen, Gliederungen und andere Navigationsfunktionen zu Ihrem Java-PDF-Workflow hinzuzufügen. Um eine Lizenz für den Produktionseinsatz zu erwerben, sehen Sie sich Lizenzierungsoptionen an.