001/*
002 * $Id: PdfStructureTreeRoot.java 4784 2011-03-15 08:33:00Z blowagie $
003 *
004 * This file is part of the iText (R) project.
005 * Copyright (c) 1998-2011 1T3XT BVBA
006 * Authors: Bruno Lowagie, Paulo Soares, et al.
007 *
008 * This program is free software; you can redistribute it and/or modify
009 * it under the terms of the GNU Affero General Public License version 3
010 * as published by the Free Software Foundation with the addition of the
011 * following permission added to Section 15 as permitted in Section 7(a):
012 * FOR ANY PART OF THE COVERED WORK IN WHICH THE COPYRIGHT IS OWNED BY 1T3XT,
013 * 1T3XT DISCLAIMS THE WARRANTY OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
014 *
015 * This program is distributed in the hope that it will be useful, but
016 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
017 * or FITNESS FOR A PARTICULAR PURPOSE.
018 * See the GNU Affero General Public License for more details.
019 * You should have received a copy of the GNU Affero General Public License
020 * along with this program; if not, see http://www.gnu.org/licenses or write to
021 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
022 * Boston, MA, 02110-1301 USA, or download the license from the following URL:
023 * http://itextpdf.com/terms-of-use/
024 *
025 * The interactive user interfaces in modified source and object code versions
026 * of this program must display Appropriate Legal Notices, as required under
027 * Section 5 of the GNU Affero General Public License.
028 *
029 * In accordance with Section 7(b) of the GNU Affero General Public License,
030 * a covered work must retain the producer line in every PDF that is created
031 * or manipulated using iText.
032 *
033 * You can be released from the requirements of the license by purchasing
034 * a commercial license. Buying such a license is mandatory as soon as you
035 * develop commercial activities involving the iText software without
036 * disclosing the source code of your own applications.
037 * These activities include: offering paid services to customers as an ASP,
038 * serving PDFs on the fly in a web application, shipping iText with a closed
039 * source product.
040 *
041 * For more information, please contact iText Software Corp. at this
042 * address: sales@itextpdf.com
043 */
044package com.itextpdf.text.pdf;
045
046import java.io.IOException;
047import java.util.HashMap;
048
049/**
050 * The structure tree root corresponds to the highest hierarchy level in a tagged PDF.
051 * @author Paulo Soares
052 */
053public class PdfStructureTreeRoot extends PdfDictionary {
054
055    private HashMap<Integer, PdfObject> parentTree = new HashMap<Integer, PdfObject>();
056    private PdfIndirectReference reference;
057
058    /**
059     * Holds value of property writer.
060     */
061    private PdfWriter writer;
062
063    /** Creates a new instance of PdfStructureTreeRoot */
064    PdfStructureTreeRoot(PdfWriter writer) {
065        super(PdfName.STRUCTTREEROOT);
066        this.writer = writer;
067        reference = writer.getPdfIndirectReference();
068    }
069
070    /**
071     * Maps the user tags to the standard tags. The mapping will allow a standard application to make some sense of the tagged
072     * document whatever the user tags may be.
073     * @param used the user tag
074     * @param standard the standard tag
075     */
076    public void mapRole(PdfName used, PdfName standard) {
077        PdfDictionary rm = (PdfDictionary)get(PdfName.ROLEMAP);
078        if (rm == null) {
079            rm = new PdfDictionary();
080            put(PdfName.ROLEMAP, rm);
081        }
082        rm.put(used, standard);
083    }
084
085    /**
086     * Gets the writer.
087     * @return the writer
088     */
089    public PdfWriter getWriter() {
090        return this.writer;
091    }
092
093    /**
094     * Gets the reference this object will be written to.
095     * @return the reference this object will be written to
096     * @since   2.1.6 method removed in 2.1.5, but restored in 2.1.6
097     */
098    public PdfIndirectReference getReference() {
099        return this.reference;
100    }
101
102    void setPageMark(int page, PdfIndirectReference struc) {
103        Integer i = Integer.valueOf(page);
104        PdfArray ar = (PdfArray)parentTree.get(i);
105        if (ar == null) {
106            ar = new PdfArray();
107            parentTree.put(i, ar);
108        }
109        ar.add(struc);
110    }
111
112    private void nodeProcess(PdfDictionary struc, PdfIndirectReference reference) throws IOException {
113        PdfObject obj = struc.get(PdfName.K);
114        if (obj != null && obj.isArray() && !(((PdfArray)obj).getPdfObject(0)).isNumber()) {
115            PdfArray ar = (PdfArray)obj;
116            for (int k = 0; k < ar.size(); ++k) {
117                PdfStructureElement e = (PdfStructureElement)ar.getAsDict(k);
118                ar.set(k, e.getReference());
119                nodeProcess(e, e.getReference());
120            }
121        }
122        if (reference != null)
123            writer.addToBody(struc, reference);
124    }
125
126    void buildTree() throws IOException {
127        HashMap<Integer, PdfIndirectReference> numTree = new HashMap<Integer, PdfIndirectReference>();
128        for (Integer i: parentTree.keySet()) {
129            PdfArray ar = (PdfArray)parentTree.get(i);
130            numTree.put(i, writer.addToBody(ar).getIndirectReference());
131        }
132        PdfDictionary dicTree = PdfNumberTree.writeTree(numTree, writer);
133        if (dicTree != null)
134            put(PdfName.PARENTTREE, writer.addToBody(dicTree).getIndirectReference());
135
136        nodeProcess(this, reference);
137    }
138}