KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > fop > area > BeforeFloat


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: BeforeFloat.java 426576 2006-07-28 15:44:37Z jeremias $ */
19  
20 package org.apache.fop.area;
21
22 /**
23  * The before-float-reference-area optionally generated by an fo:region-body.
24  * It has an optional separator and before float block children.
25  * See fo:region-body definition in the XSL Rec for more information.
26  */
27 public class BeforeFloat extends BlockParent {
28     // this is an optional block area that will be rendered
29 // as the separator only if there are float areas
30 private Block separator = null;
31
32     /**
33      * Set the separator area for this before float.
34      *
35      * @param sep the before float separator area
36      */
37     public void setSeparator(Block sep) {
38         separator = sep;
39     }
40
41     /**
42      * Get the separator area for this before float.
43      *
44      * @return the before float separator area
45      */
46     public Block getSeparator() {
47         return separator;
48     }
49
50     /**
51      * Get the height of this before float.
52      * It gets the height of the children and if there is a
53      * separator its height is also added.
54      *
55      * @return the height of the before float including separator
56      */
57     public int getBPD() {
58         int h = super.getBPD();
59         if (separator != null) {
60             h += separator.getBPD();
61         }
62         return h;
63     }
64
65     /** @see org.apache.fop.area.BlockParent#isEmpty() */
66     public boolean isEmpty() {
67         return true; // before floats are not yet implemented
68 }
69 }
70
71
Popular Tags