KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > lowagie > text > pdf > PdfStructureTreeRoot


1 /*
2  * $Id: PdfStructureTreeRoot.java 2366 2006-09-14 23:10:58Z xlv $
3  *
4  * Copyright 2005 by Paulo Soares.
5  *
6  * The contents of this file are subject to the Mozilla Public License Version 1.1
7  * (the "License"); you may not use this file except in compliance with the License.
8  * You may obtain a copy of the License at http://www.mozilla.org/MPL/
9  *
10  * Software distributed under the License is distributed on an "AS IS" basis,
11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
12  * for the specific language governing rights and limitations under the License.
13  *
14  * The Original Code is 'iText, a free JAVA-PDF library'.
15  *
16  * The Initial Developer of the Original Code is Bruno Lowagie. Portions created by
17  * the Initial Developer are Copyright (C) 1999, 2000, 2001, 2002 by Bruno Lowagie.
18  * All Rights Reserved.
19  * Co-Developer of the code is Paulo Soares. Portions created by the Co-Developer
20  * are Copyright (C) 2000, 2001, 2002 by Paulo Soares. All Rights Reserved.
21  *
22  * Contributor(s): all the names of the contributors are added in the source code
23  * where applicable.
24  *
25  * Alternatively, the contents of this file may be used under the terms of the
26  * LGPL license (the "GNU LIBRARY GENERAL PUBLIC LICENSE"), in which case the
27  * provisions of LGPL are applicable instead of those above. If you wish to
28  * allow use of your version of this file only under the terms of the LGPL
29  * License and not to allow others to use your version of this file under
30  * the MPL, indicate your decision by deleting the provisions above and
31  * replace them with the notice and other provisions required by the LGPL.
32  * If you do not delete the provisions above, a recipient may use your version
33  * of this file under either the MPL or the GNU LIBRARY GENERAL PUBLIC LICENSE.
34  *
35  * This library is free software; you can redistribute it and/or modify it
36  * under the terms of the MPL as stated above or under the terms of the GNU
37  * Library General Public License as published by the Free Software Foundation;
38  * either version 2 of the License, or any later version.
39  *
40  * This library is distributed in the hope that it will be useful, but WITHOUT
41  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
42  * FOR A PARTICULAR PURPOSE. See the GNU Library general Public License for more
43  * details.
44  *
45  * If you didn't download this code from the following link, you should check if
46  * you aren't using an obsolete version:
47  * http://www.lowagie.com/iText/
48  */

49 package com.lowagie.text.pdf;
50
51 import java.io.IOException JavaDoc;
52 import java.util.ArrayList JavaDoc;
53 import java.util.HashMap JavaDoc;
54 import java.util.Iterator JavaDoc;
55
56 /**
57  * The structure tree root corresponds to the highest hierarchy level in a tagged PDF.
58  * @author Paulo Soares (psoares@consiste.pt)
59  */

60 public class PdfStructureTreeRoot extends PdfDictionary {
61     
62     private HashMap JavaDoc parentTree = new HashMap JavaDoc();
63     private PdfIndirectReference reference;
64
65     /**
66      * Holds value of property writer.
67      */

68     private PdfWriter writer;
69     
70     /** Creates a new instance of PdfStructureTreeRoot */
71     PdfStructureTreeRoot(PdfWriter writer) {
72         super(PdfName.STRUCTTREEROOT);
73         this.writer = writer;
74         reference = writer.getPdfIndirectReference();
75     }
76     
77     /**
78      * Maps the user tags to the standard tags. The mapping will allow a standard application to make some sense of the tagged
79      * document whatever the user tags may be.
80      * @param used the user tag
81      * @param standard the standard tag
82      */

83     public void mapRole(PdfName used, PdfName standard) {
84         PdfDictionary rm = (PdfDictionary)get(PdfName.ROLEMAP);
85         if (rm == null) {
86             rm = new PdfDictionary();
87             put(PdfName.ROLEMAP, rm);
88         }
89         rm.put(used, standard);
90     }
91     
92     /**
93      * Gets the writer.
94      * @return the writer
95      */

96     public PdfWriter getWriter() {
97         return this.writer;
98     }
99
100     /**
101      * Gets the reference this object will be written to.
102      * @return the reference this object will be written to
103      */

104     public PdfIndirectReference getReference() {
105         return this.reference;
106     }
107     
108     void setPageMark(int page, PdfIndirectReference struc) {
109         Integer JavaDoc i = new Integer JavaDoc(page);
110         PdfArray ar = (PdfArray)parentTree.get(i);
111         if (ar == null) {
112             ar = new PdfArray();
113             parentTree.put(i, ar);
114         }
115         ar.add(struc);
116     }
117     
118     private void nodeProcess(PdfDictionary struc, PdfIndirectReference reference) throws IOException JavaDoc {
119         PdfObject obj = struc.get(PdfName.K);
120         if (obj != null && obj.isArray() && !((PdfObject)((PdfArray)obj).getArrayList().get(0)).isNumber()) {
121             PdfArray ar = (PdfArray)obj;
122             ArrayList JavaDoc a = ar.getArrayList();
123             for (int k = 0; k < a.size(); ++k) {
124                 PdfStructureElement e = (PdfStructureElement)a.get(k);
125                 a.set(k, e.getReference());
126                 nodeProcess(e, e.getReference());
127             }
128         }
129         if (reference != null)
130             writer.addToBody(struc, reference);
131     }
132     
133     void buildTree() throws IOException JavaDoc {
134         HashMap JavaDoc numTree = new HashMap JavaDoc();
135         for (Iterator JavaDoc it = parentTree.keySet().iterator(); it.hasNext();) {
136             Integer JavaDoc i = (Integer JavaDoc)it.next();
137             PdfArray ar = (PdfArray)parentTree.get(i);
138             numTree.put(i, writer.addToBody(ar).getIndirectReference());
139         }
140         PdfDictionary dicTree = PdfNumberTree.writeTree(numTree, writer);
141         if (dicTree != null)
142             put(PdfName.PARENTTREE, writer.addToBody(dicTree).getIndirectReference());
143         
144         nodeProcess(this, reference);
145     }
146 }
147
Popular Tags