2
* $Id: PdfStructureElement.java,v 1.3 2005/11/01 12:27:05 psoares33 Exp $
4
* Copyright 2005 by Paulo Soares.
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/
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.
14
* The Original Code is 'iText, a free JAVA-PDF library'.
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.
22
* Contributor(s): all the names of the contributors are added in the source code
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.
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.
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
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/
50
package com.lowagie.text.pdf;
53
* This is a node in a document logical structure. It may contain a mark point or it may contain
55
* @author Paulo Soares (psoares@consiste.pt)
57
public class PdfStructureElement extends PdfDictionary {
60
* Holds value of property kids.
62
private PdfStructureElement parent;
63
private PdfStructureTreeRoot top;
66
* Holds value of property reference.
68
private PdfIndirectReference reference;
71
* Creates a new instance of PdfStructureElement.
72
* @param parent the parent of this node
73
* @param structureType the type of structure. It may be a standard type or a user type mapped by the role map
75
public PdfStructureElement(PdfStructureElement parent, PdfName structureType) {
77
init(parent, structureType);
79
put(PdfName.P, parent.reference);
83
* Creates a new instance of PdfStructureElement.
84
* @param parent the parent of this node
85
* @param structureType the type of structure. It may be a standard type or a user type mapped by the role map
87
public PdfStructureElement(PdfStructureTreeRoot parent, PdfName structureType) {
89
init(parent, structureType);
90
put(PdfName.P, parent.getReference());
93
private void init(PdfDictionary parent, PdfName structureType) {
94
PdfObject kido = parent.get(PdfName.K);
96
if (kido != null && !kido.isArray())
97
throw new IllegalArgumentException("The parent has already another function.");
99
kids = new PdfArray();
100
parent.put(PdfName.K, kids);
103
kids = (PdfArray)kido;
105
put(PdfName.S, structureType);
106
reference = top.getWriter().getPdfIndirectReference();
110
* Gets the parent of this node.
111
* @return the parent of this node
113
public PdfDictionary getParent() {
117
void setPageMark(int page, int mark) {
119
put(PdfName.K, new PdfNumber(mark));
120
top.setPageMark(page, reference);
124
* Gets the reference this object will be written to.
125
* @return the reference this object will be written to
127
public PdfIndirectReference getReference() {
128
return this.reference;