001: /*
002: * $Id: PdfStructureElement.java 2026 2005-11-01 12:27:05Z psoares33 $
003: *
004: * Copyright 2005 by Paulo Soares.
005: *
006: * The contents of this file are subject to the Mozilla Public License Version 1.1
007: * (the "License"); you may not use this file except in compliance with the License.
008: * You may obtain a copy of the License at http://www.mozilla.org/MPL/
009: *
010: * Software distributed under the License is distributed on an "AS IS" basis,
011: * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
012: * for the specific language governing rights and limitations under the License.
013: *
014: * The Original Code is 'iText, a free JAVA-PDF library'.
015: *
016: * The Initial Developer of the Original Code is Bruno Lowagie. Portions created by
017: * the Initial Developer are Copyright (C) 1999, 2000, 2001, 2002 by Bruno Lowagie.
018: * All Rights Reserved.
019: * Co-Developer of the code is Paulo Soares. Portions created by the Co-Developer
020: * are Copyright (C) 2000, 2001, 2002 by Paulo Soares. All Rights Reserved.
021: *
022: * Contributor(s): all the names of the contributors are added in the source code
023: * where applicable.
024: *
025: * Alternatively, the contents of this file may be used under the terms of the
026: * LGPL license (the "GNU LIBRARY GENERAL PUBLIC LICENSE"), in which case the
027: * provisions of LGPL are applicable instead of those above. If you wish to
028: * allow use of your version of this file only under the terms of the LGPL
029: * License and not to allow others to use your version of this file under
030: * the MPL, indicate your decision by deleting the provisions above and
031: * replace them with the notice and other provisions required by the LGPL.
032: * If you do not delete the provisions above, a recipient may use your version
033: * of this file under either the MPL or the GNU LIBRARY GENERAL PUBLIC LICENSE.
034: *
035: * This library is free software; you can redistribute it and/or modify it
036: * under the terms of the MPL as stated above or under the terms of the GNU
037: * Library General Public License as published by the Free Software Foundation;
038: * either version 2 of the License, or any later version.
039: *
040: * This library is distributed in the hope that it will be useful, but WITHOUT
041: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
042: * FOR A PARTICULAR PURPOSE. See the GNU Library general Public License for more
043: * details.
044: *
045: * If you didn't download this code from the following link, you should check if
046: * you aren't using an obsolete version:
047: * http://www.lowagie.com/iText/
048: */
049:
050: package com.lowagie.text.pdf;
051:
052: /**
053: * This is a node in a document logical structure. It may contain a mark point or it may contain
054: * other nodes.
055: * @author Paulo Soares (psoares@consiste.pt)
056: */
057: public class PdfStructureElement extends PdfDictionary {
058:
059: /**
060: * Holds value of property kids.
061: */
062: private PdfStructureElement parent;
063: private PdfStructureTreeRoot top;
064:
065: /**
066: * Holds value of property reference.
067: */
068: private PdfIndirectReference reference;
069:
070: /**
071: * Creates a new instance of PdfStructureElement.
072: * @param parent the parent of this node
073: * @param structureType the type of structure. It may be a standard type or a user type mapped by the role map
074: */
075: public PdfStructureElement(PdfStructureElement parent,
076: PdfName structureType) {
077: top = parent.top;
078: init(parent, structureType);
079: this .parent = parent;
080: put(PdfName.P, parent.reference);
081: }
082:
083: /**
084: * Creates a new instance of PdfStructureElement.
085: * @param parent the parent of this node
086: * @param structureType the type of structure. It may be a standard type or a user type mapped by the role map
087: */
088: public PdfStructureElement(PdfStructureTreeRoot parent,
089: PdfName structureType) {
090: top = parent;
091: init(parent, structureType);
092: put(PdfName.P, parent.getReference());
093: }
094:
095: private void init(PdfDictionary parent, PdfName structureType) {
096: PdfObject kido = parent.get(PdfName.K);
097: PdfArray kids = null;
098: if (kido != null && !kido.isArray())
099: throw new IllegalArgumentException(
100: "The parent has already another function.");
101: if (kido == null) {
102: kids = new PdfArray();
103: parent.put(PdfName.K, kids);
104: } else
105: kids = (PdfArray) kido;
106: kids.add(this );
107: put(PdfName.S, structureType);
108: reference = top.getWriter().getPdfIndirectReference();
109: }
110:
111: /**
112: * Gets the parent of this node.
113: * @return the parent of this node
114: */
115: public PdfDictionary getParent() {
116: return parent;
117: }
118:
119: void setPageMark(int page, int mark) {
120: if (mark >= 0)
121: put(PdfName.K, new PdfNumber(mark));
122: top.setPageMark(page, reference);
123: }
124:
125: /**
126: * Gets the reference this object will be written to.
127: * @return the reference this object will be written to
128: */
129: public PdfIndirectReference getReference() {
130: return this.reference;
131: }
132: }
|