Click here to Skip to main content
15,897,165 members
Articles / Programming Languages / Visual Basic

Open Door - Reporting, Charts, Enquiry Drill-Downs

Rate me:
Please Sign up or sign in to vote.
4.37/5 (11 votes)
2 Feb 2009CPOL6 min read 39.5K   2K   59  
A utility for generating user editable reports, charts, documents, enquiries
using System;
using System.Collections;
using iTextSharp.text;
using iTextSharp.text.pdf;
/*
 * $Id: PdfPageEventForwarder.cs,v 1.1 2005/10/07 19:05:32 psoares33 Exp $
 * $Name:  $
 *
 * Copyright 2005 Bruno Lowagie
 *
 * 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.events {

    /**
    * If you want to add more than one page eventa to a PdfWriter,
    * you have to construct a PdfPageEventForwarder, add the
    * different events to this object and add the forwarder to
    * the PdfWriter.
    */

    public class PdfPageEventForwarder : IPdfPageEvent {

        /** ArrayList containing all the PageEvents that have to be executed. */
        protected ArrayList events = new ArrayList();
        
        /** 
        * Add a page eventa to the forwarder.
        * @param eventa an eventa that has to be added to the forwarder.
        */
        public void AddPageEvent(IPdfPageEvent eventa) {
            events.Add(eventa);
        }
        
        /**
        * Called when the document is opened.
        * 
        * @param writer
        *            the <CODE>PdfWriter</CODE> for this document
        * @param document
        *            the document
        */
        public virtual void OnOpenDocument(PdfWriter writer, Document document) {
            foreach (IPdfPageEvent eventa in events) {
                eventa.OnOpenDocument(writer, document);
            }
        }

        /**
        * Called when a page is initialized.
        * <P>
        * Note that if even if a page is not written this method is still called.
        * It is preferable to use <CODE>onEndPage</CODE> to avoid infinite loops.
        * 
        * @param writer
        *            the <CODE>PdfWriter</CODE> for this document
        * @param document
        *            the document
        */
        public virtual void OnStartPage(PdfWriter writer, Document document) {
            foreach (IPdfPageEvent eventa in events) {
                eventa.OnStartPage(writer, document);
            }
        }

        /**
        * Called when a page is finished, just before being written to the
        * document.
        * 
        * @param writer
        *            the <CODE>PdfWriter</CODE> for this document
        * @param document
        *            the document
        */
        public virtual void OnEndPage(PdfWriter writer, Document document) {
            foreach (IPdfPageEvent eventa in events) {
                eventa.OnEndPage(writer, document);
            }
        }

        /**
        * Called when the document is closed.
        * <P>
        * Note that this method is called with the page number equal to the last
        * page plus one.
        * 
        * @param writer
        *            the <CODE>PdfWriter</CODE> for this document
        * @param document
        *            the document
        */
        public virtual void OnCloseDocument(PdfWriter writer, Document document) {
            foreach (IPdfPageEvent eventa in events) {
                eventa.OnCloseDocument(writer, document);
            }
        }

        /**
        * Called when a Paragraph is written.
        * <P>
        * <CODE>paragraphPosition</CODE> will hold the height at which the
        * paragraph will be written to. This is useful to insert bookmarks with
        * more control.
        * 
        * @param writer
        *            the <CODE>PdfWriter</CODE> for this document
        * @param document
        *            the document
        * @param paragraphPosition
        *            the position the paragraph will be written to
        */
        public virtual void OnParagraph(PdfWriter writer, Document document,
                float paragraphPosition) {
            foreach (IPdfPageEvent eventa in events) {
                eventa.OnParagraph(writer, document, paragraphPosition);
            }
        }

        /**
        * Called when a Paragraph is written.
        * <P>
        * <CODE>paragraphPosition</CODE> will hold the height of the end of the
        * paragraph.
        * 
        * @param writer
        *            the <CODE>PdfWriter</CODE> for this document
        * @param document
        *            the document
        * @param paragraphPosition
        *            the position of the end of the paragraph
        */
        public virtual void OnParagraphEnd(PdfWriter writer, Document document,
                float paragraphPosition) {
            foreach (IPdfPageEvent eventa in events) {
                eventa.OnParagraphEnd(writer, document, paragraphPosition);
            }
        }

        /**
        * Called when a Chapter is written.
        * <P>
        * <CODE>position</CODE> will hold the height at which the chapter will be
        * written to.
        * 
        * @param writer
        *            the <CODE>PdfWriter</CODE> for this document
        * @param document
        *            the document
        * @param paragraphPosition
        *            the position the chapter will be written to
        * @param title
        *            the title of the Chapter
        */
        public virtual void OnChapter(PdfWriter writer, Document document,
                float paragraphPosition, Paragraph title) {
            foreach (IPdfPageEvent eventa in events) {
                eventa.OnChapter(writer, document, paragraphPosition, title);
            }
        }

        /**
        * Called when the end of a Chapter is reached.
        * <P>
        * <CODE>position</CODE> will hold the height of the end of the chapter.
        * 
        * @param writer
        *            the <CODE>PdfWriter</CODE> for this document
        * @param document
        *            the document
        * @param position
        *            the position of the end of the chapter.
        */
        public virtual void OnChapterEnd(PdfWriter writer, Document document, float position) {
            foreach (IPdfPageEvent eventa in events) {
                eventa.OnChapterEnd(writer, document, position);
            }
        }

        /**
        * Called when a Section is written.
        * <P>
        * <CODE>position</CODE> will hold the height at which the section will be
        * written to.
        * 
        * @param writer
        *            the <CODE>PdfWriter</CODE> for this document
        * @param document
        *            the document
        * @param paragraphPosition
        *            the position the section will be written to
        * @param depth
        *            the number depth of the Section
        * @param title
        *            the title of the section
        */
        public virtual void OnSection(PdfWriter writer, Document document,
                float paragraphPosition, int depth, Paragraph title) {
            foreach (IPdfPageEvent eventa in events) {
                eventa.OnSection(writer, document, paragraphPosition, depth, title);
            }
        }

        /**
        * Called when the end of a Section is reached.
        * <P>
        * <CODE>position</CODE> will hold the height of the section end.
        * 
        * @param writer
        *            the <CODE>PdfWriter</CODE> for this document
        * @param document
        *            the document
        * @param position
        *            the position of the end of the section
        */
        public virtual void OnSectionEnd(PdfWriter writer, Document document, float position) {
            foreach (IPdfPageEvent eventa in events) {
                eventa.OnSectionEnd(writer, document, position);
            }
        }

        /**
        * Called when a <CODE>Chunk</CODE> with a generic tag is written.
        * <P>
        * It is usefull to pinpoint the <CODE>Chunk</CODE> location to generate
        * bookmarks, for example.
        * 
        * @param writer
        *            the <CODE>PdfWriter</CODE> for this document
        * @param document
        *            the document
        * @param rect
        *            the <CODE>Rectangle</CODE> containing the <CODE>Chunk
        *            </CODE>
        * @param text
        *            the text of the tag
        */
        public virtual void OnGenericTag(PdfWriter writer, Document document,
                Rectangle rect, String text) {
            foreach (IPdfPageEvent eventa in events) {
                eventa.OnGenericTag(writer, document, rect, text);
            }
        }
    }
}

By viewing downloads associated with this article you agree to the Terms of Service and the article's licence.

If a file you wish to view isn't highlighted, and is a text file (not binary), please let us know and we'll add colourisation support for it.

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)


Written By
United Kingdom United Kingdom
This member has not yet provided a Biography. Assume it's interesting and varied, and probably something to do with programming.

Comments and Discussions