123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357 |
- /*
- * 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 java.util.Map;
-
- import org.xml.sax.Attributes;
- import org.xml.sax.helpers.AttributesImpl;
-
- 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.fo.extensions.InternalElementMapping;
- import org.apache.fop.fo.pagination.Flow;
- import org.apache.fop.pdf.PDFFactory;
- import org.apache.fop.pdf.PDFParentTree;
- import org.apache.fop.pdf.PDFStructElem;
- import org.apache.fop.pdf.PDFStructTreeRoot;
- import org.apache.fop.pdf.StandardStructureAttributes.Table.Scope;
- import org.apache.fop.pdf.StandardStructureTypes;
- import org.apache.fop.pdf.StandardStructureTypes.Grouping;
- import org.apache.fop.pdf.StandardStructureTypes.Table;
- import org.apache.fop.pdf.StructureHierarchyMember;
- import org.apache.fop.pdf.StructureType;
- import org.apache.fop.util.XMLUtil;
-
- class PDFStructureTreeBuilder implements StructureTreeEventHandler {
-
- private static final String ROLE = "role";
-
- private static final Map<String, StructureElementBuilder> BUILDERS
- = new java.util.HashMap<String, StructureElementBuilder>();
-
- private static final StructureElementBuilder DEFAULT_BUILDER
- = new DefaultStructureElementBuilder(Grouping.NON_STRUCT);
-
- static {
- // Declarations and Pagination and Layout Formatting Objects
- StructureElementBuilder regionBuilder = new RegionBuilder();
- addBuilder("root", StandardStructureTypes.Grouping.DOCUMENT);
- addBuilder("page-sequence", new PageSequenceBuilder());
- addBuilder("static-content", regionBuilder);
- addBuilder("flow", regionBuilder);
- // Block-level Formatting Objects
- addBuilder("block", StandardStructureTypes.Paragraphlike.P);
- addBuilder("block-container", StandardStructureTypes.Grouping.DIV);
- // Inline-level Formatting Objects
- addBuilder("character", StandardStructureTypes.InlineLevelStructure.SPAN);
- addBuilder("external-graphic", new ImageBuilder());
- addBuilder("instream-foreign-object", new ImageBuilder());
- addBuilder("inline", StandardStructureTypes.InlineLevelStructure.SPAN);
- addBuilder("inline-container", StandardStructureTypes.Grouping.DIV);
- addBuilder("page-number", StandardStructureTypes.InlineLevelStructure.QUOTE);
- addBuilder("page-number-citation", StandardStructureTypes.InlineLevelStructure.QUOTE);
- addBuilder("page-number-citation-last", StandardStructureTypes.InlineLevelStructure.QUOTE);
- // Formatting Objects for Tables
- addBuilder("table-and-caption", StandardStructureTypes.Grouping.DIV);
- addBuilder("table", new TableBuilder());
- addBuilder("table-caption", StandardStructureTypes.Grouping.CAPTION);
- addBuilder("table-header", StandardStructureTypes.Table.THEAD);
- addBuilder("table-footer", new TableFooterBuilder());
- addBuilder("table-body", StandardStructureTypes.Table.TBODY);
- addBuilder("table-row", StandardStructureTypes.Table.TR);
- addBuilder("table-cell", new TableCellBuilder());
- // Formatting Objects for Lists
- addBuilder("list-block", StandardStructureTypes.List.L);
- addBuilder("list-item", StandardStructureTypes.List.LI);
- addBuilder("list-item-body", StandardStructureTypes.List.LBODY);
- addBuilder("list-item-label", StandardStructureTypes.List.LBL);
- // Dynamic Effects: Link and Multi Formatting Objects
- addBuilder("basic-link", StandardStructureTypes.InlineLevelStructure.LINK);
- // Out-of-Line Formatting Objects
- addBuilder("float", StandardStructureTypes.Grouping.DIV);
- addBuilder("footnote", StandardStructureTypes.InlineLevelStructure.NOTE);
- addBuilder("footnote-body", StandardStructureTypes.Grouping.SECT);
- addBuilder("wrapper", StandardStructureTypes.InlineLevelStructure.SPAN);
- addBuilder("marker", StandardStructureTypes.Grouping.PRIVATE);
-
- addBuilder("#PCDATA", new PlaceholderBuilder());
- }
-
- private static void addBuilder(String fo, StructureType structureType) {
- addBuilder(fo, new DefaultStructureElementBuilder(structureType));
- }
-
- private static void addBuilder(String fo, StructureElementBuilder mapper) {
- BUILDERS.put(fo, mapper);
- }
-
- private interface StructureElementBuilder {
-
- PDFStructElem build(StructureHierarchyMember parent, Attributes attributes, PDFFactory pdfFactory,
- EventBroadcaster eventBroadcaster);
-
- }
-
- private static class DefaultStructureElementBuilder implements StructureElementBuilder {
-
- private final StructureType defaultStructureType;
-
- DefaultStructureElementBuilder(StructureType structureType) {
- this.defaultStructureType = structureType;
- }
-
- public final PDFStructElem build(StructureHierarchyMember parent, Attributes attributes,
- PDFFactory pdfFactory, EventBroadcaster eventBroadcaster) {
- String role = attributes.getValue(ROLE);
- StructureType structureType;
- if (role == null) {
- structureType = defaultStructureType;
- } else {
- structureType = StandardStructureTypes.get(role);
- if (structureType == null) {
- structureType = defaultStructureType;
- PDFEventProducer.Provider.get(eventBroadcaster).nonStandardStructureType(role, role,
- structureType.toString());
- }
- }
- PDFStructElem structElem = createStructureElement(parent, structureType);
- setAttributes(structElem, attributes);
- addKidToParent(structElem, parent, attributes);
- registerStructureElement(structElem, pdfFactory, attributes);
- return structElem;
- }
-
- protected PDFStructElem createStructureElement(StructureHierarchyMember parent,
- StructureType structureType) {
- return new PDFStructElem(parent, structureType);
- }
-
- protected void setAttributes(PDFStructElem structElem, Attributes attributes) {
- }
-
- protected void addKidToParent(PDFStructElem kid, StructureHierarchyMember parent,
- Attributes attributes) {
- parent.addKid(kid);
- }
-
- protected void registerStructureElement(PDFStructElem structureElement, PDFFactory pdfFactory,
- Attributes attributes) {
- pdfFactory.getDocument().registerStructureElement(structureElement);
- }
-
- }
-
- private static class PageSequenceBuilder extends DefaultStructureElementBuilder {
-
- PageSequenceBuilder() {
- super(StandardStructureTypes.Grouping.PART);
- }
-
- @Override
- protected PDFStructElem createStructureElement(StructureHierarchyMember parent,
- StructureType structureType) {
- return new PageSequenceStructElem(parent, structureType);
- }
-
- }
-
- private static class RegionBuilder extends DefaultStructureElementBuilder {
-
- RegionBuilder() {
- super(StandardStructureTypes.Grouping.SECT);
- }
-
- @Override
- protected void addKidToParent(PDFStructElem kid, StructureHierarchyMember parent,
- Attributes attributes) {
- String flowName = attributes.getValue(Flow.FLOW_NAME);
- ((PageSequenceStructElem) parent).addContent(flowName, kid);
- }
-
- }
-
- private static class ImageBuilder extends DefaultStructureElementBuilder {
-
- ImageBuilder() {
- super(StandardStructureTypes.Illustration.FIGURE);
- }
-
- @Override
- protected void setAttributes(PDFStructElem structElem, Attributes attributes) {
- String altTextNode = attributes.getValue(ExtensionElementMapping.URI, "alt-text");
- if (altTextNode == null) {
- altTextNode = "No alternate text specified";
- }
- structElem.put("Alt", altTextNode);
- }
-
- }
-
- private static class TableBuilder extends DefaultStructureElementBuilder {
-
- TableBuilder() {
- super(StandardStructureTypes.Table.TABLE);
- }
-
- @Override
- protected PDFStructElem createStructureElement(StructureHierarchyMember parent,
- StructureType structureType) {
- return new TableStructElem(parent, structureType);
- }
- }
-
- private static class TableFooterBuilder extends DefaultStructureElementBuilder {
-
- public TableFooterBuilder() {
- super(StandardStructureTypes.Table.TFOOT);
- }
-
- @Override
- protected void addKidToParent(PDFStructElem kid, StructureHierarchyMember parent,
- Attributes attributes) {
- ((TableStructElem) parent).addTableFooter(kid);
- }
- }
-
- private static class TableCellBuilder extends DefaultStructureElementBuilder {
-
- TableCellBuilder() {
- super(StandardStructureTypes.Table.TD);
- }
-
- @Override
- protected void registerStructureElement(PDFStructElem structureElement, PDFFactory pdfFactory,
- Attributes attributes) {
- if (structureElement.getStructureType() == Table.TH) {
- String scopeAttribute = attributes.getValue(InternalElementMapping.URI,
- InternalElementMapping.SCOPE);
- Scope scope = (scopeAttribute == null)
- ? Scope.COLUMN
- : Scope.valueOf(scopeAttribute.toUpperCase(Locale.ENGLISH));
- pdfFactory.getDocument().registerStructureElement(structureElement, scope);
- } else {
- pdfFactory.getDocument().registerStructureElement(structureElement);
- }
- }
-
- @Override
- protected void setAttributes(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));
- }
- }
-
- }
-
- private static class PlaceholderBuilder implements StructureElementBuilder {
-
- public PDFStructElem build(StructureHierarchyMember parent, Attributes attributes,
- PDFFactory pdfFactory, EventBroadcaster eventBroadcaster) {
- PDFStructElem elem = new PDFStructElem.Placeholder(parent);
- parent.addKid(elem);
- return elem;
- }
-
- }
-
- private PDFFactory pdfFactory;
-
- private EventBroadcaster eventBroadcaster;
-
- private LinkedList<PDFStructElem> ancestors = new LinkedList<PDFStructElem>();
-
- private PDFStructElem rootStructureElement;
-
- void setPdfFactory(PDFFactory pdfFactory) {
- this.pdfFactory = pdfFactory;
- }
-
- void setEventBroadcaster(EventBroadcaster eventBroadcaster) {
- this.eventBroadcaster = eventBroadcaster;
- }
-
- void setLogicalStructureHandler(PDFLogicalStructureHandler logicalStructureHandler) {
- createRootStructureElement(logicalStructureHandler);
- }
-
- private void createRootStructureElement(PDFLogicalStructureHandler logicalStructureHandler) {
- assert rootStructureElement == null;
- PDFParentTree parentTree = logicalStructureHandler.getParentTree();
- PDFStructTreeRoot structTreeRoot = pdfFactory.getDocument().makeStructTreeRoot(parentTree);
- rootStructureElement = createStructureElement("root", structTreeRoot,
- new AttributesImpl(), pdfFactory, eventBroadcaster);
- }
-
- private static PDFStructElem createStructureElement(String name, StructureHierarchyMember parent,
- Attributes attributes, PDFFactory pdfFactory, EventBroadcaster eventBroadcaster) {
- StructureElementBuilder builder = BUILDERS.get(name);
- if (builder == null) {
- // TODO is a fallback really necessary?
- builder = DEFAULT_BUILDER;
- }
- return builder.build(parent, attributes, pdfFactory, eventBroadcaster);
- }
-
- public void startPageSequence(Locale language, String role) {
- ancestors = new LinkedList<PDFStructElem>();
- AttributesImpl attributes = new AttributesImpl();
- attributes.addAttribute("", ROLE, ROLE, XMLUtil.CDATA, role);
- PDFStructElem structElem = createStructureElement("page-sequence",
- rootStructureElement, attributes, pdfFactory, eventBroadcaster);
- if (language != null) {
- structElem.setLanguage(language);
- }
- ancestors.add(structElem);
- }
-
- public void endPageSequence() {
- }
-
- public StructureTreeElement startNode(String name, Attributes attributes) {
- PDFStructElem parent = ancestors.getFirst();
- PDFStructElem structElem = createStructureElement(name, parent, attributes,
- pdfFactory, eventBroadcaster);
- ancestors.addFirst(structElem);
- return structElem;
- }
-
- public void endNode(String name) {
- ancestors.removeFirst();
- }
-
- public StructureTreeElement startImageNode(String name, Attributes attributes) {
- return startNode(name, attributes);
- }
-
- public StructureTreeElement startReferencedNode(String name, Attributes attributes) {
- return startNode(name, attributes);
- }
-
- }
|