From 9ae5455d8ea2a709f72adcb494e238c093b41b53 Mon Sep 17 00:00:00 2001 From: William Victor Mote Date: Sun, 13 Jul 2003 20:52:05 +0000 Subject: [PATCH] style changes only git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@196691 13f79535-47bb-0310-9956-ffa450edef68 --- src/java/org/apache/fop/fo/FObj.java | 2 +- .../apache/fop/fo/ToBeImplementedElement.java | 25 ++++--- src/java/org/apache/fop/fo/flow/Table.java | 44 ++++++++---- .../apache/fop/fo/flow/TableAndCaption.java | 34 ++++++---- .../org/apache/fop/fo/flow/TableBody.java | 33 ++++++--- .../org/apache/fop/fo/flow/TableCaption.java | 32 ++++++--- .../org/apache/fop/fo/flow/TableCell.java | 67 ++++++++++++++----- .../org/apache/fop/fo/flow/TableColumn.java | 46 +++++++++---- .../org/apache/fop/fo/flow/TableFooter.java | 27 +++++--- .../org/apache/fop/fo/flow/TableHeader.java | 27 +++++--- src/java/org/apache/fop/fo/flow/TableRow.java | 33 ++++++--- src/java/org/apache/fop/fo/flow/Wrapper.java | 26 ++++--- 12 files changed, 267 insertions(+), 129 deletions(-) diff --git a/src/java/org/apache/fop/fo/FObj.java b/src/java/org/apache/fop/fo/FObj.java index 3fd142ce8..0f14704f0 100644 --- a/src/java/org/apache/fop/fo/FObj.java +++ b/src/java/org/apache/fop/fo/FObj.java @@ -334,7 +334,7 @@ public class FObj extends FONode { /** * Return a LayoutManager responsible for laying out this FObj's content. * Must override in subclasses if their content can be laid out. - * @param list the list to add the layout manager(s) to + * @param list the list to which the layout manager(s) should be added */ public void addLayoutManager(List list) { } diff --git a/src/java/org/apache/fop/fo/ToBeImplementedElement.java b/src/java/org/apache/fop/fo/ToBeImplementedElement.java index d8236a259..e36f0afeb 100644 --- a/src/java/org/apache/fop/fo/ToBeImplementedElement.java +++ b/src/java/org/apache/fop/fo/ToBeImplementedElement.java @@ -3,34 +3,34 @@ * ============================================================================ * The Apache Software License, Version 1.1 * ============================================================================ - * + * * Copyright (C) 1999-2003 The Apache Software Foundation. All rights reserved. - * + * * Redistribution and use in source and binary forms, with or without modifica- * tion, are permitted provided that the following conditions are met: - * + * * 1. Redistributions of source code must retain the above copyright notice, * this list of conditions and the following disclaimer. - * + * * 2. Redistributions in binary form must reproduce the above copyright notice, * this list of conditions and the following disclaimer in the documentation * and/or other materials provided with the distribution. - * + * * 3. The end-user documentation included with the redistribution, if any, must * include the following acknowledgment: "This product includes software * developed by the Apache Software Foundation (http://www.apache.org/)." * Alternately, this acknowledgment may appear in the software itself, if * and wherever such third-party acknowledgments normally appear. - * + * * 4. The names "FOP" and "Apache Software Foundation" must not be used to * endorse or promote products derived from this software without prior * written permission. For written permission, please contact * apache@apache.org. - * + * * 5. Products derived from this software may not be called "Apache", nor may * "Apache" appear in their name, without prior written permission of the * Apache Software Foundation. - * + * * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE @@ -42,12 +42,12 @@ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * ============================================================================ - * + * * This software consists of voluntary contributions made by many individuals * on behalf of the Apache Software Foundation and was originally created by * James Tauber . For more information on the Apache * Software Foundation, please see . - */ + */ package org.apache.fop.fo; /** @@ -55,11 +55,14 @@ package org.apache.fop.fo; */ public class ToBeImplementedElement extends FObj { + /** + * @param parent FONode that is the parent of this object + */ protected ToBeImplementedElement(FONode parent) { super(parent); } - public void setup() { + private void setup() { getLogger().debug("This element \"" + this.name + "\" is not yet implemented."); } diff --git a/src/java/org/apache/fop/fo/flow/Table.java b/src/java/org/apache/fop/fo/flow/Table.java index 8d672623f..bff2e4cd4 100644 --- a/src/java/org/apache/fop/fo/flow/Table.java +++ b/src/java/org/apache/fop/fo/flow/Table.java @@ -3,34 +3,34 @@ * ============================================================================ * The Apache Software License, Version 1.1 * ============================================================================ - * + * * Copyright (C) 1999-2003 The Apache Software Foundation. All rights reserved. - * + * * Redistribution and use in source and binary forms, with or without modifica- * tion, are permitted provided that the following conditions are met: - * + * * 1. Redistributions of source code must retain the above copyright notice, * this list of conditions and the following disclaimer. - * + * * 2. Redistributions in binary form must reproduce the above copyright notice, * this list of conditions and the following disclaimer in the documentation * and/or other materials provided with the distribution. - * + * * 3. The end-user documentation included with the redistribution, if any, must * include the following acknowledgment: "This product includes software * developed by the Apache Software Foundation (http://www.apache.org/)." * Alternately, this acknowledgment may appear in the software itself, if * and wherever such third-party acknowledgments normally appear. - * + * * 4. The names "FOP" and "Apache Software Foundation" must not be used to * endorse or promote products derived from this software without prior * written permission. For written permission, please contact * apache@apache.org. - * + * * 5. Products derived from this software may not be called "Apache", nor may * "Apache" appear in their name, without prior written permission of the * Apache Software Foundation. - * + * * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE @@ -42,12 +42,12 @@ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * ============================================================================ - * + * * This software consists of voluntary contributions made by many individuals * on behalf of the Apache Software Foundation and was originally created by * James Tauber . For more information on the Apache * Software Foundation, please see . - */ + */ package org.apache.fop.fo.flow; // Java @@ -70,9 +70,13 @@ import org.apache.fop.layout.MarginProps; import org.apache.fop.layout.RelativePositionProps; import org.apache.fop.layoutmgr.table.TableLayoutManager; +/** + * Class modelling the fo:table object. See Sec. 6.7.3 of the XSL-FO Standard. + */ public class Table extends FObj { private static final int MINCOLWIDTH = 10000; // 10pt + /** collection of columns in this table */ protected ArrayList columns = null; private TableBody tableHeader = null; private TableBody tableFooter = null; @@ -96,10 +100,17 @@ public class Table extends FObj { /** Maximum inline-progression-dimension */ private int maxIPD; + /** + * @param parent FONode that is the parent of this object + */ public Table(FONode parent) { super(parent); } + /** + * Overrides FObj. + * @param child FONode child object to be added + */ protected void addChild(FONode child) { if (child.getName().equals("fo:table-column")) { if (columns == null) { @@ -119,6 +130,7 @@ public class Table extends FObj { /** * Return a LayoutManager responsible for laying out this FObj's content. * Must override in subclasses if their content can be laid out. + * @param list the list to which the layout manager(s) should be added */ public void addLayoutManager(List list) { TableLayoutManager tlm = new TableLayoutManager(); @@ -134,7 +146,7 @@ public class Table extends FObj { list.add(tlm); } - public void setup() { + private void setup() { // Common Accessibility Properties AccessibilityProps mAccProps = propMgr.getAccessibilityProps(); @@ -188,18 +200,24 @@ public class Table extends FObj { "table-layout").getEnum() == TableLayout.AUTO); this.omitHeaderAtBreak = this.properties.get( - "table-omit-header-at-break").getEnum() + "table-omit-header-at-break").getEnum() == TableOmitHeaderAtBreak.TRUE; this.omitFooterAtBreak = this.properties.get( - "table-omit-footer-at-break").getEnum() + "table-omit-footer-at-break").getEnum() == TableOmitFooterAtBreak.TRUE; } + /** + * @return false (Table does not generate inline areas) + */ public boolean generatesInlineAreas() { return false; } + /** + * @return true (Table contains Markers) + */ protected boolean containsMarkers() { return true; } diff --git a/src/java/org/apache/fop/fo/flow/TableAndCaption.java b/src/java/org/apache/fop/fo/flow/TableAndCaption.java index fd03bc5bd..7e63898cd 100644 --- a/src/java/org/apache/fop/fo/flow/TableAndCaption.java +++ b/src/java/org/apache/fop/fo/flow/TableAndCaption.java @@ -3,34 +3,34 @@ * ============================================================================ * The Apache Software License, Version 1.1 * ============================================================================ - * + * * Copyright (C) 1999-2003 The Apache Software Foundation. All rights reserved. - * + * * Redistribution and use in source and binary forms, with or without modifica- * tion, are permitted provided that the following conditions are met: - * + * * 1. Redistributions of source code must retain the above copyright notice, * this list of conditions and the following disclaimer. - * + * * 2. Redistributions in binary form must reproduce the above copyright notice, * this list of conditions and the following disclaimer in the documentation * and/or other materials provided with the distribution. - * + * * 3. The end-user documentation included with the redistribution, if any, must * include the following acknowledgment: "This product includes software * developed by the Apache Software Foundation (http://www.apache.org/)." * Alternately, this acknowledgment may appear in the software itself, if * and wherever such third-party acknowledgments normally appear. - * + * * 4. The names "FOP" and "Apache Software Foundation" must not be used to * endorse or promote products derived from this software without prior * written permission. For written permission, please contact * apache@apache.org. - * + * * 5. Products derived from this software may not be called "Apache", nor may * "Apache" appear in their name, without prior written permission of the * Apache Software Foundation. - * + * * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE @@ -42,12 +42,12 @@ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * ============================================================================ - * + * * This software consists of voluntary contributions made by many individuals * on behalf of the Apache Software Foundation and was originally created by * James Tauber . For more information on the Apache * Software Foundation, please see . - */ + */ package org.apache.fop.fo.flow; // FOP @@ -61,15 +61,19 @@ import org.apache.fop.layout.MarginProps; import org.apache.fop.layout.RelativePositionProps; /** - * fo:table-and-caption element. + * Class modelling the fo:table-and-caption property. See Sec. 6.7.2 of the + * XSL-FO Standard. */ public class TableAndCaption extends ToBeImplementedElement { + /** + * @param parent FONode that is the parent of this object + */ public TableAndCaption(FONode parent) { super(parent); } - public void setup() { + private void setup() { // Common Accessibility Properties AccessibilityProps mAccProps = propMgr.getAccessibilityProps(); @@ -95,10 +99,16 @@ public class TableAndCaption extends ToBeImplementedElement { } + /** + * @return false (TableAndCaption doesn't generate inline areas) + */ public boolean generatesInlineAreas() { return false; } + /** + * @return true (TableAndCaption contains Markers) + */ protected boolean containsMarkers() { return true; } diff --git a/src/java/org/apache/fop/fo/flow/TableBody.java b/src/java/org/apache/fop/fo/flow/TableBody.java index ce9e68cf5..8825919ff 100644 --- a/src/java/org/apache/fop/fo/flow/TableBody.java +++ b/src/java/org/apache/fop/fo/flow/TableBody.java @@ -3,34 +3,34 @@ * ============================================================================ * The Apache Software License, Version 1.1 * ============================================================================ - * + * * Copyright (C) 1999-2003 The Apache Software Foundation. All rights reserved. - * + * * Redistribution and use in source and binary forms, with or without modifica- * tion, are permitted provided that the following conditions are met: - * + * * 1. Redistributions of source code must retain the above copyright notice, * this list of conditions and the following disclaimer. - * + * * 2. Redistributions in binary form must reproduce the above copyright notice, * this list of conditions and the following disclaimer in the documentation * and/or other materials provided with the distribution. - * + * * 3. The end-user documentation included with the redistribution, if any, must * include the following acknowledgment: "This product includes software * developed by the Apache Software Foundation (http://www.apache.org/)." * Alternately, this acknowledgment may appear in the software itself, if * and wherever such third-party acknowledgments normally appear. - * + * * 4. The names "FOP" and "Apache Software Foundation" must not be used to * endorse or promote products derived from this software without prior * written permission. For written permission, please contact * apache@apache.org. - * + * * 5. Products derived from this software may not be called "Apache", nor may * "Apache" appear in their name, without prior written permission of the * Apache Software Foundation. - * + * * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE @@ -42,12 +42,12 @@ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * ============================================================================ - * + * * This software consists of voluntary contributions made by many individuals * on behalf of the Apache Software Foundation and was originally created by * James Tauber . For more information on the Apache * Software Foundation, please see . - */ + */ package org.apache.fop.fo.flow; // Java @@ -66,12 +66,19 @@ import org.apache.fop.layout.BorderAndPadding; import org.apache.fop.layout.RelativePositionProps; import org.apache.fop.layoutmgr.table.Body; +/** + * Class modelling the fo:table-body object. See Sec. 6.7.8 of the XSL-FO + * Standard. + */ public class TableBody extends FObj { private int spaceBefore; private int spaceAfter; private ColorType backgroundColor; + /** + * @param parent FONode that is the parent of the object + */ public TableBody(FONode parent) { super(parent); } @@ -79,6 +86,7 @@ public class TableBody extends FObj { /** * Return a LayoutManager responsible for laying out this FObj's content. * Must override in subclasses if their content can be laid out. + * @param list the list to which the layout manager(s) should be added */ public void addLayoutManager(List list) { list.add(getLayoutManager()); @@ -91,7 +99,7 @@ public class TableBody extends FObj { return blm; } - public void setup() throws FOPException { + private void setup() throws FOPException { // Common Accessibility Properties AccessibilityProps mAccProps = propMgr.getAccessibilityProps(); @@ -117,6 +125,9 @@ public class TableBody extends FObj { } + /** + * @return true (TableBody contains Markers) + */ protected boolean containsMarkers() { return true; } diff --git a/src/java/org/apache/fop/fo/flow/TableCaption.java b/src/java/org/apache/fop/fo/flow/TableCaption.java index 6d1dd078a..8b0e58a45 100644 --- a/src/java/org/apache/fop/fo/flow/TableCaption.java +++ b/src/java/org/apache/fop/fo/flow/TableCaption.java @@ -3,34 +3,34 @@ * ============================================================================ * The Apache Software License, Version 1.1 * ============================================================================ - * + * * Copyright (C) 1999-2003 The Apache Software Foundation. All rights reserved. - * + * * Redistribution and use in source and binary forms, with or without modifica- * tion, are permitted provided that the following conditions are met: - * + * * 1. Redistributions of source code must retain the above copyright notice, * this list of conditions and the following disclaimer. - * + * * 2. Redistributions in binary form must reproduce the above copyright notice, * this list of conditions and the following disclaimer in the documentation * and/or other materials provided with the distribution. - * + * * 3. The end-user documentation included with the redistribution, if any, must * include the following acknowledgment: "This product includes software * developed by the Apache Software Foundation (http://www.apache.org/)." * Alternately, this acknowledgment may appear in the software itself, if * and wherever such third-party acknowledgments normally appear. - * + * * 4. The names "FOP" and "Apache Software Foundation" must not be used to * endorse or promote products derived from this software without prior * written permission. For written permission, please contact * apache@apache.org. - * + * * 5. Products derived from this software may not be called "Apache", nor may * "Apache" appear in their name, without prior written permission of the * Apache Software Foundation. - * + * * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE @@ -42,12 +42,12 @@ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * ============================================================================ - * + * * This software consists of voluntary contributions made by many individuals * on behalf of the Apache Software Foundation and was originally created by * James Tauber . For more information on the Apache * Software Foundation, please see . - */ + */ package org.apache.fop.fo.flow; // FOP @@ -60,14 +60,21 @@ import org.apache.fop.layout.BorderAndPadding; import org.apache.fop.layout.RelativePositionProps; /** - * fo:table-caption element. + * Class modelling the fo:table-caption object. See Sec. 6.7.5 of the XSL-FO + * Standard. */ public class TableCaption extends ToBeImplementedElement { + /** + * @param parent FONode that is the parent of this object + */ public TableCaption(FONode parent) { super(parent); } + /** + * Initialize property values. + */ public void setup() { // Common Accessibility Properties @@ -92,6 +99,9 @@ public class TableCaption extends ToBeImplementedElement { } + /** + * @return true (TableCaption contains Markers) + */ protected boolean containsMarkers() { return true; } diff --git a/src/java/org/apache/fop/fo/flow/TableCell.java b/src/java/org/apache/fop/fo/flow/TableCell.java index b2dcc4b93..a2bf49969 100644 --- a/src/java/org/apache/fop/fo/flow/TableCell.java +++ b/src/java/org/apache/fop/fo/flow/TableCell.java @@ -3,34 +3,34 @@ * ============================================================================ * The Apache Software License, Version 1.1 * ============================================================================ - * + * * Copyright (C) 1999-2003 The Apache Software Foundation. All rights reserved. - * + * * Redistribution and use in source and binary forms, with or without modifica- * tion, are permitted provided that the following conditions are met: - * + * * 1. Redistributions of source code must retain the above copyright notice, * this list of conditions and the following disclaimer. - * + * * 2. Redistributions in binary form must reproduce the above copyright notice, * this list of conditions and the following disclaimer in the documentation * and/or other materials provided with the distribution. - * + * * 3. The end-user documentation included with the redistribution, if any, must * include the following acknowledgment: "This product includes software * developed by the Apache Software Foundation (http://www.apache.org/)." * Alternately, this acknowledgment may appear in the software itself, if * and wherever such third-party acknowledgments normally appear. - * + * * 4. The names "FOP" and "Apache Software Foundation" must not be used to * endorse or promote products derived from this software without prior * written permission. For written permission, please contact * apache@apache.org. - * + * * 5. Products derived from this software may not be called "Apache", nor may * "Apache" appear in their name, without prior written permission of the * Apache Software Foundation. - * + * * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE @@ -42,12 +42,12 @@ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * ============================================================================ - * + * * This software consists of voluntary contributions made by many individuals * on behalf of the Apache Software Foundation and was originally created by * James Tauber . For more information on the Apache * Software Foundation, please see . - */ + */ package org.apache.fop.fo.flow; // Java @@ -71,7 +71,10 @@ import org.apache.fop.layout.BorderAndPadding; import org.apache.fop.layout.RelativePositionProps; import org.apache.fop.layoutmgr.table.Cell; - +/** + * Class modelling the fo:table-cell object. See Sec. 6.7.10 of the XSL-FO + * Standard. + */ public class TableCell extends FObj { // private int spaceBefore; @@ -112,16 +115,22 @@ public class TableCell extends FObj { */ protected int widthAdjust = 0; - /* For collapsed border style */ + /** For collapsed border style */ protected int borderHeight = 0; - /** Minimum ontent height of cell. */ + /** Minimum content height of cell. */ protected int minCellHeight = 0; + /** Height of cell */ protected int height = 0; + /** Ypos of cell ??? */ protected int top; + + /** corresponds to display-align property */ protected int verticalAlign; + + /** is this cell relatively aligned? */ protected boolean bRelativeAlign = false; // boolean setup = false; @@ -138,16 +147,25 @@ public class TableCell extends FObj { */ private int borderSeparation = 0; + /** + * @param parent FONode that is the parent of this object + */ public TableCell(FONode parent) { super(parent); } + /** + * Overriden from FObj. + * @param attlist Collection of attributes passed to us from the parser. + * @throws FOPException for FO errors + */ public void handleAttrs(Attributes attlist) throws FOPException { super.handleAttrs(attlist); doSetup(); // init some basic property values } /** + * @param list the list to which the layout manager(s) should be added */ public void addLayoutManager(List list) { Cell clm = new Cell(); @@ -163,25 +181,38 @@ public class TableCell extends FObj { startOffset = offset; } - // Initially same as the column width containg this cell or the - // sum of the spanned columns if numColumnsSpanned > 1 + /** + * Sets the width of the cell. Initially this width is the same as the + * width of the column containing this cell, or the sum of the spanned + * columns if numColumnsSpanned > 1 + * @param width the width of the cell (in millipoints ??) + */ public void setWidth(int width) { this.width = width; } + /** + * @return number of the column containing this cell + */ public int getColumnNumber() { return iColNumber; } + /** + * @return the number of columns spanned by this cell + */ public int getNumColumnsSpanned() { return numColumnsSpanned; } + /** + * @return the number of rows spanned by this cell + */ public int getNumRowsSpanned() { return numRowsSpanned; } - public void doSetup() { + private void doSetup() { // Common Accessibility Properties AccessibilityProps mAccProps = propMgr.getAccessibilityProps(); @@ -350,6 +381,10 @@ public class TableCell extends FObj { } } + /** + * + * @return true (TableCell can contain Markers) + */ protected boolean containsMarkers() { return true; } diff --git a/src/java/org/apache/fop/fo/flow/TableColumn.java b/src/java/org/apache/fop/fo/flow/TableColumn.java index 956f11758..19b79c67e 100644 --- a/src/java/org/apache/fop/fo/flow/TableColumn.java +++ b/src/java/org/apache/fop/fo/flow/TableColumn.java @@ -3,34 +3,34 @@ * ============================================================================ * The Apache Software License, Version 1.1 * ============================================================================ - * + * * Copyright (C) 1999-2003 The Apache Software Foundation. All rights reserved. - * + * * Redistribution and use in source and binary forms, with or without modifica- * tion, are permitted provided that the following conditions are met: - * + * * 1. Redistributions of source code must retain the above copyright notice, * this list of conditions and the following disclaimer. - * + * * 2. Redistributions in binary form must reproduce the above copyright notice, * this list of conditions and the following disclaimer in the documentation * and/or other materials provided with the distribution. - * + * * 3. The end-user documentation included with the redistribution, if any, must * include the following acknowledgment: "This product includes software * developed by the Apache Software Foundation (http://www.apache.org/)." * Alternately, this acknowledgment may appear in the software itself, if * and wherever such third-party acknowledgments normally appear. - * + * * 4. The names "FOP" and "Apache Software Foundation" must not be used to * endorse or promote products derived from this software without prior * written permission. For written permission, please contact * apache@apache.org. - * + * * 5. Products derived from this software may not be called "Apache", nor may * "Apache" appear in their name, without prior written permission of the * Apache Software Foundation. - * + * * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE @@ -42,12 +42,12 @@ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * ============================================================================ - * + * * This software consists of voluntary contributions made by many individuals * on behalf of the Apache Software Foundation and was originally created by * James Tauber . For more information on the Apache * Software Foundation, please see . - */ + */ package org.apache.fop.fo.flow; // FOP @@ -62,6 +62,10 @@ import org.apache.fop.layout.BorderAndPadding; import org.apache.fop.layoutmgr.LayoutManager; import org.apache.fop.layoutmgr.table.Column; +/** + * Class modelling the fo:table-column object. See Sec. 6.7.4 of the XSL-FO + * Standard. + */ public class TableColumn extends FObj { private ColorType backgroundColor; @@ -74,6 +78,9 @@ public class TableColumn extends FObj { private boolean setup = false; + /** + * @param parent FONode that is the parent of this object + */ public TableColumn(FONode parent) { super(parent); } @@ -86,31 +93,44 @@ public class TableColumn extends FObj { return clm; } + /** + * @return Length object containing column width + */ public Length getColumnWidthAsLength() { return columnWidthPropVal; } + /** + * @return the column width (in millipoints ??) + */ public int getColumnWidth() { return columnWidth; } /** - * Set the column width value in base units which overrides the - * value from the column-width Property. + * Set the column width value, overriding the value from the column-width + * Property. + * @param columnWidth the column width value in base units (millipoints ??) */ public void setColumnWidth(int columnWidth) { this.columnWidth = columnWidth; } + /** + * @return column number + */ public int getColumnNumber() { return iColumnNumber; } + /** + * @return value for number of columns repeated + */ public int getNumColumnsRepeated() { return numColumnsRepeated; } - public void doSetup() { + private void doSetup() { // Common Border, Padding, and Background Properties // only background apply, border apply if border-collapse diff --git a/src/java/org/apache/fop/fo/flow/TableFooter.java b/src/java/org/apache/fop/fo/flow/TableFooter.java index 17f5008dd..7761e33e8 100644 --- a/src/java/org/apache/fop/fo/flow/TableFooter.java +++ b/src/java/org/apache/fop/fo/flow/TableFooter.java @@ -3,34 +3,34 @@ * ============================================================================ * The Apache Software License, Version 1.1 * ============================================================================ - * + * * Copyright (C) 1999-2003 The Apache Software Foundation. All rights reserved. - * + * * Redistribution and use in source and binary forms, with or without modifica- * tion, are permitted provided that the following conditions are met: - * + * * 1. Redistributions of source code must retain the above copyright notice, * this list of conditions and the following disclaimer. - * + * * 2. Redistributions in binary form must reproduce the above copyright notice, * this list of conditions and the following disclaimer in the documentation * and/or other materials provided with the distribution. - * + * * 3. The end-user documentation included with the redistribution, if any, must * include the following acknowledgment: "This product includes software * developed by the Apache Software Foundation (http://www.apache.org/)." * Alternately, this acknowledgment may appear in the software itself, if * and wherever such third-party acknowledgments normally appear. - * + * * 4. The names "FOP" and "Apache Software Foundation" must not be used to * endorse or promote products derived from this software without prior * written permission. For written permission, please contact * apache@apache.org. - * + * * 5. Products derived from this software may not be called "Apache", nor may * "Apache" appear in their name, without prior written permission of the * Apache Software Foundation. - * + * * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE @@ -42,19 +42,26 @@ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * ============================================================================ - * + * * This software consists of voluntary contributions made by many individuals * on behalf of the Apache Software Foundation and was originally created by * James Tauber . For more information on the Apache * Software Foundation, please see . - */ + */ package org.apache.fop.fo.flow; // FOP import org.apache.fop.fo.FONode; +/** + * Class modelling the fo:table-footer object. See Sec. 6.7.7 of the XSL-FO + * Standard. + */ public class TableFooter extends TableBody { + /** + * @param parent FONode that is the parent of this object + */ public TableFooter(FONode parent) { super(parent); } diff --git a/src/java/org/apache/fop/fo/flow/TableHeader.java b/src/java/org/apache/fop/fo/flow/TableHeader.java index d9b725874..91d8c149a 100644 --- a/src/java/org/apache/fop/fo/flow/TableHeader.java +++ b/src/java/org/apache/fop/fo/flow/TableHeader.java @@ -3,34 +3,34 @@ * ============================================================================ * The Apache Software License, Version 1.1 * ============================================================================ - * + * * Copyright (C) 1999-2003 The Apache Software Foundation. All rights reserved. - * + * * Redistribution and use in source and binary forms, with or without modifica- * tion, are permitted provided that the following conditions are met: - * + * * 1. Redistributions of source code must retain the above copyright notice, * this list of conditions and the following disclaimer. - * + * * 2. Redistributions in binary form must reproduce the above copyright notice, * this list of conditions and the following disclaimer in the documentation * and/or other materials provided with the distribution. - * + * * 3. The end-user documentation included with the redistribution, if any, must * include the following acknowledgment: "This product includes software * developed by the Apache Software Foundation (http://www.apache.org/)." * Alternately, this acknowledgment may appear in the software itself, if * and wherever such third-party acknowledgments normally appear. - * + * * 4. The names "FOP" and "Apache Software Foundation" must not be used to * endorse or promote products derived from this software without prior * written permission. For written permission, please contact * apache@apache.org. - * + * * 5. Products derived from this software may not be called "Apache", nor may * "Apache" appear in their name, without prior written permission of the * Apache Software Foundation. - * + * * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE @@ -42,19 +42,26 @@ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * ============================================================================ - * + * * This software consists of voluntary contributions made by many individuals * on behalf of the Apache Software Foundation and was originally created by * James Tauber . For more information on the Apache * Software Foundation, please see . - */ + */ package org.apache.fop.fo.flow; // FOP import org.apache.fop.fo.FONode; +/** + * Class modelling the fo:table-header object. See Sec. 6.7.6 of the XSL-FO + * Standard. + */ public class TableHeader extends TableBody { + /** + * @param parent FONode that is the parent of this object + */ public TableHeader(FONode parent) { super(parent); } diff --git a/src/java/org/apache/fop/fo/flow/TableRow.java b/src/java/org/apache/fop/fo/flow/TableRow.java index 42a058b6a..80ef93bdf 100644 --- a/src/java/org/apache/fop/fo/flow/TableRow.java +++ b/src/java/org/apache/fop/fo/flow/TableRow.java @@ -3,34 +3,34 @@ * ============================================================================ * The Apache Software License, Version 1.1 * ============================================================================ - * + * * Copyright (C) 1999-2003 The Apache Software Foundation. All rights reserved. - * + * * Redistribution and use in source and binary forms, with or without modifica- * tion, are permitted provided that the following conditions are met: - * + * * 1. Redistributions of source code must retain the above copyright notice, * this list of conditions and the following disclaimer. - * + * * 2. Redistributions in binary form must reproduce the above copyright notice, * this list of conditions and the following disclaimer in the documentation * and/or other materials provided with the distribution. - * + * * 3. The end-user documentation included with the redistribution, if any, must * include the following acknowledgment: "This product includes software * developed by the Apache Software Foundation (http://www.apache.org/)." * Alternately, this acknowledgment may appear in the software itself, if * and wherever such third-party acknowledgments normally appear. - * + * * 4. The names "FOP" and "Apache Software Foundation" must not be used to * endorse or promote products derived from this software without prior * written permission. For written permission, please contact * apache@apache.org. - * + * * 5. Products derived from this software may not be called "Apache", nor may * "Apache" appear in their name, without prior written permission of the * Apache Software Foundation. - * + * * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE @@ -42,12 +42,12 @@ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * ============================================================================ - * + * * This software consists of voluntary contributions made by many individuals * on behalf of the Apache Software Foundation and was originally created by * James Tauber . For more information on the Apache * Software Foundation, please see . - */ + */ package org.apache.fop.fo.flow; // Java @@ -68,6 +68,10 @@ import org.apache.fop.layout.BorderAndPadding; import org.apache.fop.layout.RelativePositionProps; import org.apache.fop.layoutmgr.table.Row; +/** + * Class modelling the fo:table-row object. See Sec. 6.7.9 of the XSL-FO + * Standard. + */ public class TableRow extends FObj { private boolean setup = false; @@ -81,11 +85,15 @@ public class TableRow extends FObj { private int minHeight = 0; // force row height + /** + * @param parent FONode that is the parent of this object + */ public TableRow(FONode parent) { super(parent); } /** + * @param list the list to which the layout manager(s) should be added */ public void addLayoutManager(List list) { Row rlm = new Row(); @@ -94,11 +102,14 @@ public class TableRow extends FObj { list.add(rlm); } + /** + * @return keepWithPrevious + */ public KeepValue getKeepWithPrevious() { return keepWithPrevious; } - public void doSetup() { + private void doSetup() { // Common Accessibility Properties AccessibilityProps mAccProps = propMgr.getAccessibilityProps(); diff --git a/src/java/org/apache/fop/fo/flow/Wrapper.java b/src/java/org/apache/fop/fo/flow/Wrapper.java index d3e176db6..a3bd5d75f 100644 --- a/src/java/org/apache/fop/fo/flow/Wrapper.java +++ b/src/java/org/apache/fop/fo/flow/Wrapper.java @@ -3,34 +3,34 @@ * ============================================================================ * The Apache Software License, Version 1.1 * ============================================================================ - * + * * Copyright (C) 1999-2003 The Apache Software Foundation. All rights reserved. - * + * * Redistribution and use in source and binary forms, with or without modifica- * tion, are permitted provided that the following conditions are met: - * + * * 1. Redistributions of source code must retain the above copyright notice, * this list of conditions and the following disclaimer. - * + * * 2. Redistributions in binary form must reproduce the above copyright notice, * this list of conditions and the following disclaimer in the documentation * and/or other materials provided with the distribution. - * + * * 3. The end-user documentation included with the redistribution, if any, must * include the following acknowledgment: "This product includes software * developed by the Apache Software Foundation (http://www.apache.org/)." * Alternately, this acknowledgment may appear in the software itself, if * and wherever such third-party acknowledgments normally appear. - * + * * 4. The names "FOP" and "Apache Software Foundation" must not be used to * endorse or promote products derived from this software without prior * written permission. For written permission, please contact * apache@apache.org. - * + * * 5. Products derived from this software may not be called "Apache", nor may * "Apache" appear in their name, without prior written permission of the * Apache Software Foundation. - * + * * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE @@ -42,12 +42,12 @@ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * ============================================================================ - * + * * This software consists of voluntary contributions made by many individuals * on behalf of the Apache Software Foundation and was originally created by * James Tauber . For more information on the Apache * Software Foundation, please see . - */ + */ package org.apache.fop.fo.flow; // FOP @@ -64,10 +64,16 @@ import org.apache.fop.fo.FObjMixed; */ public class Wrapper extends FObjMixed { + /** + * @param parent FONode that is the parent of this object + */ public Wrapper(FONode parent) { super(parent); } + /** + * @return true (Wrapper contains Markers) + */ protected boolean containsMarkers() { return true; } -- 2.39.5