KickJava   Java API By Example, From Geeks To Geeks.

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


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: Footnote.java 426576 2006-07-28 15:44:37Z jeremias $ */
19  
20 package org.apache.fop.area;
21
22 // may combine with before float into a conditional area
23
24 /**
25  * The footnote-reference-area optionally generated by an fo:region-body.
26  * This areas holds footnote areas and an optional separator area.
27  * See fo:region-body definition in the XSL Rec for more information.
28  */
29 public class Footnote extends BlockParent {
30     private Block separator = null;
31
32     // footnote has an optional separator
33 // and a list of sub block areas that can be added/removed
34
35     // this is the relative position of the footnote inside
36 // the body region
37 private int top;
38
39     /**
40      * Set the separator area for this footnote.
41      *
42      * @param sep the separator area
43      */
44     public void setSeparator(Block sep) {
45         separator = sep;
46     }
47
48     /**
49      * Get the separator area for this footnote area.
50      *
51      * @return the separator area
52      */
53     public Block getSeparator() {
54         return separator;
55     }
56
57     /**
58      * Set the relative position of the footnote inside the body region.
59      *
60      * @param top the relative position.
61      */
62     public void setTop(int top) {
63         this.top = top;
64     }
65
66     /**
67      * Get the relative position of the footnote inside the body region.
68      *
69      * @return the relative position.
70      */
71     public int getTop() {
72         return top;
73     }
74
75     /**
76      * Add a block area as child to the footnote area
77      *
78      * @param child the block area.
79      */
80     public void addBlock(Block child) {
81         addChildArea(child);
82         this.setBPD(this.getBPD() + child.getBPD());
83     }
84
85 }
86
87
Popular Tags