aboutsummaryrefslogtreecommitdiffstats
path: root/src/java/org/apache/fop/render/pdf/PDFStructureTreeBuilder.java
blob: 0f8e74515046ac74a744fb513892b2a09619305b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/* $Id$ */

package org.apache.fop.render.pdf;

import java.util.LinkedList;
import java.util.Locale;

import org.xml.sax.Attributes;

import org.apache.fop.accessibility.StructureTreeElement;
import org.apache.fop.accessibility.StructureTreeEventHandler;
import org.apache.fop.events.EventBroadcaster;
import org.apache.fop.fo.extensions.ExtensionElementMapping;
import org.apache.fop.pdf.PDFFactory;
import org.apache.fop.pdf.PDFName;
import org.apache.fop.pdf.PDFObject;
import org.apache.fop.pdf.PDFParentTree;
import org.apache.fop.pdf.PDFStructElem;
import org.apache.fop.pdf.PDFStructTreeRoot;

class PDFStructureTreeBuilder implements StructureTreeEventHandler {

    private PDFFactory pdfFactory;

    private PDFLogicalStructureHandler logicalStructureHandler;

    private EventBroadcaster eventBroadcaster;

    private LinkedList<PDFStructElem> ancestors = new LinkedList<PDFStructElem>();

    private PDFStructElem rootStructureElement;

    void setPdfFactory(PDFFactory pdfFactory) {
        this.pdfFactory = pdfFactory;
    }

    void setLogicalStructureHandler(PDFLogicalStructureHandler logicalStructureHandler) {
        this.logicalStructureHandler = logicalStructureHandler;
        createRootStructureElement();
    }

    private void createRootStructureElement() {
        assert rootStructureElement == null;
        PDFParentTree parentTree = logicalStructureHandler.getParentTree();
        PDFStructTreeRoot structTreeRoot = pdfFactory.getDocument().makeStructTreeRoot(parentTree);
        rootStructureElement = createStructureElement("root", structTreeRoot, null);
        structTreeRoot.addKid(rootStructureElement);
    }

    void setEventBroadcaster(EventBroadcaster eventBroadcaster) {
        this.eventBroadcaster = eventBroadcaster;
    }

    public void startPageSequence(Locale language, String role) {
        ancestors = new LinkedList<PDFStructElem>();
        PDFStructElem structElem = createStructureElement("page-sequence", rootStructureElement, role);
        if (language != null) {
            structElem.setLanguage(language);
        }
        rootStructureElement.addKid(structElem);
        ancestors.add(structElem);
    }

    private PDFStructElem createStructureElement(String name, PDFObject parent, String role) {
        PDFName structureType = FOToPDFRoleMap.mapFormattingObject(name, role, parent, eventBroadcaster);
        return pdfFactory.getDocument().makeStructureElement(structureType, parent);
    }

    public void endPageSequence() {
    }

    public StructureTreeElement startNode(String name, Attributes attributes) {
        PDFStructElem parent = ancestors.getFirst();
        String role = attributes.getValue("role");
        PDFStructElem structElem = createStructureElement(name, parent, role);
        setSpanAttributes(structElem, attributes);
        parent.addKid(structElem);
        ancestors.addFirst(structElem);
        return structElem;
    }

    private void setSpanAttributes(PDFStructElem structElem, Attributes attributes) {
        String columnSpan = attributes.getValue("number-columns-spanned");
        if (columnSpan != null) {
            structElem.setTableAttributeColSpan(Integer.parseInt(columnSpan));
        }
        String rowSpan = attributes.getValue("number-rows-spanned");
        if (rowSpan != null) {
            structElem.setTableAttributeRowSpan(Integer.parseInt(rowSpan));
        }
    }

    public void endNode(String name) {
        removeFirstAncestor();
    }

    private void removeFirstAncestor() {
        ancestors.removeFirst();
    }

    public StructureTreeElement startImageNode(String name, Attributes attributes) {
        PDFStructElem parent = ancestors.getFirst();
        String role = attributes.getValue("role");
        PDFStructElem structElem = createStructureElement(name, parent, role);
        parent.addKid(structElem);
        String altTextNode = attributes.getValue(ExtensionElementMapping.URI, "alt-text");
        if (altTextNode != null) {
            structElem.put("Alt", altTextNode);
        } else {
            structElem.put("Alt", "No alternate text specified");
        }
        ancestors.addFirst(structElem);
        return structElem;
    }

    public StructureTreeElement startReferencedNode(String name, Attributes attributes) {
        PDFStructElem parent = ancestors.getFirst();
        String role = attributes.getValue("role");
        PDFStructElem structElem;
        if ("#PCDATA".equals(name)) {
            structElem = new PDFStructElem.Placeholder(parent, name);
        } else {
            structElem = createStructureElement(name, parent, role);
        }
        parent.addKid(structElem);
        ancestors.addFirst(structElem);
        return structElem;
    }

}