KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > fop > extensions > ExtensionObj


1 /*
2  * $Id: ExtensionObj.java,v 1.2.2.3 2003/04/11 00:24:37 pietsch Exp $
3  * ============================================================================
4  * The Apache Software License, Version 1.1
5  * ============================================================================
6  *
7  * Copyright (C) 1999-2003 The Apache Software Foundation. All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without modifica-
10  * tion, are permitted provided that the following conditions are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright notice,
13  * this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright notice,
16  * this list of conditions and the following disclaimer in the documentation
17  * and/or other materials provided with the distribution.
18  *
19  * 3. The end-user documentation included with the redistribution, if any, must
20  * include the following acknowledgment: "This product includes software
21  * developed by the Apache Software Foundation (http://www.apache.org/)."
22  * Alternately, this acknowledgment may appear in the software itself, if
23  * and wherever such third-party acknowledgments normally appear.
24  *
25  * 4. The names "FOP" and "Apache Software Foundation" must not be used to
26  * endorse or promote products derived from this software without prior
27  * written permission. For written permission, please contact
28  * apache@apache.org.
29  *
30  * 5. Products derived from this software may not be called "Apache", nor may
31  * "Apache" appear in their name, without prior written permission of the
32  * Apache Software Foundation.
33  *
34  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
35  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
36  * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
37  * APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
38  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLU-
39  * DING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
40  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
41  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
42  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
43  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
44  * ============================================================================
45  *
46  * This software consists of voluntary contributions made by many individuals
47  * on behalf of the Apache Software Foundation and was originally created by
48  * James Tauber <jtauber@jtauber.com>. For more information on the Apache
49  * Software Foundation, please see <http://www.apache.org/>.
50  */
51 package org.apache.fop.extensions;
52
53 import org.apache.fop.fo.*;
54 import org.apache.fop.layout.*;
55 import org.apache.fop.apps.FOPException;
56
57 /**
58  * base class for extension objects
59  */
60 public abstract class ExtensionObj extends FObj {
61
62     /**
63      *
64      * @param parent the parent formatting object
65      * @param propertyList the explicit properties of this object
66      */
67     public ExtensionObj(FObj parent, PropertyList propertyList,
68                         String JavaDoc systemId, int line, int column) {
69         super(parent, propertyList, systemId, line, column);
70     }
71
72     /**
73      * Called for extensions within a page sequence or flow. These extensions
74      * are allowed to generate visible areas within the layout.
75      *
76      *
77      * @param area
78      */
79     public int layout(Area area) throws FOPException {
80         ExtensionArea extArea = new ExtensionArea(this);
81         area.addChild(extArea);
82         return Status.OK;
83     }
84
85
86     /**
87      * Called for root extensions. Root extensions aren't allowed to generate
88      * any visible areas. They are used for extra items that don't show up in
89      * the page layout itself. For example: pdf outlines
90      *
91      * @param areaTree
92      */
93     public void format(AreaTree areaTree) throws FOPException {
94         ExtensionArea extArea = new ExtensionArea(this);
95         areaTree.addExtension(this);
96     }
97
98 }
99
Popular Tags