KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > fop > layoutengine > LayoutResult


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: LayoutResult.java 426576 2006-07-28 15:44:37Z jeremias $ */
19
20 package org.apache.fop.layoutengine;
21
22 import org.apache.fop.apps.FormattingResults;
23 import org.w3c.dom.Document JavaDoc;
24
25 /**
26  * This class holds references to all the results from the FOP processing run.
27  */
28 public class LayoutResult {
29
30     private Document JavaDoc areaTree;
31     private ElementListCollector elCollector;
32     private FormattingResults results;
33     
34     /**
35      * Creates a new LayoutResult instance.
36      * @param areaTree the area tree DOM
37      * @param elCollector the element list collector
38      * @param results the formatting results
39      */
40     public LayoutResult(Document JavaDoc areaTree, ElementListCollector elCollector,
41                         FormattingResults results) {
42         this.areaTree = areaTree;
43         this.elCollector = elCollector;
44         this.results = results;
45     }
46  
47     /** @return the generated area tree as DOM tree */
48     public Document JavaDoc getAreaTree() {
49         return this.areaTree;
50     }
51     
52     /** @return the element list collector */
53     public ElementListCollector getElementListCollector() {
54         return this.elCollector;
55     }
56
57     /**
58      * @return Returns the results.
59      */
60     public FormattingResults getResults() {
61         return results;
62     }
63     
64 }
65
Popular Tags