|
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575 |
- /*
- * 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.accessibility.fo;
-
- import java.util.HashMap;
- import java.util.Map;
- import java.util.Stack;
-
- import org.xml.sax.SAXException;
-
- import org.apache.fop.accessibility.Accessibility;
- import org.apache.fop.accessibility.StructureTreeEventHandler;
- import org.apache.fop.fo.DelegatingFOEventHandler;
- import org.apache.fop.fo.FOEventHandler;
- import org.apache.fop.fo.FOText;
- import org.apache.fop.fo.extensions.ExternalDocument;
- import org.apache.fop.fo.flow.AbstractRetrieveMarker;
- import org.apache.fop.fo.flow.BasicLink;
- import org.apache.fop.fo.flow.Block;
- import org.apache.fop.fo.flow.BlockContainer;
- import org.apache.fop.fo.flow.Character;
- import org.apache.fop.fo.flow.ExternalGraphic;
- import org.apache.fop.fo.flow.Footnote;
- import org.apache.fop.fo.flow.FootnoteBody;
- import org.apache.fop.fo.flow.Inline;
- import org.apache.fop.fo.flow.InstreamForeignObject;
- import org.apache.fop.fo.flow.Leader;
- import org.apache.fop.fo.flow.ListBlock;
- import org.apache.fop.fo.flow.ListItem;
- import org.apache.fop.fo.flow.ListItemBody;
- import org.apache.fop.fo.flow.ListItemLabel;
- import org.apache.fop.fo.flow.PageNumber;
- import org.apache.fop.fo.flow.PageNumberCitation;
- import org.apache.fop.fo.flow.PageNumberCitationLast;
- import org.apache.fop.fo.flow.RetrieveMarker;
- import org.apache.fop.fo.flow.RetrieveTableMarker;
- import org.apache.fop.fo.flow.Wrapper;
- import org.apache.fop.fo.flow.table.Table;
- import org.apache.fop.fo.flow.table.TableBody;
- import org.apache.fop.fo.flow.table.TableCell;
- import org.apache.fop.fo.flow.table.TableColumn;
- import org.apache.fop.fo.flow.table.TableFooter;
- import org.apache.fop.fo.flow.table.TableHeader;
- import org.apache.fop.fo.flow.table.TableRow;
- import org.apache.fop.fo.pagination.Flow;
- import org.apache.fop.fo.pagination.PageSequence;
- import org.apache.fop.fo.pagination.Root;
- import org.apache.fop.fo.pagination.StaticContent;
- import org.apache.fop.fo.properties.CommonAccessibility;
- import org.apache.fop.fo.properties.CommonAccessibilityHolder;
-
- /**
- * Allows to create the structure tree of an FO document, by converting FO
- * events into appropriate structure tree events.
- */
- public class FO2StructureTreeConverter extends DelegatingFOEventHandler {
-
- /** The top of the {@link converters} stack. */
- private FOEventHandler converter;
-
- private Stack<FOEventHandler> converters = new Stack<FOEventHandler>();
-
- private final StructureTreeEventTrigger structureTreeEventTrigger;
-
- /** The descendants of some elements like fo:leader must be ignored. */
- private final FOEventHandler eventSwallower = new FOEventHandler() {
- };
-
- private final Map<AbstractRetrieveMarker, State> states = new HashMap<AbstractRetrieveMarker, State>();
-
- private static final class State {
-
- private final FOEventHandler converter;
-
- private final Stack<FOEventHandler> converters;
-
- @SuppressWarnings("unchecked")
- State(FO2StructureTreeConverter o) {
- this.converter = o.converter;
- this.converters = (Stack<FOEventHandler>) o.converters.clone();
- }
-
- }
-
- /**
- * Creates a new instance.
- *
- * @param structureTreeEventHandler the object that will hold the structure tree
- * @param delegate the FO event handler that must be wrapped by this instance
- */
- public FO2StructureTreeConverter(StructureTreeEventHandler structureTreeEventHandler,
- FOEventHandler delegate) {
- super(delegate);
- this.structureTreeEventTrigger = new StructureTreeEventTrigger(structureTreeEventHandler);
- this.converter = structureTreeEventTrigger;
- }
-
- @Override
- public void startDocument() throws SAXException {
- converter.startDocument();
- super.startDocument();
- }
-
- @Override
- public void endDocument() throws SAXException {
- converter.endDocument();
- super.endDocument();
- }
-
- @Override
- public void startRoot(Root root) {
- converter.startRoot(root);
- super.startRoot(root);
- }
-
- @Override
- public void endRoot(Root root) {
- converter.endRoot(root);
- super.endRoot(root);
- }
-
- @Override
- public void startPageSequence(PageSequence pageSeq) {
- converter.startPageSequence(pageSeq);
- super.startPageSequence(pageSeq);
- }
-
- @Override
- public void endPageSequence(PageSequence pageSeq) {
- converter.endPageSequence(pageSeq);
- super.endPageSequence(pageSeq);
- }
-
- @Override
- public void startPageNumber(PageNumber pagenum) {
- converter.startPageNumber(pagenum);
- super.startPageNumber(pagenum);
- }
-
- @Override
- public void endPageNumber(PageNumber pagenum) {
- converter.endPageNumber(pagenum);
- super.endPageNumber(pagenum);
- }
-
- @Override
- public void startPageNumberCitation(PageNumberCitation pageCite) {
- converter.startPageNumberCitation(pageCite);
- super.startPageNumberCitation(pageCite);
- }
-
- @Override
- public void endPageNumberCitation(PageNumberCitation pageCite) {
- converter.endPageNumberCitation(pageCite);
- super.endPageNumberCitation(pageCite);
- }
-
- @Override
- public void startPageNumberCitationLast(PageNumberCitationLast pageLast) {
- converter.startPageNumberCitationLast(pageLast);
- super.startPageNumberCitationLast(pageLast);
- }
-
- @Override
- public void endPageNumberCitationLast(PageNumberCitationLast pageLast) {
- converter.endPageNumberCitationLast(pageLast);
- super.endPageNumberCitationLast(pageLast);
- }
-
- @Override
- public void startStatic(StaticContent staticContent) {
- handleStartArtifact(staticContent);
- converter.startStatic(staticContent);
- super.startStatic(staticContent);
- }
-
- @Override
- public void endStatic(StaticContent staticContent) {
- converter.endStatic(staticContent);
- handleEndArtifact(staticContent);
- super.endStatic(staticContent);
- }
-
- @Override
- public void startFlow(Flow fl) {
- converter.startFlow(fl);
- super.startFlow(fl);
- }
-
- @Override
- public void endFlow(Flow fl) {
- converter.endFlow(fl);
- super.endFlow(fl);
- }
-
- @Override
- public void startBlock(Block bl) {
- converter.startBlock(bl);
- super.startBlock(bl);
- }
-
- @Override
- public void endBlock(Block bl) {
- converter.endBlock(bl);
- super.endBlock(bl);
- }
-
- @Override
- public void startBlockContainer(BlockContainer blc) {
- converter.startBlockContainer(blc);
- super.startBlockContainer(blc);
- }
-
- @Override
- public void endBlockContainer(BlockContainer blc) {
- converter.endBlockContainer(blc);
- super.endBlockContainer(blc);
- }
-
- @Override
- public void startInline(Inline inl) {
- converter.startInline(inl);
- super.startInline(inl);
- }
-
- @Override
- public void endInline(Inline inl) {
- converter.endInline(inl);
- super.endInline(inl);
- }
-
- @Override
- public void startTable(Table tbl) {
- converter.startTable(tbl);
- super.startTable(tbl);
- }
-
- @Override
- public void endTable(Table tbl) {
- converter.endTable(tbl);
- super.endTable(tbl);
- }
-
- @Override
- public void startColumn(TableColumn tc) {
- converter.startColumn(tc);
- super.startColumn(tc);
- }
-
- @Override
- public void endColumn(TableColumn tc) {
- converter.endColumn(tc);
- super.endColumn(tc);
- }
-
- @Override
- public void startHeader(TableHeader header) {
- converter.startHeader(header);
- super.startHeader(header);
- }
-
- @Override
- public void endHeader(TableHeader header) {
- converter.endHeader(header);
- super.endHeader(header);
- }
-
- @Override
- public void startFooter(TableFooter footer) {
- converter.startFooter(footer);
- super.startFooter(footer);
- }
-
- @Override
- public void endFooter(TableFooter footer) {
- converter.endFooter(footer);
- super.endFooter(footer);
- }
-
- @Override
- public void startBody(TableBody body) {
- converter.startBody(body);
- super.startBody(body);
- }
-
- @Override
- public void endBody(TableBody body) {
- converter.endBody(body);
- super.endBody(body);
- }
-
- @Override
- public void startRow(TableRow tr) {
- converter.startRow(tr);
- super.startRow(tr);
- }
-
- @Override
- public void endRow(TableRow tr) {
- converter.endRow(tr);
- super.endRow(tr);
- }
-
- @Override
- public void startCell(TableCell tc) {
- converter.startCell(tc);
- super.startCell(tc);
- }
-
- @Override
- public void endCell(TableCell tc) {
- converter.endCell(tc);
- super.endCell(tc);
- }
-
- @Override
- public void startList(ListBlock lb) {
- converter.startList(lb);
- super.startList(lb);
- }
-
- @Override
- public void endList(ListBlock lb) {
- converter.endList(lb);
- super.endList(lb);
- }
-
- @Override
- public void startListItem(ListItem li) {
- converter.startListItem(li);
- super.startListItem(li);
- }
-
- @Override
- public void endListItem(ListItem li) {
- converter.endListItem(li);
- super.endListItem(li);
- }
-
- @Override
- public void startListLabel(ListItemLabel listItemLabel) {
- converter.startListLabel(listItemLabel);
- super.startListLabel(listItemLabel);
- }
-
- @Override
- public void endListLabel(ListItemLabel listItemLabel) {
- converter.endListLabel(listItemLabel);
- super.endListLabel(listItemLabel);
- }
-
- @Override
- public void startListBody(ListItemBody listItemBody) {
- converter.startListBody(listItemBody);
- super.startListBody(listItemBody);
- }
-
- @Override
- public void endListBody(ListItemBody listItemBody) {
- converter.endListBody(listItemBody);
- super.endListBody(listItemBody);
- }
-
- @Override
- public void startMarkup() {
- converter.startMarkup();
- super.startMarkup();
- }
-
- @Override
- public void endMarkup() {
- converter.endMarkup();
- super.endMarkup();
- }
-
- @Override
- public void startLink(BasicLink basicLink) {
- converter.startLink(basicLink);
- super.startLink(basicLink);
- }
-
- @Override
- public void endLink(BasicLink basicLink) {
- converter.endLink(basicLink);
- super.endLink(basicLink);
- }
-
- @Override
- public void image(ExternalGraphic eg) {
- converter.image(eg);
- super.image(eg);
- }
-
- @Override
- public void pageRef() {
- converter.pageRef();
- super.pageRef();
- }
-
- @Override
- public void startInstreamForeignObject(InstreamForeignObject ifo) {
- converter.startInstreamForeignObject(ifo);
- super.startInstreamForeignObject(ifo);
- }
-
- @Override
- public void endInstreamForeignObject(InstreamForeignObject ifo) {
- converter.endInstreamForeignObject(ifo);
- super.endInstreamForeignObject(ifo);
- }
-
- @Override
- public void startFootnote(Footnote footnote) {
- converter.startFootnote(footnote);
- super.startFootnote(footnote);
- }
-
- @Override
- public void endFootnote(Footnote footnote) {
- converter.endFootnote(footnote);
- super.endFootnote(footnote);
- }
-
- @Override
- public void startFootnoteBody(FootnoteBody body) {
- converter.startFootnoteBody(body);
- super.startFootnoteBody(body);
- }
-
- @Override
- public void endFootnoteBody(FootnoteBody body) {
- converter.endFootnoteBody(body);
- super.endFootnoteBody(body);
- }
-
- @Override
- public void startLeader(Leader l) {
- converters.push(converter);
- converter = eventSwallower;
- converter.startLeader(l);
- super.startLeader(l);
- }
-
- @Override
- public void endLeader(Leader l) {
- converter.endLeader(l);
- converter = converters.pop();
- super.endLeader(l);
- }
-
- @Override
- public void startWrapper(Wrapper wrapper) {
- handleStartArtifact(wrapper);
- converter.startWrapper(wrapper);
- super.startWrapper(wrapper);
- }
-
- @Override
- public void endWrapper(Wrapper wrapper) {
- converter.endWrapper(wrapper);
- handleEndArtifact(wrapper);
- super.endWrapper(wrapper);
- }
-
- @Override
- public void startRetrieveMarker(RetrieveMarker retrieveMarker) {
- converter.startRetrieveMarker(retrieveMarker);
- saveState(retrieveMarker);
- super.startRetrieveMarker(retrieveMarker);
- }
-
- private void saveState(AbstractRetrieveMarker retrieveMarker) {
- states.put(retrieveMarker, new State(this));
- }
-
- @Override
- public void endRetrieveMarker(RetrieveMarker retrieveMarker) {
- converter.endRetrieveMarker(retrieveMarker);
- super.endRetrieveMarker(retrieveMarker);
- }
-
- @Override
- public void restoreState(RetrieveMarker retrieveMarker) {
- restoreRetrieveMarkerState(retrieveMarker);
- converter.restoreState(retrieveMarker);
- super.restoreState(retrieveMarker);
- }
-
- @SuppressWarnings("unchecked")
- private void restoreRetrieveMarkerState(AbstractRetrieveMarker retrieveMarker) {
- State state = states.get(retrieveMarker);
- this.converter = state.converter;
- this.converters = (Stack<FOEventHandler>) state.converters.clone();
- }
-
- @Override
- public void startRetrieveTableMarker(RetrieveTableMarker retrieveTableMarker) {
- converter.startRetrieveTableMarker(retrieveTableMarker);
- saveState(retrieveTableMarker);
- super.startRetrieveTableMarker(retrieveTableMarker);
- }
-
- @Override
- public void endRetrieveTableMarker(RetrieveTableMarker retrieveTableMarker) {
- converter.endRetrieveTableMarker(retrieveTableMarker);
- super.endRetrieveTableMarker(retrieveTableMarker);
- }
-
- @Override
- public void restoreState(RetrieveTableMarker retrieveTableMarker) {
- restoreRetrieveMarkerState(retrieveTableMarker);
- converter.restoreState(retrieveTableMarker);
- super.restoreState(retrieveTableMarker);
- }
-
- @Override
- public void character(Character c) {
- converter.character(c);
- super.character(c);
- }
-
- @Override
- public void characters(FOText foText) {
- converter.characters(foText);
- super.characters(foText);
- }
-
- @Override
- public void startExternalDocument(ExternalDocument document) {
- converter.startExternalDocument(document);
- super.startExternalDocument(document);
- }
-
- @Override
- public void endExternalDocument(ExternalDocument document) {
- converter.endExternalDocument(document);
- super.endExternalDocument(document);
- }
-
- private void handleStartArtifact(CommonAccessibilityHolder fobj) {
- if (isArtifact(fobj)) {
- converters.push(converter);
- converter = eventSwallower;
- }
- }
-
- private void handleEndArtifact(CommonAccessibilityHolder fobj) {
- if (isArtifact(fobj)) {
- converter = converters.pop();
- }
- }
-
- private boolean isArtifact(CommonAccessibilityHolder fobj) {
- CommonAccessibility accessibility = fobj.getCommonAccessibility();
- return Accessibility.ROLE_ARTIFACT.equalsIgnoreCase(accessibility.getRole());
- }
-
- }
|