001/* 002 * $Id: PdfStructureElement.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 com.itextpdf.text.error_messages.MessageLocalization; 047 048/** 049 * This is a node in a document logical structure. It may contain a mark point or it may contain 050 * other nodes. 051 * @author Paulo Soares 052 */ 053public class PdfStructureElement extends PdfDictionary { 054 055 /** 056 * Holds value of property kids. 057 */ 058 private PdfStructureElement parent; 059 private PdfStructureTreeRoot top; 060 061 /** 062 * Holds value of property reference. 063 */ 064 private PdfIndirectReference reference; 065 066 /** 067 * Creates a new instance of PdfStructureElement. 068 * @param parent the parent of this node 069 * @param structureType the type of structure. It may be a standard type or a user type mapped by the role map 070 */ 071 public PdfStructureElement(PdfStructureElement parent, PdfName structureType) { 072 top = parent.top; 073 init(parent, structureType); 074 this.parent = parent; 075 put(PdfName.P, parent.reference); 076 put(PdfName.TYPE, PdfName.STRUCTELEM); 077 } 078 079 /** 080 * Creates a new instance of PdfStructureElement. 081 * @param parent the parent of this node 082 * @param structureType the type of structure. It may be a standard type or a user type mapped by the role map 083 */ 084 public PdfStructureElement(PdfStructureTreeRoot parent, PdfName structureType) { 085 top = parent; 086 init(parent, structureType); 087 put(PdfName.P, parent.getReference()); 088 put(PdfName.TYPE, PdfName.STRUCTELEM); 089 } 090 091 private void init(PdfDictionary parent, PdfName structureType) { 092 PdfObject kido = parent.get(PdfName.K); 093 PdfArray kids = null; 094 if (kido != null && !kido.isArray()) 095 throw new IllegalArgumentException(MessageLocalization.getComposedMessage("the.parent.has.already.another.function")); 096 if (kido == null) { 097 kids = new PdfArray(); 098 parent.put(PdfName.K, kids); 099 } 100 else 101 kids = (PdfArray)kido; 102 kids.add(this); 103 put(PdfName.S, structureType); 104 reference = top.getWriter().getPdfIndirectReference(); 105 } 106 107 /** 108 * Gets the parent of this node. 109 * @return the parent of this node 110 */ 111 public PdfDictionary getParent() { 112 return parent; 113 } 114 115 void setPageMark(int page, int mark) { 116 if (mark >= 0) 117 put(PdfName.K, new PdfNumber(mark)); 118 top.setPageMark(page, reference); 119 } 120 121 /** 122 * Gets the reference this object will be written to. 123 * @return the reference this object will be written to 124 * @since 2.1.6 method removed in 2.1.5, but restored in 2.1.6 125 */ 126 public PdfIndirectReference getReference() { 127 return this.reference; 128 } 129}