Footer in the PDF created using iTextPDF is not accessible

I have created a simple PDF here to explain the issue I am facing

Plain text
Copy to clipboard
Open code in new window
EnlighterJS 3 Syntax Highlighter
<code>import com.itextpdf.io.font.FontConstants;
import com.itextpdf.io.image.ImageDataFactory;
import com.itextpdf.kernel.events.PdfDocumentEvent;
import com.itextpdf.kernel.font.PdfFontFactory;
import com.itextpdf.kernel.geom.PageSize;
import com.itextpdf.kernel.pdf.PdfDocument;
import com.itextpdf.kernel.pdf.PdfViewerPreferences;
import com.itextpdf.kernel.pdf.PdfWriter;
import com.itextpdf.kernel.pdf.tagging.StandardRoles;
import com.itextpdf.layout.Document;
import com.itextpdf.layout.element.*;
import com.itextpdf.layout.property.TextAlignment;
import java.io.File;
import java.io.IOException;
public class PDFGenerator {
public static final String DEST = "C:\Users\skesha01\temp\output.pdf";
public static void main(String[] args) throws IOException {
File file = new File(DEST);
file.getParentFile().mkdirs();
new PDFGenerator().createPdf(DEST);
}
public void createPdf(String dest) throws IOException {
PdfDocument pdfDoc = new PdfDocument(new PdfWriter(dest));
pdfDoc.setTagged();
pdfDoc.getCatalog().setViewerPreferences(new PdfViewerPreferences().setDisplayDocTitle(true));
Document doc = new Document(pdfDoc, PageSize.A4);
pdfDoc.addEventHandler(PdfDocumentEvent.END_PAGE, new FooterEventHandler(doc));
addContent(doc);
doc.close();
}
public void addContent(Document doc) throws IOException {
doc.add(new Paragraph("Sample PDF with footer, page numbers, and table fields")
.setFont(PdfFontFactory.createFont(FontConstants.HELVETICA))
.setFontSize(12)
.setTextAlignment(TextAlignment.CENTER));
Table table = new Table(3).useAllAvailableWidth();
Cell headerCell1 = new Cell().add(new Paragraph("Header 1"));
Cell headerCell2 = new Cell().add(new Paragraph("Header 2"));
Cell headerCell3 = new Cell().add(new Paragraph("Header 3"));
table.addHeaderCell(headerCell1).getAccessibilityProperties().setRole(StandardRoles.TH);
table.addHeaderCell(headerCell2).getAccessibilityProperties().setRole(StandardRoles.TH);
table.addHeaderCell(headerCell3).getAccessibilityProperties().setRole(StandardRoles.TH);
for (int i = 0; i < 1; i++) {
table.addCell("Row " + (i + 1) + ", Column 1").getAccessibilityProperties().setRole(StandardRoles.TD);
table.addCell("Row " + (i + 1) + ", Column 2").getAccessibilityProperties().setRole(StandardRoles.TD);
table.addCell("Row " + (i + 1) + ", Column 3").getAccessibilityProperties().setRole(StandardRoles.TD);
}
table.getAccessibilityProperties().setRole(StandardRoles.TABLE);
table.getAccessibilityProperties().setAlternateDescription("I am reading this table alternate text");
doc.add(table);
}
}
</code>
<code>import com.itextpdf.io.font.FontConstants; import com.itextpdf.io.image.ImageDataFactory; import com.itextpdf.kernel.events.PdfDocumentEvent; import com.itextpdf.kernel.font.PdfFontFactory; import com.itextpdf.kernel.geom.PageSize; import com.itextpdf.kernel.pdf.PdfDocument; import com.itextpdf.kernel.pdf.PdfViewerPreferences; import com.itextpdf.kernel.pdf.PdfWriter; import com.itextpdf.kernel.pdf.tagging.StandardRoles; import com.itextpdf.layout.Document; import com.itextpdf.layout.element.*; import com.itextpdf.layout.property.TextAlignment; import java.io.File; import java.io.IOException; public class PDFGenerator { public static final String DEST = "C:\Users\skesha01\temp\output.pdf"; public static void main(String[] args) throws IOException { File file = new File(DEST); file.getParentFile().mkdirs(); new PDFGenerator().createPdf(DEST); } public void createPdf(String dest) throws IOException { PdfDocument pdfDoc = new PdfDocument(new PdfWriter(dest)); pdfDoc.setTagged(); pdfDoc.getCatalog().setViewerPreferences(new PdfViewerPreferences().setDisplayDocTitle(true)); Document doc = new Document(pdfDoc, PageSize.A4); pdfDoc.addEventHandler(PdfDocumentEvent.END_PAGE, new FooterEventHandler(doc)); addContent(doc); doc.close(); } public void addContent(Document doc) throws IOException { doc.add(new Paragraph("Sample PDF with footer, page numbers, and table fields") .setFont(PdfFontFactory.createFont(FontConstants.HELVETICA)) .setFontSize(12) .setTextAlignment(TextAlignment.CENTER)); Table table = new Table(3).useAllAvailableWidth(); Cell headerCell1 = new Cell().add(new Paragraph("Header 1")); Cell headerCell2 = new Cell().add(new Paragraph("Header 2")); Cell headerCell3 = new Cell().add(new Paragraph("Header 3")); table.addHeaderCell(headerCell1).getAccessibilityProperties().setRole(StandardRoles.TH); table.addHeaderCell(headerCell2).getAccessibilityProperties().setRole(StandardRoles.TH); table.addHeaderCell(headerCell3).getAccessibilityProperties().setRole(StandardRoles.TH); for (int i = 0; i < 1; i++) { table.addCell("Row " + (i + 1) + ", Column 1").getAccessibilityProperties().setRole(StandardRoles.TD); table.addCell("Row " + (i + 1) + ", Column 2").getAccessibilityProperties().setRole(StandardRoles.TD); table.addCell("Row " + (i + 1) + ", Column 3").getAccessibilityProperties().setRole(StandardRoles.TD); } table.getAccessibilityProperties().setRole(StandardRoles.TABLE); table.getAccessibilityProperties().setAlternateDescription("I am reading this table alternate text"); doc.add(table); } } </code>
import com.itextpdf.io.font.FontConstants;
import com.itextpdf.io.image.ImageDataFactory;
import com.itextpdf.kernel.events.PdfDocumentEvent;
import com.itextpdf.kernel.font.PdfFontFactory;
import com.itextpdf.kernel.geom.PageSize;
import com.itextpdf.kernel.pdf.PdfDocument;
import com.itextpdf.kernel.pdf.PdfViewerPreferences;
import com.itextpdf.kernel.pdf.PdfWriter;
import com.itextpdf.kernel.pdf.tagging.StandardRoles;
import com.itextpdf.layout.Document;
import com.itextpdf.layout.element.*;
import com.itextpdf.layout.property.TextAlignment;

import java.io.File;
import java.io.IOException;

public class PDFGenerator {

    public static final String DEST = "C:\Users\skesha01\temp\output.pdf";

    public static void main(String[] args) throws IOException {
        File file = new File(DEST);
        file.getParentFile().mkdirs();
        new PDFGenerator().createPdf(DEST);
    }

    public void createPdf(String dest) throws IOException {
        PdfDocument pdfDoc = new PdfDocument(new PdfWriter(dest));
        pdfDoc.setTagged();
        pdfDoc.getCatalog().setViewerPreferences(new PdfViewerPreferences().setDisplayDocTitle(true));
        Document doc = new Document(pdfDoc, PageSize.A4);
        pdfDoc.addEventHandler(PdfDocumentEvent.END_PAGE, new FooterEventHandler(doc));

        addContent(doc);
        doc.close();
    }

    public void addContent(Document doc) throws IOException {
        doc.add(new Paragraph("Sample PDF with footer, page numbers, and table fields")
                .setFont(PdfFontFactory.createFont(FontConstants.HELVETICA))
                .setFontSize(12)
                .setTextAlignment(TextAlignment.CENTER));
  
        Table table = new Table(3).useAllAvailableWidth();
        Cell headerCell1 = new Cell().add(new Paragraph("Header 1"));
        Cell headerCell2 = new Cell().add(new Paragraph("Header 2"));
        Cell headerCell3 = new Cell().add(new Paragraph("Header 3"));
        table.addHeaderCell(headerCell1).getAccessibilityProperties().setRole(StandardRoles.TH);
        table.addHeaderCell(headerCell2).getAccessibilityProperties().setRole(StandardRoles.TH);
        table.addHeaderCell(headerCell3).getAccessibilityProperties().setRole(StandardRoles.TH);
        for (int i = 0; i < 1; i++) {
            table.addCell("Row " + (i + 1) + ", Column 1").getAccessibilityProperties().setRole(StandardRoles.TD);
            table.addCell("Row " + (i + 1) + ", Column 2").getAccessibilityProperties().setRole(StandardRoles.TD);
            table.addCell("Row " + (i + 1) + ", Column 3").getAccessibilityProperties().setRole(StandardRoles.TD);
        }
        table.getAccessibilityProperties().setRole(StandardRoles.TABLE);
        table.getAccessibilityProperties().setAlternateDescription("I am reading this table alternate text");
        doc.add(table);
    }
}

and the footer event handler responsible for adding the footer to each page is

Plain text
Copy to clipboard
Open code in new window
EnlighterJS 3 Syntax Highlighter
<code>import com.itextpdf.io.font.FontConstants;
import com.itextpdf.kernel.events.Event;
import com.itextpdf.kernel.events.IEventHandler;
import com.itextpdf.kernel.events.PdfDocumentEvent;
import com.itextpdf.kernel.font.PdfFont;
import com.itextpdf.kernel.font.PdfFontFactory;
import com.itextpdf.kernel.pdf.PdfDocument;
import com.itextpdf.kernel.pdf.PdfName;
import com.itextpdf.kernel.pdf.PdfPage;
import com.itextpdf.kernel.pdf.canvas.PdfCanvas;
import com.itextpdf.kernel.pdf.tagging.StandardRoles;
import com.itextpdf.layout.Document;
import com.itextpdf.layout.element.Text;
import java.io.IOException;
public class FooterEventHandler implements IEventHandler {
protected PdfFont font;
private Document document;
public FooterEventHandler(Document document) {
try {
font = PdfFontFactory.createFont(FontConstants.HELVETICA);
this.document = document;
} catch (IOException e) {
e.printStackTrace();
}
}
@Override
public void handleEvent(Event event) {
PdfDocumentEvent docEvent = (PdfDocumentEvent) event;
PdfDocument pdfDoc = docEvent.getDocument();
PdfCanvas canvas = new PdfCanvas(pdfDoc.getLastPage());
canvas.setStrokeColorRgb(0, 0, 0).setLineWidth(0.5f);
canvas.moveTo(36, 20).lineTo(pdfDoc.getDefaultPageSize().getRight() - 36, 20).stroke();
addFooter(canvas, pdfDoc, docEvent.getPage());
}
private void addFooter(PdfCanvas canvas, PdfDocument pdfDoc, PdfPage page) {
canvas.setStrokeColorRgb(0, 0, 0).setLineWidth(0.5f);
canvas.moveTo(36, 20).lineTo(pdfDoc.getDefaultPageSize().getRight() - 36, 20).stroke();
Text footerText = new Text("Footer Text - Page " + pdfDoc.getPageNumber(page));
footerText.getAccessibilityProperties().setRole(StandardRoles.ARTIFACT);
canvas.beginText().beginMarkedContent(PdfName.Artifact)
.setFontAndSize(font, 10)
.moveText((pdfDoc.getDefaultPageSize().getLeft() + pdfDoc.getDefaultPageSize().getRight()) / 2, 10)
.showText(footerText.getText())
.endText();
}
}
</code>
<code>import com.itextpdf.io.font.FontConstants; import com.itextpdf.kernel.events.Event; import com.itextpdf.kernel.events.IEventHandler; import com.itextpdf.kernel.events.PdfDocumentEvent; import com.itextpdf.kernel.font.PdfFont; import com.itextpdf.kernel.font.PdfFontFactory; import com.itextpdf.kernel.pdf.PdfDocument; import com.itextpdf.kernel.pdf.PdfName; import com.itextpdf.kernel.pdf.PdfPage; import com.itextpdf.kernel.pdf.canvas.PdfCanvas; import com.itextpdf.kernel.pdf.tagging.StandardRoles; import com.itextpdf.layout.Document; import com.itextpdf.layout.element.Text; import java.io.IOException; public class FooterEventHandler implements IEventHandler { protected PdfFont font; private Document document; public FooterEventHandler(Document document) { try { font = PdfFontFactory.createFont(FontConstants.HELVETICA); this.document = document; } catch (IOException e) { e.printStackTrace(); } } @Override public void handleEvent(Event event) { PdfDocumentEvent docEvent = (PdfDocumentEvent) event; PdfDocument pdfDoc = docEvent.getDocument(); PdfCanvas canvas = new PdfCanvas(pdfDoc.getLastPage()); canvas.setStrokeColorRgb(0, 0, 0).setLineWidth(0.5f); canvas.moveTo(36, 20).lineTo(pdfDoc.getDefaultPageSize().getRight() - 36, 20).stroke(); addFooter(canvas, pdfDoc, docEvent.getPage()); } private void addFooter(PdfCanvas canvas, PdfDocument pdfDoc, PdfPage page) { canvas.setStrokeColorRgb(0, 0, 0).setLineWidth(0.5f); canvas.moveTo(36, 20).lineTo(pdfDoc.getDefaultPageSize().getRight() - 36, 20).stroke(); Text footerText = new Text("Footer Text - Page " + pdfDoc.getPageNumber(page)); footerText.getAccessibilityProperties().setRole(StandardRoles.ARTIFACT); canvas.beginText().beginMarkedContent(PdfName.Artifact) .setFontAndSize(font, 10) .moveText((pdfDoc.getDefaultPageSize().getLeft() + pdfDoc.getDefaultPageSize().getRight()) / 2, 10) .showText(footerText.getText()) .endText(); } } </code>
import com.itextpdf.io.font.FontConstants;
import com.itextpdf.kernel.events.Event;
import com.itextpdf.kernel.events.IEventHandler;
import com.itextpdf.kernel.events.PdfDocumentEvent;
import com.itextpdf.kernel.font.PdfFont;
import com.itextpdf.kernel.font.PdfFontFactory;
import com.itextpdf.kernel.pdf.PdfDocument;
import com.itextpdf.kernel.pdf.PdfName;
import com.itextpdf.kernel.pdf.PdfPage;
import com.itextpdf.kernel.pdf.canvas.PdfCanvas;
import com.itextpdf.kernel.pdf.tagging.StandardRoles;
import com.itextpdf.layout.Document;
import com.itextpdf.layout.element.Text;

import java.io.IOException;

public class FooterEventHandler implements IEventHandler {
    protected PdfFont font;

    private Document document;


    public FooterEventHandler(Document document) {
        try {
            font = PdfFontFactory.createFont(FontConstants.HELVETICA);
            this.document = document;
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

    @Override
    public void handleEvent(Event event) {
        PdfDocumentEvent docEvent = (PdfDocumentEvent) event;
        PdfDocument pdfDoc = docEvent.getDocument();
        PdfCanvas canvas = new PdfCanvas(pdfDoc.getLastPage());

        canvas.setStrokeColorRgb(0, 0, 0).setLineWidth(0.5f);
        canvas.moveTo(36, 20).lineTo(pdfDoc.getDefaultPageSize().getRight() - 36, 20).stroke();

        addFooter(canvas, pdfDoc, docEvent.getPage());
    }
    private void addFooter(PdfCanvas canvas, PdfDocument pdfDoc, PdfPage page) {

        canvas.setStrokeColorRgb(0, 0, 0).setLineWidth(0.5f);
        canvas.moveTo(36, 20).lineTo(pdfDoc.getDefaultPageSize().getRight() - 36, 20).stroke();
        Text footerText = new Text("Footer Text - Page " + pdfDoc.getPageNumber(page));
        footerText.getAccessibilityProperties().setRole(StandardRoles.ARTIFACT);
        canvas.beginText().beginMarkedContent(PdfName.Artifact)
                .setFontAndSize(font, 10)
                .moveText((pdfDoc.getDefaultPageSize().getLeft() + pdfDoc.getDefaultPageSize().getRight()) / 2, 10)
                .showText(footerText.getText())
                .endText();
    }
}

A similar problem faced by another user but for Header is PDF created by iText7 with Header is not accessible

I am using JAWS / Adobe Reader to check the accessibility of this generated PDF and both of them do not read the footer.

Upon investigation, I have found that the moment we use “setTagged” on the document, footer is no longer being included in the logical structure of the document. From what I read a footer is not a “real element” and it is our responsibility to tag them appropriately. I could not get it read no matter whatever tag and role I used. Also, I found articles which suggest that headers and footers should not be part of the structure as they will hinder the flow of the document when being read to the user.

Note: Removing setTagged reads the entire document along with footer but it brings out several other problems in images and tables.

I would like to know if there is a workaround to my problem. If there is no workaround, is there a standard that tells header and footer should not be read to the user.

Footer should be accessible and read by the screen reader

New contributor

karthik b is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
Check out our Code of Conduct.

Trang chủ Giới thiệu Sinh nhật bé trai Sinh nhật bé gái Tổ chức sự kiện Biểu diễn giải trí Dịch vụ khác Trang trí tiệc cưới Tổ chức khai trương Tư vấn dịch vụ Thư viện ảnh Tin tức - sự kiện Liên hệ Chú hề sinh nhật Trang trí YEAR END PARTY công ty Trang trí tất niên cuối năm Trang trí tất niên xu hướng mới nhất Trang trí sinh nhật bé trai Hải Đăng Trang trí sinh nhật bé Khánh Vân Trang trí sinh nhật Bích Ngân Trang trí sinh nhật bé Thanh Trang Thuê ông già Noel phát quà Biểu diễn xiếc khỉ Xiếc quay đĩa Dịch vụ tổ chức sự kiện 5 sao Thông tin về chúng tôi Dịch vụ sinh nhật bé trai Dịch vụ sinh nhật bé gái Sự kiện trọn gói Các tiết mục giải trí Dịch vụ bổ trợ Tiệc cưới sang trọng Dịch vụ khai trương Tư vấn tổ chức sự kiện Hình ảnh sự kiện Cập nhật tin tức Liên hệ ngay Thuê chú hề chuyên nghiệp Tiệc tất niên cho công ty Trang trí tiệc cuối năm Tiệc tất niên độc đáo Sinh nhật bé Hải Đăng Sinh nhật đáng yêu bé Khánh Vân Sinh nhật sang trọng Bích Ngân Tiệc sinh nhật bé Thanh Trang Dịch vụ ông già Noel Xiếc thú vui nhộn Biểu diễn xiếc quay đĩa Dịch vụ tổ chức tiệc uy tín Khám phá dịch vụ của chúng tôi Tiệc sinh nhật cho bé trai Trang trí tiệc cho bé gái Gói sự kiện chuyên nghiệp Chương trình giải trí hấp dẫn Dịch vụ hỗ trợ sự kiện Trang trí tiệc cưới đẹp Khởi đầu thành công với khai trương Chuyên gia tư vấn sự kiện Xem ảnh các sự kiện đẹp Tin mới về sự kiện Kết nối với đội ngũ chuyên gia Chú hề vui nhộn cho tiệc sinh nhật Ý tưởng tiệc cuối năm Tất niên độc đáo Trang trí tiệc hiện đại Tổ chức sinh nhật cho Hải Đăng Sinh nhật độc quyền Khánh Vân Phong cách tiệc Bích Ngân Trang trí tiệc bé Thanh Trang Thuê dịch vụ ông già Noel chuyên nghiệp Xem xiếc khỉ đặc sắc Xiếc quay đĩa thú vị
Trang chủ Giới thiệu Sinh nhật bé trai Sinh nhật bé gái Tổ chức sự kiện Biểu diễn giải trí Dịch vụ khác Trang trí tiệc cưới Tổ chức khai trương Tư vấn dịch vụ Thư viện ảnh Tin tức - sự kiện Liên hệ Chú hề sinh nhật Trang trí YEAR END PARTY công ty Trang trí tất niên cuối năm Trang trí tất niên xu hướng mới nhất Trang trí sinh nhật bé trai Hải Đăng Trang trí sinh nhật bé Khánh Vân Trang trí sinh nhật Bích Ngân Trang trí sinh nhật bé Thanh Trang Thuê ông già Noel phát quà Biểu diễn xiếc khỉ Xiếc quay đĩa
Thiết kế website Thiết kế website Thiết kế website Cách kháng tài khoản quảng cáo Mua bán Fanpage Facebook Dịch vụ SEO Tổ chức sinh nhật