Java での Tagged PDF の作成
Contents
[
Hide
]
タグ付き PDF を作成することは、文書を PDF/UA のアクセシビリティ要件に対して検証しやすくし、支援技術が解釈しやすくなる構造要素を追加することを意味します。
シンプルなタグ付けされた PDF ドキュメントの作成
論理構造ツリーに見出しと段落を持つ最小限のタグ付き PDF が必要な場合は、この例を使用してください。
- 新しい PDF の Document を作成し、その ITaggedContent を取得してください。
- ドキュメントのタイトルと言語を設定し、必要なヘッダーと段落要素を作成してください。
- 構造要素をルート要素に追加し、ドキュメントを保存してください。
public static void createTaggedPdfDocumentSimple(Path outputFile) {
try (Document document = new Document()) {
ITaggedContent taggedContent = document.getTaggedContent();
StructureElement rootElement = taggedContent.getRootElement();
taggedContent.setTitle("Tagged Pdf Document");
taggedContent.setLanguage("en-US");
HeaderElement mainHeader = taggedContent.createHeaderElement();
mainHeader.setText("Main Header");
ParagraphElement paragraphElement = taggedContent.createParagraphElement();
paragraphElement.setText("Lorem ipsum dolor sit amet, consectetur adipiscing elit. "
+ "Aenean nec lectus ac sem faucibus imperdiet. Sed ut erat ac magna ullamcorper hendrerit. "
+ "Cras pellentesque libero semper, gravida magna sed, luctus leo.");
rootElement.appendChild(mainHeader, true);
rootElement.appendChild(paragraphElement, true);
document.save(outputFile.toString());
}
}
高度なタグ付け PDF ドキュメントの作成
この例では、見出し、段落、スパン、引用、および明示的なレイアウト設定を組み合わせることで、よりリッチな構造を構築しています。
- 新しい PDF の Document を作成し、タグ付けされたコンテンツのメタデータを初期化してください。
- 見出しと段落の構造を作成し、次に段落内にスパンと引用要素を追加してください。
- 段落の位置を調整し、要素をルート構造に追加して、ドキュメントを保存してください。
public static void createTaggedPdfDocumentAdv(Path outputFile) {
try (Document document = new Document()) {
ITaggedContent taggedContent = document.getTaggedContent();
StructureElement rootElement = taggedContent.getRootElement();
taggedContent.setTitle("Tagged Pdf Document");
taggedContent.setLanguage("en-US");
HeaderElement header1 = taggedContent.createHeaderElement(1);
header1.setText("Header Level 1");
ParagraphElement paragraphWithQuotes = taggedContent.createParagraphElement();
paragraphWithQuotes.getStructureTextState().setFont(FontRepository.findFont("Arial"));
PositionSettings positionSettings = new PositionSettings();
positionSettings.setMargin(new MarginInfo(10, 5, 10, 5));
paragraphWithQuotes.adjustPosition(positionSettings);
SpanElement spanElement1 = taggedContent.createSpanElement();
spanElement1.setText("Lorem ipsum dolor sit amet, consectetur adipiscing elit. "
+ "Aenean nec lectus ac sem faucibus imperdiet. Sed ut erat ac magna ullamcorper hendrerit. ");
QuoteElement quoteElement = taggedContent.createQuoteElement();
quoteElement.setText("Sed vulputate, quam sed lacinia luctus, ipsum nibh fringilla purus.");
quoteElement.getStructureTextState().setFontStyle(Nullable.of(FontStyles.Bold | FontStyles.Italic));
SpanElement spanElement2 = taggedContent.createSpanElement();
spanElement2.setText(" Sed non consectetur elit.");
paragraphWithQuotes.appendChild(spanElement1, true);
paragraphWithQuotes.appendChild(quoteElement, true);
paragraphWithQuotes.appendChild(spanElement2, true);
rootElement.appendChild(header1, true);
rootElement.appendChild(paragraphWithQuotes, true);
document.save(outputFile.toString());
}
}
タグ付けされたコンテンツへのテキストスタイルの追加
タグ付けされた段落の内容に明示的なフォント、色、スタイル情報を持たせる必要がある場合は、この例を使用してください。
- 新しい Tagged PDF の Document を作成してください。
- 段落要素を作成し、その構造テキスト状態を設定してください。
- 段落テキストを設定し、ドキュメントを保存してください。
public static void addStyle(Path outputFile) {
try (Document document = new Document()) {
ITaggedContent taggedContent = document.getTaggedContent();
taggedContent.setTitle("Tagged Pdf Document");
taggedContent.setLanguage("en-US");
ParagraphElement paragraphElement = taggedContent.createParagraphElement();
taggedContent.getRootElement().appendChild(paragraphElement, true);
paragraphElement.getStructureTextState().setFontSize(Nullable.of(18.0f));
paragraphElement.getStructureTextState().setForegroundColor(Color.getRed());
paragraphElement.getStructureTextState().setFontStyle(Nullable.of(FontStyles.Italic));
paragraphElement.setText("Red italic text.");
document.save(outputFile.toString());
}
}
図の構造要素の追加
この例では、代替テキスト、タイトル、カスタムタグ、画像コンテンツ、配置を使用してタグ付けされた図を作成する方法を示します。
- 新しい Tagged PDF の Document を作成してください。
- FigureElement を作成し、そのアクセシブルメタデータを設定して画像を割り当ててください。
- 図の位置を調整して、ドキュメントを保存してください。
public static void illustrateStructureElements(Path imageFile, Path outputFile) {
try (Document document = new Document()) {
ITaggedContent taggedContent = document.getTaggedContent();
taggedContent.setTitle("Tagged Pdf Document");
taggedContent.setLanguage("en-US");
FigureElement figure1 = taggedContent.createFigureElement();
taggedContent.getRootElement().appendChild(figure1, true);
figure1.setAlternativeText("Figure One");
figure1.setTitle("Image 1");
figure1.setTag("Fig1");
figure1.setImage(imageFile.toString(), 300);
PositionSettings positionSettings = new PositionSettings();
MarginInfo marginInfo = new MarginInfo();
marginInfo.setLeft(50);
marginInfo.setTop(20);
positionSettings.setMargin(marginInfo);
figure1.adjustPosition(positionSettings);
document.save(outputFile.toString());
}
}
PDF/UA 用にタグ付けされた PDF の検証
タグ付けされた PDF が PDF/UA の検証規則を満たしているかを確認する必要がある場合は、この例を使用してください。
public static void validateTaggedPdf(Path inputFile, Path logFile) {
try (Document document = new Document(inputFile.toString())) {
boolean isValid = document.validate(logFile.toString(), PdfFormat.PDF_UA_1);
System.out.println("Is Valid: " + isValid);
}
}
構造要素の位置の調整
この例では、タグ付けされた段落に対して、明示的な余白と配置設定を適用します。
- 新しい Tagged PDF の Document を作成してください。
- 段落構造要素を追加し、PositionSettings を準備してください。
- 段落に位置設定を適用し、ドキュメントを保存してください。
public static void adjustPosition(Path outputFile) {
try (Document document = new Document()) {
ITaggedContent taggedContent = document.getTaggedContent();
taggedContent.setTitle("Tagged Pdf Document");
taggedContent.setLanguage("en-US");
ParagraphElement paragraph = taggedContent.createParagraphElement();
taggedContent.getRootElement().appendChild(paragraph, true);
paragraph.setText("Text.");
PositionSettings positionSettings = new PositionSettings();
MarginInfo marginInfo = new MarginInfo();
marginInfo.setLeft(300);
marginInfo.setTop(20);
marginInfo.setRight(0);
marginInfo.setBottom(0);
positionSettings.setMargin(marginInfo);
positionSettings.setHorizontalAlignment(HorizontalAlignment.None);
positionSettings.setVerticalAlignment(VerticalAlignment.None);
positionSettings.setFirstParagraphInColumn(false);
positionSettings.setKeptWithNext(false);
positionSettings.setInNewPage(false);
positionSettings.setInLineParagraph(false);
paragraph.adjustPosition(positionSettings);
document.save(outputFile.toString());
}
}
既存の PDF の自動タグ付けで PDF/UA への変換
既存の PDF を PDF/UA に変換し、変換中に自動的にタグ付けする必要がある場合にこのアプローチを使用します。
- 元の PDF を開いて Document を取得してください。
- PdfFormatConversionOptions を作成し、自動タグ付けを有効にしてください。
- 変換を実行し、出力ドキュメントを保存してください。
public static void convertToPdfUaWithAutomaticTagging(Path inputFile, Path outputFile, Path logFile) {
try (Document document = new Document(inputFile.toString())) {
PdfFormatConversionOptions options = new PdfFormatConversionOptions(
logFile.toString(), PdfFormat.PDF_UA_1, ConvertErrorAction.Delete);
AutoTaggingSettings autoTaggingSettings = new AutoTaggingSettings();
autoTaggingSettings.setEnableAutoTagging(true);
autoTaggingSettings.setHeadingRecognitionStrategy(HeadingRecognitionStrategy.Auto);
options.setAutoTaggingSettings(autoTaggingSettings);
document.convert(options);
document.save(outputFile.toString());
}
}
アクセシブルなフォームフィールドを含むタグ付きPDFの作成
この例では、署名フォームフィールドにタグを付けて、論理構造ツリーの一部にします。
- 新しい PDF の Document を作成し、フォームフィールドを含むページを追加してください。
- ドキュメントのフォーム コレクションにフォーム フィールドを追加してください。
- タグ付けされたフォーム構造要素を作成し、フィールドに関連付けて、ドキュメントを保存してください。
public static void createPdfWithTaggedFormField(Path outputFile) {
try (Document document = new Document()) {
Page page = document.getPages().add();
ITaggedContent taggedContent = document.getTaggedContent();
StructureElement rootElement = taggedContent.getRootElement();
SignatureField signatureField = new SignatureField(page, new Rectangle(50, 50, 100, 100, true));
signatureField.setPartialName("Signature1");
signatureField.setAlternateName("signature 1");
Form formFields = document.getForm();
formFields.add(signatureField);
FormElement form = taggedContent.createFormElement();
form.setAlternativeText("form 1");
form.tag(signatureField);
rootElement.appendChild(form, true);
document.save(outputFile.toString());
}
}
タグ付けされた PDF を TOC ページ付きで作成
タグ付き PDF に基本的な目次ページを文書の見出しにリンクさせる必要がある場合は、この例を使用してください。
- 新しい Tagged PDF の Document を作成し、TOC ページを追加してください。
- TOCElement を作成し、目次に表示されるべきヘッダーを指定してください。
- 目次エントリを見出しにリンクし、ドキュメントを保存してください。
public static void createPdfWithTocPage(Path outputFile) {
try (Document document = new Document()) {
ITaggedContent content = document.getTaggedContent();
StructureElement rootElement = content.getRootElement();
content.setLanguage("en-US");
Page tocPage = document.getPages().add();
tocPage.setTocInfo(new TocInfo());
TOCElement tocElement = content.createTOCElement();
rootElement.appendChild(tocElement, true);
document.getPages().add();
HeaderElement header = content.createHeaderElement(1);
header.setText("1. Header");
rootElement.appendChild(header, true);
TOCIElement toci = content.createTOCIElement();
tocElement.appendChild(toci, true);
header.addEntryToTocPage(tocPage, toci);
toci.addRef(header);
document.save(outputFile.toString());
}
}
高度なタグ付き PDF の作成と TOC ページの追加
この例では、リンクされたページタイトル、入れ子になったリスト項目、および複数の見出しレベルを持つ、より複雑なタグ付き TOC を構築します。
- 新しい Tagged PDF の Document を作成し、可視的なタイトルを持つ TOC ページを用意してください。
- TOC 構造を作成し、TOC のタイトルとエントリを見出しやリスト項目にリンクし、関連するコンテンツ要素を追加してください。
- 高度な目次構造を使用して最終文書を保存してください。
public static void createPdfWithTocPageAdvanced(Path outputFile) {
try (Document document = new Document()) {
ITaggedContent content = document.getTaggedContent();
StructureElement rootElement = content.getRootElement();
content.setLanguage("en-US");
Page tocPage = document.getPages().add();
tocPage.setTocInfo(new TocInfo());
tocPage.getTocInfo().setTitle(new TextFragment("Table of Contents"));
TOCElement tocElement = content.createTOCElement();
HeaderElement headerForTocPageTitle = content.createHeaderElement(1);
tocElement.linkTocPageTitleToHeaderElement(tocPage, headerForTocPageTitle);
rootElement.appendChild(headerForTocPageTitle, true);
rootElement.appendChild(tocElement, true);
document.getPages().add();
HeaderElement header = content.createHeaderElement(1);
header.setText("1. Header");
rootElement.appendChild(header, true);
TOCIElement toci = content.createTOCIElement();
tocElement.appendChild(toci, true);
header.addEntryToTocPage(tocPage, toci);
toci.addRef(header);
ListElement listElement = content.createListElement();
for (int i = 1; i < 4; i++) {
ListLIElement li = content.createListLIElement();
listElement.appendChild(li, true);
HeaderElement subHeader = content.createHeaderElement(2);
subHeader.getStructureTextState().setFontSize(Nullable.of(14.0f));
subHeader.setLanguage("en-US");
subHeader.setText("1." + i + " subheader ");
subHeader.addEntryToTocPage(tocPage, li);
li.addRef(subHeader);
ParagraphElement p = content.createParagraphElement();
p.setText("Lorem ipsum dolor sit amet, consectetur adipiscing elit.");
p.setLanguage("en-US");
rootElement.appendChild(subHeader, true);
rootElement.appendChild(p, true);
}
toci.appendChild(listElement, true);
HeaderElement header2 = content.createHeaderElement(1);
header2.setText("2. Header");
rootElement.appendChild(header2, true);
TOCIElement toci2 = content.createTOCIElement();
tocElement.appendChild(toci2, true);
header2.addEntryToTocPage(tocPage, toci2);
toci2.addRef(header2);
document.save(outputFile.toString());
}
}