Initial Commit

iTechSharp/iTextSharp/text/pdf/PdfStructureElement.cs

@@ -0,0 +1,136 @@
+using System;
+
+/*
+ * $Id: PdfStructureElement.cs,v 1.3 2005/11/02 12:24:06 psoares33 Exp $
+ *
+ * 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/
+ */
+
+namespace iTextSharp.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 (psoares@consiste.pt)
+    */
+    public class PdfStructureElement : 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.Reference);
+        }
+        
+        private void Init(PdfDictionary parent, PdfName structureType) {
+            PdfObject kido = parent.Get(PdfName.K);
+            PdfArray kids = null;
+            if (kido != null && !kido.IsArray())
+                throw new ArgumentException("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.Writer.PdfIndirectReference;
+        }
+        
+        /**
+        * Gets the parent of this node.
+        * @return the parent of this node
+        */    
+        public PdfDictionary Parent {
+            get {
+                return parent;
+            }
+        }
+        
+        internal 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
+        */    
+        public PdfIndirectReference Reference {
+            get {
+                return this.reference;
+            }
+        }
+    }
+}