aboutsummaryrefslogtreecommitdiffstats
path: root/src/java/org/apache/fop/area/Footnote.java
diff options
context:
space:
mode:
authorJoerg Pietschmann <pietsch@apache.org>2005-09-07 22:20:36 +0000
committerJoerg Pietschmann <pietsch@apache.org>2005-09-07 22:20:36 +0000
commit6d4dd88c53c97d637f6bb3f338c53c5af5481d27 (patch)
treeadf1bdee1824fcb120a12c6010ebcc2abd727536 /src/java/org/apache/fop/area/Footnote.java
parent74014dc4ff641d1047cbbd6ef86bdfde99b3558d (diff)
downloadxmlgraphics-fop-6d4dd88c53c97d637f6bb3f338c53c5af5481d27.tar.gz
xmlgraphics-fop-6d4dd88c53c97d637f6bb3f338c53c5af5481d27.zip
Squashed CheckStyle warnings, mostly JavaDoc.
git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@279439 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'src/java/org/apache/fop/area/Footnote.java')
-rw-r--r--src/java/org/apache/fop/area/Footnote.java25
1 files changed, 25 insertions, 0 deletions
diff --git a/src/java/org/apache/fop/area/Footnote.java b/src/java/org/apache/fop/area/Footnote.java
index 928b39cf5..735dfaf25 100644
--- a/src/java/org/apache/fop/area/Footnote.java
+++ b/src/java/org/apache/fop/area/Footnote.java
@@ -56,14 +56,29 @@ public class Footnote extends BlockParent {
return separator;
}
+ /**
+ * Set the relative position of the footnote inside the body region.
+ *
+ * @param top the relative position.
+ */
public void setTop(int top) {
this.top = top;
}
+ /**
+ * Get the relative position of the footnote inside the body region.
+ *
+ * @return the relative position.
+ */
public int getTop() {
return top;
}
+ /**
+ * Add a block area as child to the footnote area
+ *
+ * @param child the block area.
+ */
public void addBlock(Block child) {
if (children == null) {
children = new ArrayList();
@@ -72,10 +87,20 @@ public class Footnote extends BlockParent {
children.add(child);
}
+ /**
+ * Get all child areas.
+ *
+ * @return the list of child areas. Maybe null.
+ */
public List getChildAreas() {
return children;
}
+ /**
+ * Check whether there are child areas.
+ *
+ * @return the result.
+ */
public boolean isEmpty() {
return children == null || children.size() == 0;
}