KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > fop > fo > pagination > Root


1 /*
2  * $Id: Root.java,v 1.16.2.7 2003/04/11 00:24:41 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.fo.pagination;
52
53 // FOP
54 import org.apache.fop.fo.*;
55 import org.apache.fop.apps.FOPException;
56
57 /**
58  * Class modeling the fo:root object. Contains page masters, root extensions,
59  * page-sequences.
60  *
61  * @see <a HREF="@XSLFO-STD@#fo_root" target="_xslfostd">@XSLFO-STDID@
62  * &para;6.4.2</a>
63  */
64 public class Root extends FObj {
65
66     public static class Maker extends FObj.Maker {
67         public FObj make(FObj parent, PropertyList propertyList,
68                          String JavaDoc systemId, int line, int column)
69             throws FOPException {
70             return new Root(parent, propertyList, systemId, line, column);
71         }
72
73     }
74
75     public static FObj.Maker maker() {
76         return new Root.Maker();
77     }
78
79     LayoutMasterSet layoutMasterSet;
80     /**
81      * Store a page sequence over a sequence change. The next sequence will
82      * get the page number from this and also take care of forced pages.
83      */
84     PageSequence pageSequence;
85
86     protected Root(FObj parent, PropertyList propertyList,
87                         String JavaDoc systemId, int line, int column)
88         throws FOPException {
89         super(parent, propertyList, systemId, line, column);
90         // this.properties.get("media-usage");
91
92         if (parent != null) {
93             throw new FOPException("root must be root element", systemId, line, column);
94         }
95     }
96
97     public void setPageSequence(PageSequence pageSequence) {
98         this.pageSequence=pageSequence;
99     }
100
101     public PageSequence getPageSequence() {
102         return this.pageSequence;
103     }
104
105     public LayoutMasterSet getLayoutMasterSet() {
106         return this.layoutMasterSet;
107     }
108
109     public void setLayoutMasterSet(LayoutMasterSet layoutMasterSet) {
110         this.layoutMasterSet = layoutMasterSet;
111     }
112
113     public String JavaDoc getName() {
114         return "fo:root";
115     }
116 }
117
Popular Tags