com.lowagie.text.pdf.PdfStructureElement Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of itext2 Show documentation
Show all versions of itext2 Show documentation
Itext is a java library to create and manipulate PDFs.
This is a fork of version 2.1.7 the last MPL/LGPL version.
It's focused basically on mantain compatibility with newer bouncycastle releases and small bugfixes.
/*
* $Id: PdfStructureElement.java 3914 2009-04-26 09:16:47Z blowagie $
*
* Copyright 2005 by Paulo Soares.
*
* The contents of this file are subject to the Mozilla Public License Version 1.1
* (the "License"); you may not use this file except in compliance with the License.
* You may obtain a copy of the License at http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the License.
*
* The Original Code is 'iText, a free JAVA-PDF library'.
*
* The Initial Developer of the Original Code is Bruno Lowagie. Portions created by
* the Initial Developer are Copyright (C) 1999, 2000, 2001, 2002 by Bruno Lowagie.
* All Rights Reserved.
* Co-Developer of the code is Paulo Soares. Portions created by the Co-Developer
* are Copyright (C) 2000, 2001, 2002 by Paulo Soares. All Rights Reserved.
*
* Contributor(s): all the names of the contributors are added in the source code
* where applicable.
*
* Alternatively, the contents of this file may be used under the terms of the
* LGPL license (the "GNU LIBRARY GENERAL PUBLIC LICENSE"), in which case the
* provisions of LGPL are applicable instead of those above. If you wish to
* allow use of your version of this file only under the terms of the LGPL
* License and not to allow others to use your version of this file under
* the MPL, indicate your decision by deleting the provisions above and
* replace them with the notice and other provisions required by the LGPL.
* If you do not delete the provisions above, a recipient may use your version
* of this file under either the MPL or the GNU LIBRARY GENERAL PUBLIC LICENSE.
*
* This library is free software; you can redistribute it and/or modify it
* under the terms of the MPL as stated above or under the terms of the GNU
* Library General Public License as published by the Free Software Foundation;
* either version 2 of the License, or any later version.
*
* This library is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Library general Public License for more
* details.
*
* If you didn't download this code from the following link, you should check if
* you aren't using an obsolete version:
* http://www.lowagie.com/iText/
*/
package com.lowagie.text.pdf;
/**
* This is a node in a document logical structure. It may contain a mark point or it may contain
* other nodes.
* @author Paulo Soares ([email protected])
*/
public class PdfStructureElement extends PdfDictionary {
/**
* Holds value of property kids.
*/
private PdfStructureElement parent;
private PdfStructureTreeRoot top;
/**
* Holds value of property reference.
*/
private PdfIndirectReference reference;
/**
* Creates a new instance of PdfStructureElement.
* @param parent the parent of this node
* @param structureType the type of structure. It may be a standard type or a user type mapped by the role map
*/
public PdfStructureElement(PdfStructureElement parent, PdfName structureType) {
top = parent.top;
init(parent, structureType);
this.parent = parent;
put(PdfName.P, parent.reference);
}
/**
* Creates a new instance of PdfStructureElement.
* @param parent the parent of this node
* @param structureType the type of structure. It may be a standard type or a user type mapped by the role map
*/
public PdfStructureElement(PdfStructureTreeRoot parent, PdfName structureType) {
top = parent;
init(parent, structureType);
put(PdfName.P, parent.getReference());
}
private void init(PdfDictionary parent, PdfName structureType) {
PdfObject kido = parent.get(PdfName.K);
PdfArray kids = null;
if (kido != null && !kido.isArray())
throw new IllegalArgumentException("The parent has already another function.");
if (kido == null) {
kids = new PdfArray();
parent.put(PdfName.K, kids);
}
else
kids = (PdfArray)kido;
kids.add(this);
put(PdfName.S, structureType);
reference = top.getWriter().getPdfIndirectReference();
}
/**
* Gets the parent of this node.
* @return the parent of this node
*/
public PdfDictionary getParent() {
return parent;
}
void setPageMark(int page, int mark) {
if (mark >= 0)
put(PdfName.K, new PdfNumber(mark));
top.setPageMark(page, reference);
}
/**
* Gets the reference this object will be written to.
* @return the reference this object will be written to
* @since 2.1.6 method removed in 2.1.5, but restored in 2.1.6
*/
public PdfIndirectReference getReference() {
return this.reference;
}
}