KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > fop > layoutmgr > Page


1 /*
2  * Licensed to the Apache Software Foundation (ASF) under one or more
3  * contributor license agreements. See the NOTICE file distributed with
4  * this work for additional information regarding copyright ownership.
5  * The ASF licenses this file to You under the Apache License, Version 2.0
6  * (the "License"); you may not use this file except in compliance with
7  * the License. You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17
18 /* $Id: Page.java 426576 2006-07-28 15:44:37Z jeremias $ */
19
20 package org.apache.fop.layoutmgr;
21
22 import org.apache.fop.area.PageViewport;
23 import org.apache.fop.fo.pagination.SimplePageMaster;
24
25 /**
26  * This object is used by the layout engine to represent a page. It provides access to the
27  * simple-page-master that was used as a template for this page and it provides access to the
28  * PageViewport which is the top-level area tree element. This class helps to decouple the
29  * FO tree from the area tree to make the latter easily serializable.
30  */
31 public class Page {
32
33     private SimplePageMaster spm;
34     private PageViewport pageViewport;
35     
36     /**
37      * Main constructor
38      * @param spm the simple-page-master used for this page
39      * @param pageNumber the page number (as an int)
40      * @param pageNumberStr the page number (as a String)
41      * @param blank true if this is a blank page
42      */
43     public Page(SimplePageMaster spm, int pageNumber, String JavaDoc pageNumberStr, boolean blank) {
44         this.spm = spm;
45         this.pageViewport = new PageViewport(spm, pageNumber, pageNumberStr, blank);
46     }
47     
48     /** @return the simple-page-master that created this page */
49     public SimplePageMaster getSimplePageMaster() {
50         return this.spm;
51     }
52     
53     /** @return the page viewport representing this page in the area tree */
54     public PageViewport getPageViewport() {
55         return this.pageViewport;
56     }
57     
58 }
59
Popular Tags