Thread: [FOray-commit] SF.net SVN: foray: [8761] trunk/foray (Page 7)
Modular XSL-FO Implementation for Java.
Status: Alpha
Brought to you by:
victormote
|
From: <vic...@us...> - 2007-02-26 14:19:32
|
Revision: 8761
http://svn.sourceforge.net/foray/?rev=8761&view=rev
Author: victormote
Date: 2007-02-26 06:19:27 -0800 (Mon, 26 Feb 2007)
Log Message:
-----------
1. Remove unneeded class.
2. Add javadoc requirements for the MIF project.
Modified Paths:
--------------
trunk/foray/foray-mif/src/java/org/foray/mif/MifBook.java
trunk/foray/scripts/checkstyle-suppressions.xml
Removed Paths:
-------------
trunk/foray/foray-mif/src/java/org/foray/mif/MifId.java
Modified: trunk/foray/foray-mif/src/java/org/foray/mif/MifBook.java
===================================================================
--- trunk/foray/foray-mif/src/java/org/foray/mif/MifBook.java 2007-02-26 14:14:17 UTC (rev 8760)
+++ trunk/foray/foray-mif/src/java/org/foray/mif/MifBook.java 2007-02-26 14:19:27 UTC (rev 8761)
@@ -55,7 +55,8 @@
/** The current flow, which could be a textflow or a table. */
private MifFlow curFlow;
- private MifId curIDCounter = new MifId();
+ /** The last id issued for this document. */
+ private int lastId = 0;
/** The logger for user messages. */
private Log logger;
@@ -319,7 +320,8 @@
* @return The next available id for this document.
*/
public int getNewId() {
- return this.curIDCounter.getnewID();
+ this.lastId ++;
+ return this.lastId;
}
}
Deleted: trunk/foray/foray-mif/src/java/org/foray/mif/MifId.java
===================================================================
--- trunk/foray/foray-mif/src/java/org/foray/mif/MifId.java 2007-02-26 14:14:17 UTC (rev 8760)
+++ trunk/foray/foray-mif/src/java/org/foray/mif/MifId.java 2007-02-26 14:19:27 UTC (rev 8761)
@@ -1,42 +0,0 @@
-/*
- * Copyright 2007 The FOray Project.
- * http://www.foray.org
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- *
- * This work is in part derived from the following work(s), used with the
- * permission of the licensor:
- * Apache FOP, licensed by the Apache Software Foundation
- *
- */
-
-/*
- * $LastChangedRevision$
- * $LastChangedDate$
- * $LastChangedBy$
- */
-
-package org.foray.mif;
-
-/**
- * A MIF ID.
- */
-public class MifId {
-
- private int idCounter = 1;
- public int getnewID() {
-
- return idCounter++;
- }
-
-}
Modified: trunk/foray/scripts/checkstyle-suppressions.xml
===================================================================
--- trunk/foray/scripts/checkstyle-suppressions.xml 2007-02-26 14:14:17 UTC (rev 8760)
+++ trunk/foray/scripts/checkstyle-suppressions.xml 2007-02-26 14:19:27 UTC (rev 8761)
@@ -13,8 +13,6 @@
<suppress checks="Javadoc[MVS].*"
files="org.foray.fotree.*"/>
<suppress checks="Javadoc[MVS].*"
- files="org.foray.mif.*"/>
- <suppress checks="Javadoc[MVS].*"
files="org.foray.pdf.*"/>
<suppress checks="Javadoc[MVS].*"
files="org.foray.pioneer.*"/>
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <vic...@us...> - 2007-02-26 14:49:41
|
Revision: 8762
http://svn.sourceforge.net/foray/?rev=8762&view=rev
Author: victormote
Date: 2007-02-26 06:49:40 -0800 (Mon, 26 Feb 2007)
Log Message:
-----------
Javadoc improvements.
Modified Paths:
--------------
trunk/foray/foray-render/src/java/org/foray/render/awt/AWTRenderer.java
trunk/foray/foray-render/src/java/org/foray/render/awt/viewer/MessageException.java
trunk/foray/foray-render/src/java/org/foray/render/awt/viewer/PreviewDialog.java
trunk/foray/foray-render/src/java/org/foray/render/awt/viewer/UserMessage.java
trunk/foray/foray-render/src/java/org/foray/render/pcl/PCLRenderer.java
trunk/foray/foray-render/src/java/org/foray/render/ps/PSGraphics2D.java
trunk/foray/foray-render/src/java/org/foray/render/ps/RunLengthEncodeOutputStream.java
trunk/foray/scripts/checkstyle-suppressions.xml
Modified: trunk/foray/foray-render/src/java/org/foray/render/awt/AWTRenderer.java
===================================================================
--- trunk/foray/foray-render/src/java/org/foray/render/awt/AWTRenderer.java 2007-02-26 14:19:27 UTC (rev 8761)
+++ trunk/foray/foray-render/src/java/org/foray/render/awt/AWTRenderer.java 2007-02-26 14:49:40 UTC (rev 8762)
@@ -129,11 +129,13 @@
/** The current font size in millipoints. */
private int currentFontSize;
- /**
- * The current colour's red, green and blue component
- */
+ /** The current color's red component. */
private float currentRed = 0;
+
+ /** The current color's green component. */
private float currentGreen = 0;
+
+ /** The current color's blue component. */
private float currentBlue = 0;
/**
@@ -941,6 +943,7 @@
}
/**
+ * Sets the page width.
* @param pageWidth The pageWidth to set.
*/
public void setPageWidth(final int pageWidth) {
@@ -948,6 +951,7 @@
}
/**
+ * Sets the page height.
* @param pageHeight The pageHeight to set.
*/
public void setPageHeight(final int pageHeight) {
Modified: trunk/foray/foray-render/src/java/org/foray/render/awt/viewer/MessageException.java
===================================================================
--- trunk/foray/foray-render/src/java/org/foray/render/awt/viewer/MessageException.java 2007-02-26 14:19:27 UTC (rev 8761)
+++ trunk/foray/foray-render/src/java/org/foray/render/awt/viewer/MessageException.java 2007-02-26 14:49:40 UTC (rev 8762)
@@ -41,27 +41,22 @@
*
*/
public class MessageException extends Exception {
+
+ /** Constant needed for serialization. */
static final long serialVersionUID = 680021191981719625L;
- /**
- * Angabe der auslösenden Exception, wie z.B. NullPointerException.
- * Dieses Feld ist optional.
- */
+ /** Cause of the exception (optional). */
private Exception exception;
- /**
- * ID der Meldung, die für diese Exception ausgegeben werden soll
- */
+ /** The message id. */
private String messageId;
- /**
- * Parameterliste zur Meldung
- */
+ /** Parameter list for the message. */
private String[] parameterList;
-
- // Konstruktoren
-
+ /**
+ * No-parameter constructor.
+ */
public MessageException() {
this("UNKNOWN_EXCEPTION");
}
Modified: trunk/foray/foray-render/src/java/org/foray/render/awt/viewer/PreviewDialog.java
===================================================================
--- trunk/foray/foray-render/src/java/org/foray/render/awt/viewer/PreviewDialog.java 2007-02-26 14:19:27 UTC (rev 8761)
+++ trunk/foray/foray-render/src/java/org/foray/render/awt/viewer/PreviewDialog.java 2007-02-26 14:49:40 UTC (rev 8762)
@@ -71,7 +71,7 @@
import javax.swing.SwingUtilities;
/**
- * Frame and User Interface for Preview
+ * Frame and User Interface for Preview.
*/
public class PreviewDialog extends JFrame implements ProgressListener {
@@ -457,7 +457,7 @@
}
/**
- * Show the About box
+ * Show the "About" box.
*
* @param e a value of type 'ActionEvent'
*/
@@ -473,7 +473,7 @@
}
/**
- * Change the current visible page
+ * Change the current visible page.
*
* @param number the page number to go to
*/
@@ -641,19 +641,16 @@
* a thread safe way.
*/
class ShowProgress implements Runnable {
- /**
- * The message to display
- */
+
+ /** The message to display. */
private Object message;
- /**
- * Is this an errorMessage, i.e. should it be shown in
- * an JOptionPane or in the status bar.
- */
+ /** Is this an errorMessage, i.e. should it be shown in an JOptionPane
+ * or in the status bar. */
private boolean isErrorMessage = false;
/**
- * Constructs showProgress thread
+ * Constructs a showProgress thread.
* @param message message to display
* @param isErrorMessage show in status bar or in JOptionPane
*/
@@ -690,9 +687,8 @@
class ShowPageImage implements Runnable {
/**
- * The run method that does the actuall updating
+ * {@inheritDoc}
*/
-
public void run() {
BufferedImage pageImage = null;
Graphics graphics = null;
Modified: trunk/foray/foray-render/src/java/org/foray/render/awt/viewer/UserMessage.java
===================================================================
--- trunk/foray/foray-render/src/java/org/foray/render/awt/viewer/UserMessage.java 2007-02-26 14:19:27 UTC (rev 8761)
+++ trunk/foray/foray-render/src/java/org/foray/render/awt/viewer/UserMessage.java 2007-02-26 14:49:40 UTC (rev 8762)
@@ -68,49 +68,23 @@
*/
private static final int SYS_ERROR = JOptionPane.ERROR_MESSAGE;
-
-
- /*
- * Style Constanten orientieren sich auf die
- * Constanten der ButtonDialog-Klasse und legen das Dialog-ButtonSet fest.
- */
-
- /**
- * Wert für Setzten keines Buttons
- */
+ /** Style indicating no buttons. */
private static final int STYLE_NOBUTTON = -2;
- /**
- * Wert für Setzten von nur Ja-Button.
- */
+ /** Style indicating a "Yes" button. */
private static final int STYLE_Y = JOptionPane.DEFAULT_OPTION;
- // ButtonDialog.YES; // = 1
- /**
- * Wert für Setzten von Ja- und Nein-Buttons.
- */
+ /** Style indicating "Yes" and "No" buttons. */
private static final int STYLE_Y_N = JOptionPane.YES_NO_OPTION;
- // ButtonDialog.YES_NO; // = 2;
- /**
- * Wert für Setzten von Ja-, Nein-und Abbruch Buttons.
- */
+ /** Style indicating "Yes", "No", and "Cancel" buttons. */
private static final int STYLE_Y_N_C = JOptionPane.YES_NO_CANCEL_OPTION;
- // ButtonDialog.YES_NO_CANCEL; // = 3;
-
// Platzhalter für Parameter in der Properties-Datei
private static final String PARAMETER_TAG = "&&&";
-
- /**
- * Benutzer-Antwort-Constanten orientieren sich auf die
- * Constanten der ButtonDialog-Klasse
- */
-
// Default-Values
private static String actMessId = null;
- // private static MessagesDialog nobuttonDialog = null;
private Translator res = null;
private Log logger;
@@ -130,7 +104,7 @@
}
/**
- * Ersetzt die eventuellen Platzhalter durch die übergebenen Parameter
+ * Prepares the message using the parameters.
*/
String prepareMessage(final String rawText, final String[] par) {
logger.info("prepareMessage(): " + rawText + ", parameter: "
Modified: trunk/foray/foray-render/src/java/org/foray/render/pcl/PCLRenderer.java
===================================================================
--- trunk/foray/foray-render/src/java/org/foray/render/pcl/PCLRenderer.java 2007-02-26 14:19:27 UTC (rev 8761)
+++ trunk/foray/foray-render/src/java/org/foray/render/pcl/PCLRenderer.java 2007-02-26 14:49:40 UTC (rev 8762)
@@ -252,7 +252,7 @@
}
/**
- * add a filled rectangle to the current stream
+ * Add a filled rectangle to the current stream.
*
* @param x the x position of left edge in millipoints
* @param y the y position of top edge in millipoints
Modified: trunk/foray/foray-render/src/java/org/foray/render/ps/PSGraphics2D.java
===================================================================
--- trunk/foray/foray-render/src/java/org/foray/render/ps/PSGraphics2D.java 2007-02-26 14:19:27 UTC (rev 8761)
+++ trunk/foray/foray-render/src/java/org/foray/render/ps/PSGraphics2D.java 2007-02-26 14:49:40 UTC (rev 8762)
@@ -119,7 +119,7 @@
}
/**
- * This constructor supports the create method
+ * Constructor supporting the {@link #create()} method.
*/
public PSGraphics2D(final PSGraphics2D g) {
super(g);
Modified: trunk/foray/foray-render/src/java/org/foray/render/ps/RunLengthEncodeOutputStream.java
===================================================================
--- trunk/foray/foray-render/src/java/org/foray/render/ps/RunLengthEncodeOutputStream.java 2007-02-26 14:19:27 UTC (rev 8761)
+++ trunk/foray/foray-render/src/java/org/foray/render/ps/RunLengthEncodeOutputStream.java 2007-02-26 14:49:40 UTC (rev 8762)
@@ -72,6 +72,7 @@
/**
+ * Writes a byte.
* @see java.io.OutputStream#write(int)
* @param b the <code>byte</code>.
* @exception IOException if an I/O error occurs. In particular,
@@ -162,9 +163,7 @@
/**
- * @see java.io.OutputStream#write(byte[])
- * @param b the data.
- * @exception IOException if an I/O error occurs.
+ * {@inheritDoc}
*/
public void write(final byte[] b)
throws IOException {
@@ -176,13 +175,7 @@
/**
- * @see java.io.OutputStream#write(byte[], int, int)
- * @param b the data.
- * @param off the start offset in the data.
- * @param len the number of bytes to write.
- * @exception IOException if an I/O error occurs. In particular,
- * an <code>IOException</code> is thrown if the output
- * stream is closed.
+ * {@inheritDoc}
*/
public void write(final byte[] b, final int off, final int len)
throws IOException {
Modified: trunk/foray/scripts/checkstyle-suppressions.xml
===================================================================
--- trunk/foray/scripts/checkstyle-suppressions.xml 2007-02-26 14:19:27 UTC (rev 8761)
+++ trunk/foray/scripts/checkstyle-suppressions.xml 2007-02-26 14:49:40 UTC (rev 8762)
@@ -16,7 +16,7 @@
files="org.foray.pdf.*"/>
<suppress checks="Javadoc[MVS].*"
files="org.foray.pioneer.*"/>
- <suppress checks="Javadoc[MVS].*"
+ <suppress checks="Javadoc[MV].*"
files="org.foray.render.*"/>
<!-- Suppress Javadoc package documentation for test directories. -->
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <vic...@us...> - 2007-02-26 15:05:51
|
Revision: 8763
http://svn.sourceforge.net/foray/?rev=8763&view=rev
Author: victormote
Date: 2007-02-26 07:05:51 -0800 (Mon, 26 Feb 2007)
Log Message:
-----------
Javadoc improvements.
Modified Paths:
--------------
trunk/foray/foray-pioneer/src/java/org/foray/pioneer/AbstractFlowPL.java
trunk/foray/foray-pioneer/src/java/org/foray/pioneer/BlockPL.java
trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FONodePL.java
trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FOTextPL.java
trunk/foray/foray-pioneer/src/java/org/foray/pioneer/PioneerLS.java
trunk/foray/foray-pioneer/src/java/org/foray/pioneer/RowCellArray.java
trunk/foray/foray-pioneer/src/java/org/foray/pioneer/TableRowPL.java
trunk/foray/scripts/checkstyle-suppressions.xml
Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/AbstractFlowPL.java
===================================================================
--- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/AbstractFlowPL.java 2007-02-26 14:49:40 UTC (rev 8762)
+++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/AbstractFlowPL.java 2007-02-26 15:05:51 UTC (rev 8763)
@@ -63,13 +63,15 @@
}
/**
- * @param status The _status to set.
+ * Sets the status.
+ * @param status The status to set.
*/
public void setStatus(final int status) {
this.status = status;
}
/**
+ * Returns the progress snapshot.
* @return Returns the progressSnapshot.
*/
public List<Integer> getProgressSnapshot() {
@@ -77,6 +79,7 @@
}
/**
+ * Saves a progress snapshot.
* @param progressSnapshot The progressSnapshot to be saved.
*/
public void setProgressSnapshot(final List<Integer> progressSnapshot) {
Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/BlockPL.java
===================================================================
--- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/BlockPL.java 2007-02-26 14:49:40 UTC (rev 8762)
+++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/BlockPL.java 2007-02-26 15:05:51 UTC (rev 8763)
@@ -183,6 +183,7 @@
}
/**
+ * Set the current line area.
* @param currentLineArea The currentLineArea to set.
*/
public void setCurrentLineArea(final LineArea currentLineArea) {
Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FONodePL.java
===================================================================
--- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FONodePL.java 2007-02-26 14:49:40 UTC (rev 8762)
+++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FONodePL.java 2007-02-26 15:05:51 UTC (rev 8763)
@@ -105,6 +105,7 @@
}
/**
+ * Returns the progress value for this node.
* @return Returns the progress value.
*/
public int getProgress() {
@@ -152,6 +153,7 @@
}
/**
+ * Adds a text item to the line.
* @return The index into the text (char []) to the first character that
* was <em>not</em> successfully added to the line.
*/
@@ -182,6 +184,7 @@
}
/**
+ * Adds a non-text item to the line.
* @return For non-text items, returns 1 for success or 0 if the item did
* not fit onto the current line.
*/
@@ -270,6 +273,7 @@
public abstract FONode getFONode();
/**
+ * Returns the layout strategy.
* @return Returns the layout.
*/
public PioneerLS getLayout() {
Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FOTextPL.java
===================================================================
--- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FOTextPL.java 2007-02-26 14:49:40 UTC (rev 8762)
+++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FOTextPL.java 2007-02-26 15:05:51 UTC (rev 8763)
@@ -68,6 +68,7 @@
}
/**
+ * Adds text from this text item.
* @return The index into the text char array that indicates the next array
* element that should be laid out, or -1 if all of the text was succesfully
* laid out. If the first six characters have been laid out (indices 0-5),
Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/PioneerLS.java
===================================================================
--- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/PioneerLS.java 2007-02-26 14:49:40 UTC (rev 8762)
+++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/PioneerLS.java 2007-02-26 15:05:51 UTC (rev 8763)
@@ -126,6 +126,7 @@
* <li>A new page is created.</li>
* <li>Using the status markers as guides, layout control is returned to the
* place where it previously left off.</li>
+ * </ul>
*/
public class PioneerLS extends LayoutStrategy implements ProxyFactory {
@@ -152,7 +153,7 @@
}
/**
- * Runs the formatting of this page sequence into the given area tree
+ * Runs the formatting of this page sequence into the given area tree.
*/
public void processPageSequence(final PageCollection pageCollection)
throws AreaWException {
Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/RowCellArray.java
===================================================================
--- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/RowCellArray.java 2007-02-26 14:49:40 UTC (rev 8762)
+++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/RowCellArray.java 2007-02-26 15:05:51 UTC (rev 8763)
@@ -73,7 +73,7 @@
/**
- * Return type of cell in colNum (1 based)
+ * Return type of cell in colNum (1 based).
*/
public int getCellType(final int colNum) {
if (colNum > 0 && colNum <= cells.length) {
@@ -83,7 +83,7 @@
}
/**
- * Return cell in colNum (1 based)
+ * Return cell in colNum (1 based).
*/
public TableCell getCell(final int colNum) {
if (colNum > 0 && colNum <= cells.length) {
@@ -93,7 +93,7 @@
}
/**
- * Store cell starting at cellColNum (1 based) and spanning numCols
+ * Store cell starting at cellColNum (1 based) and spanning numCols.
* If any of the columns is already occupied, return false, else true
*/
public boolean storeCell(final TableCell cell, final int colNum,
Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/TableRowPL.java
===================================================================
--- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/TableRowPL.java 2007-02-26 14:49:40 UTC (rev 8762)
+++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/TableRowPL.java 2007-02-26 15:05:51 UTC (rev 8763)
@@ -289,6 +289,7 @@
}
/**
+ * Sets the ignore keep-together value.
* @param ignoreKeepTogether The bIgnoreKeepTogether to set.
*/
public void setBIgnoreKeepTogether(final boolean ignoreKeepTogether) {
Modified: trunk/foray/scripts/checkstyle-suppressions.xml
===================================================================
--- trunk/foray/scripts/checkstyle-suppressions.xml 2007-02-26 14:49:40 UTC (rev 8762)
+++ trunk/foray/scripts/checkstyle-suppressions.xml 2007-02-26 15:05:51 UTC (rev 8763)
@@ -14,7 +14,7 @@
files="org.foray.fotree.*"/>
<suppress checks="Javadoc[MVS].*"
files="org.foray.pdf.*"/>
- <suppress checks="Javadoc[MVS].*"
+ <suppress checks="Javadoc[MV].*"
files="org.foray.pioneer.*"/>
<suppress checks="Javadoc[MV].*"
files="org.foray.render.*"/>
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <vic...@us...> - 2007-02-26 16:09:32
|
Revision: 8764
http://svn.sourceforge.net/foray/?rev=8764&view=rev
Author: victormote
Date: 2007-02-26 08:09:30 -0800 (Mon, 26 Feb 2007)
Log Message:
-----------
Javadoc improvements.
Modified Paths:
--------------
trunk/foray/doc/web/app/using/release.html
trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFAnnotList.java
trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFAnnotation.java
trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFArray.java
trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFBorderStyle.java
trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFCIDFont.java
trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFCMap.java
trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFCharProcs.java
trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFDocument.java
trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFEncoding.java
trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFEncryption.java
trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFFileSpec.java
trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFFont.java
trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFFontDescriptor.java
trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFFunction.java
trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFGoTo.java
trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFGoToRemote.java
trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFInfo.java
trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFLink.java
trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFObject.java
trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFOutline.java
trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFOutlineItem.java
trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFOutlineParent.java
trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFPage.java
trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFPages.java
trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFPattern.java
trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFRectangle.java
trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFResources.java
trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFRoot.java
trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFShading.java
trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFStream.java
trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFString.java
trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFUri.java
trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFWArray.java
trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFXForm.java
trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFXObject.java
trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFXReference.java
trunk/foray/foray-pdf/src/java/org/foray/pdf/svg/batik/PDFDocumentGraphics2D.java
trunk/foray/foray-pdf/src/java/org/foray/pdf/svg/batik/PDFGraphics2D.java
trunk/foray/foray-pdf/src/java/org/foray/pdf/svg/batik/PDFGraphicsConfiguration.java
trunk/foray/foray-pdf/src/java/org/foray/pdf/svg/batik/PDFGraphicsDevice.java
trunk/foray/foray-pdf/src/java/org/foray/pdf/svg/batik/PDFTextPainter.java
trunk/foray/scripts/checkstyle-suppressions.xml
Modified: trunk/foray/doc/web/app/using/release.html
===================================================================
--- trunk/foray/doc/web/app/using/release.html 2007-02-26 15:05:51 UTC (rev 8763)
+++ trunk/foray/doc/web/app/using/release.html 2007-02-26 16:09:30 UTC (rev 8764)
@@ -51,8 +51,8 @@
its methods have been replaced by standar Java 5.0 String and Character
methods.</li>
<li>Completion of javadoc API documentation for the FOrayGraphic,
- FOrayHyphen-R, FOrayOutput, FOrayLayout, FOrayText, FOrayApp, and FOrayCore
- modules.</li>
+ FOrayHyphen-R, FOrayOutput, FOrayLayout, FOrayText, FOrayMIF, FOrayApp, and
+ FOrayCore modules.</li>
<li>The FOrayGraphicServer constructor no longer requires the name of the
parser class as a parameter.</li>
</ul>
Modified: trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFAnnotList.java
===================================================================
--- trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFAnnotList.java 2007-02-26 15:05:51 UTC (rev 8763)
+++ trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFAnnotList.java 2007-02-26 16:09:30 UTC (rev 8764)
@@ -36,7 +36,7 @@
*/
public class PDFAnnotList extends PDFObject {
- /** Collection of PDFAnnotation objects */
+ /** Collection of PDFAnnotation objects. */
private List<PDFAnnotation> annotations
= new ArrayList<PDFAnnotation>();
Modified: trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFAnnotation.java
===================================================================
--- trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFAnnotation.java 2007-02-26 15:05:51 UTC (rev 8763)
+++ trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFAnnotation.java 2007-02-26 16:09:30 UTC (rev 8764)
@@ -38,7 +38,7 @@
private Rectangle2D rectangle;
/**
- * create objects associated with a link annotation (GoToR)
+ * Create objects associated with a link annotation (GoToR).
*
* @param doc {@inheritDoc}
* @param r The rectangle which outlines the link.
@@ -49,6 +49,7 @@
}
/**
+ * Returns the rectange for this annotation.
* @return Returns the rectangle.
*/
public Rectangle2D getRectangle() {
Modified: trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFArray.java
===================================================================
--- trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFArray.java 2007-02-26 15:05:51 UTC (rev 8763)
+++ trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFArray.java 2007-02-26 16:09:30 UTC (rev 8764)
@@ -31,7 +31,7 @@
import org.foray.common.StringUtil;
/**
- * class representing an array object
+ * A PDF array object.
*/
public class PDFArray extends PDFObject {
@@ -48,9 +48,7 @@
}
/**
- * produce the PDF representation for the object
- *
- * @return the PDF
+ * {@inheritDoc}
*/
public String toPDF() {
final StringBuffer buffer = new StringBuffer();
Modified: trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFBorderStyle.java
===================================================================
--- trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFBorderStyle.java 2007-02-26 15:05:51 UTC (rev 8763)
+++ trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFBorderStyle.java 2007-02-26 16:09:30 UTC (rev 8764)
@@ -51,7 +51,7 @@
private byte style = -1;
/**
- * Create a PDFBorderStyle object
+ * Create a PDFBorderStyle object.
* @param doc {@inheritDoc}
* @param width The width, in points, of the border to be drawn. A width
* of 0 disables border drawing.
Modified: trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFCIDFont.java
===================================================================
--- trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFCIDFont.java 2007-02-26 15:05:51 UTC (rev 8763)
+++ trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFCIDFont.java 2007-02-26 16:09:30 UTC (rev 8764)
@@ -91,9 +91,7 @@
}
/**
- * produce the PDF representation for the object
- *
- * @return the PDF
+ * {@inheritDoc}
*/
public String toPDF() {
final Font font = fsFont.getFont();
@@ -257,6 +255,7 @@
}
/**
+ * Returns the system-info for this font.
* @return Returns the systemInfo.
*/
public PDFCIDSystemInfo getSystemInfo() {
Modified: trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFCMap.java
===================================================================
--- trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFCMap.java 2007-02-26 15:05:51 UTC (rev 8763)
+++ trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFCMap.java 2007-02-26 16:09:30 UTC (rev 8764)
@@ -40,91 +40,158 @@
*/
public class PDFCMap extends PDFStream {
- /**
- * Chinese (simplified)
- */
+ /** A CMap for Chinese (simplified). */
public static final String GB_EUC_H = "GB-EUC-H";
+
+ /** A CMap for Chinese (simplified). */
public static final String GB_EUC_V = "GB_EUC-V";
+
+ /** A CMap for Chinese (simplified). */
public static final String GBPC_EUC_H = "GBpc-EUC-H";
+
+ /** A CMap for Chinese (simplified). */
public static final String GBPC_EUC_V = "GBpc-EUC-V";
+
+ /** A CMap for Chinese (simplified). */
public static final String GBK_EUC_H = "GBK-EUC-H";
+
+ /** A CMap for Chinese (simplified). */
public static final String GBK_EUC_V = "GBK-EUC-V";
+
+ /** A CMap for Chinese (simplified). */
public static final String UNIGB_UCS2_H = "UniGB-UCS2-H";
+
+ /** A CMap for Chinese (simplified). */
public static final String UNIGB_UCS2_V = "UniGB-UCS2-V";
- /**
- * Chinese (traditional)
- */
+ /** A CMap for Chinese (traditional). */
public static final String B5PC_H = "B5pc-H";
+
+ /** A CMap for Chinese (traditional). */
public static final String B5PC_V = "B5pc-V";
+
+ /** A CMap for Chinese (traditional). */
public static final String ETEN_B5_H = "ETen-B5-H";
+
+ /** A CMap for Chinese (traditional). */
public static final String ETEN_B5_V = "ETen-B5-V";
+
+ /** A CMap for Chinese (traditional). */
public static final String ETENMS_B5_H = "ETenms-B5-H";
+
+ /** A CMap for Chinese (traditional). */
public static final String ETENMS_B5_V = "ETenms-B5-V";
+
+ /** A CMap for Chinese (traditional). */
public static final String CNS_EUC_H = "CNS-EUC-H";
+
+ /** A CMap for Chinese (traditional). */
public static final String CNS_EUC_V = "CNS-EUC-V";
+
+ /** A CMap for Chinese (traditional). */
public static final String UNICNS_UCS2_H = "UniCNS-UCS2-H";
+
+ /** A CMap for Chinese (traditional). */
public static final String UNICNS_UCS2_V = "UniCNS-UCS2-V";
- /**
- * Japanese
- */
- public static final String J83PV_RKSJ_H = "83pv-RKSJ-H"; // no V version
+ /** A CMap for Japanese. Note that there is no "V" version. */
+ public static final String J83PV_RKSJ_H = "83pv-RKSJ-H";
+
+ /** A CMap for Japanese. */
public static final String J90MS_RKSJ_H = "90ms-RKSJ-H";
+
+ /** A CMap for Japanese. */
public static final String J90MS_RKSJ_V = "90ms-RKSJ-V";
+
+ /** A CMap for Japanese. */
public static final String J90MSP_RKSJ_H = "90msp-RKSJ-H";
+
+ /** A CMap for Japanese. */
public static final String J90MSP_RKSJ_V = "90msp-RKSJ-V";
- public static final String J90PV_RKSJ_H = "90pv-RKSJ-H"; // no V version
+
+ /** A CMap for Japanese. Note that there is no "V" version. */
+ public static final String J90PV_RKSJ_H = "90pv-RKSJ-H";
+
+ /** A CMap for Japanese. */
public static final String ADD_RKSJ_H = "Add-RKSJ-H";
+
+ /** A CMap for Japanese. */
public static final String ADD_RKSJ_V = "Add-RKSJ-V";
+
+ /** A CMap for Japanese. */
public static final String EUC_H = "EUC-H";
+
+ /** A CMap for Japanese. */
public static final String EUC_V = "EUC-V";
+
+ /** A CMap for Japanese. */
public static final String EXT_RKSJ_H = "Ext-RKSJ-H";
+
+ /** A CMap for Japanese. */
public static final String EXT_RKSJ_V = "Ext-RKSJ-V";
+
+ /** A CMap for Japanese. */
public static final String H = "H";
+
+ /** A CMap for Japanese. */
public static final String V = "V";
+
+ /** A CMap for Japanese. */
public static final String UNIJIS_UCS2_H = "UniJIS-UCS2-H";
+
+ /** A CMap for Japanese. */
public static final String UNIJIS_UCS2_V = "UniJIS-UCS2-V";
+
+ /** A CMap for Japanese. */
public static final String UNIJIS_UCS2_HW_H = "UniJIS-UCS2-HW-H";
+
+ /** A CMap for Japanese. */
public static final String UNIJIS_UCS2_HW_V = "UniJIS-UCS2-HW-V";
- /**
- * Korean
- */
+ /** A CMap for Korean. */
public static final String KSC_EUC_H = "KSC-EUC-H";
+
+ /** A CMap for Korean. */
public static final String KSC_EUC_V = "KSC-EUC-V";
+
+ /** A CMap for Korean. */
public static final String KSCMS_UHC_H = "KSCms-UHC-H";
+
+ /** A CMap for Korean. */
public static final String KSCMS_UHC_V = "KSCms-UHC-V";
+
+ /** A CMap for Korean. */
public static final String KSCMS_UHC_HW_H = "KSCms-UHC-HW-H";
+
+ /** A CMap for Korean. */
public static final String KSCMS_UHC_HW_V = "KSCms-UHC-HW-V";
- public static final String KSCPC_EUC_H = "KSCpc-EUC-H"; // no V version
+
+ /** A CMap for Korean. Note that there is no "V" version. */
+ public static final String KSCPC_EUC_H = "KSCpc-EUC-H";
+
+ /** A CMap for Korean. */
public static final String UNIKSC_UCS2_H = "UniKSC-UCS2-H";
+
+ /** A CMap for Korean. */
public static final String UNIKSC_UCS2_V = "UniKSC-UCS2-V";
- /**
- * Generic
- */
+ /** A Generic horizontal CMap. */
public static final String IDENTITY_H = "Identity-H";
+
+ /** A Generic vertical CMap. */
public static final String IDENTITY_V = "Identity-V";
- /**
- * horizontal writing direction
- */
+ /** Constant indicating the horizontal writing direction. */
public static final byte WMODE_HORIZONTAL = 0;
- /**
- * vertical writing direction
- */
+ /** Constant indicating the vertical writing direction. */
public static final byte WMODE_VERTICAL = 1;
- /**
- * /CMapName attribute, one of the predefined constants
- */
+ /** The /CMapName attribute, one of the predefined constants. */
private String name;
/**
- * create the /CMap object
- *
+ * Create the /CMap object.
* @param name one the registered names (see Table 7.20 on p 215)
*/
public PDFCMap(final PDFDocument doc, final String name) {
Modified: trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFCharProcs.java
===================================================================
--- trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFCharProcs.java 2007-02-26 15:05:51 UTC (rev 8763)
+++ trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFCharProcs.java 2007-02-26 16:09:30 UTC (rev 8764)
@@ -42,18 +42,18 @@
*/
public class PDFCharProcs extends PDFObject {
+ /** The (character name, drawing stream) pairs for a Type3 font. */
+ private Map<String, PDFStream> keys;
+
/**
- * the (character name, drawing stream) pairs for a Type3 font
+ * Constructor.
*/
- private Map<String, PDFStream> keys;
-
public PDFCharProcs() {
keys = new HashMap<String, PDFStream>();
}
/**
- * add a character definition in the dictionary
- *
+ * Add a character definition in the dictionary.
* @param name the character name
* @param stream the stream that draws the character
*/
@@ -62,10 +62,10 @@
}
/**
- * not done yet
+ * {@inheritDoc}
*/
public String toPDF() {
- // TODO: implement this PDFObject abstract method
+ // TODO: Implement this.
return new String();
}
Modified: trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFDocument.java
===================================================================
--- trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFDocument.java 2007-02-26 15:05:51 UTC (rev 8763)
+++ trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFDocument.java 2007-02-26 16:09:30 UTC (rev 8764)
@@ -94,9 +94,7 @@
* written. */
private int pdfVersion = PDF_VERSION_1_6;
- /**
- * the current character position
- */
+ /** The current character position. */
private int position = 0;
/**
@@ -121,32 +119,22 @@
* @see #indirectObjects */
private List<PDFObject> indirectObjectsLast = new ArrayList<PDFObject>();
- /**
- * the /Root object
- */
+ /** The /Root object. */
private PDFRoot root;
- /**
- * the /Info object
- */
+ /** The /Info object. */
private PDFInfo info;
- /**
- * the /Resources object
- */
+ /** The /Resources object. */
private PDFResources resources;
- /**
- * the documents encryption, if exists
- */
+ /** The documents encryption, if any. */
private PDFEncryption encryption;
- /**
- * the colorspace
- */
+ /** The colorspace for this document. */
private ColorSpace colorspace = ColorSpace.getInstance(ColorSpace.CS_sRGB);
-
+ /** The current graphic state for this document. */
private PDFGraphicsState currentGraphicsState;
/** The counter for Pattern name numbering. */
@@ -261,10 +249,8 @@
return this.root.getOutlineRoot();
}
- /**
- * get the /Resources object for the document
- *
- * @return the /Resources object
+ /** Returns the /Resources object for the document.
+ * @return The /Resources object.
*/
public PDFResources getResources() {
return this.resources;
@@ -305,7 +291,8 @@
}
/**
- * @param object
+ * Records the location of a given object in the document.
+ * @param object The object whose location should be marked.
*/
private void recordLocation(final PDFObject object) {
/* Ensure there is room in the locations xref for the number of
@@ -340,9 +327,8 @@
}
/**
- * write the trailer
- *
- * @param stream the OutputStream to write the trailer to
+ * Write the document trailer.
+ * @param stream The OutputStream to which the trailer should be written.
*/
private void outputTrailer(final OutputStream stream) throws IOException {
writeIndirectObjects(stream);
@@ -401,10 +387,9 @@
}
/**
- * write the xref table
- *
- * @param stream the OutputStream to write the xref table to
- * @return the number of characters written
+ * Write the xref table.
+ * @param stream the OutputStream to which the xref table should be written.
+ * @return The number of characters written.
*/
private int outputXref(final OutputStream stream) throws IOException {
/* construct initial part of xref */
@@ -541,7 +526,8 @@
}
/**
- * @return Returns the defaultBorderStyle.
+ * Returns the default border style for this document.
+ * @return Returns the default border style.
*/
public PDFBorderStyle getDefaultBorderStyle() {
return defaultBorderStyle;
Modified: trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFEncoding.java
===================================================================
--- trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFEncoding.java 2007-02-26 15:05:51 UTC (rev 8763)
+++ trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFEncoding.java 2007-02-26 16:09:30 UTC (rev 8764)
@@ -72,9 +72,7 @@
}
/**
- * produce the PDF representation for the object
- *
- * @return the PDF
+ * {@inheritDoc}
*/
public String toPDF() {
if (this.encoding.isPredefinedPDF()) {
Modified: trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFEncryption.java
===================================================================
--- trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFEncryption.java 2007-02-26 15:05:51 UTC (rev 8763)
+++ trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFEncryption.java 2007-02-26 16:09:30 UTC (rev 8764)
@@ -55,30 +55,34 @@
public class EncryptionFilter extends PSFilter {
private PDFEncryption encryption;
- /** The constructor for the internal PDFEncryption filter
- * @param encryption The encryption object to use
+ /**
+ * The constructor for the internal PDFEncryption filter.
+ * @param encryption The encryption object to use.
*/
public EncryptionFilter(final PDFEncryption encryption) {
super();
this.encryption = encryption;
}
- /** return a PDF string representation of the filter. In this
- * case no filter name is passed.
- * @return The filter name, blank in this case
+ /**
+ * Return a PDF string representation of the filter.
+ * In this case no filter name is passed.
+ * @return The filter name, blank in this case.
*/
public String getName() {
return "";
}
- /** return a parameter dictionary for this filter, or null
+ /**
+ * Return a parameter dictionary for this filter, or null.
* @return The parameter dictionary. In this case, null.
*/
public String getDecodeParms() {
return null;
}
- /** encode the given data with the filter
+ /**
+ * Encode the given data with the filter.
* @param data The data to be encrypted
* @return The encrypted data
*/
@@ -95,15 +99,16 @@
}
+ /** Constant for printing permission. */
public static final int PERMISSION_PRINT = 4;
- /** Value of content editting permission
- */
+
+ /** Constant for content editing permission. */
public static final int PERMISSION_EDIT_CONTENT = 8;
- /** Value of content extraction permission
- */
+
+ /** Constant for content extraction permission. */
public static final int PERMISSION_COPY_CONTENT = 16;
- /** Value of annotation editting permission
- */
+
+ /** Constant for annotation editing permission. */
public static final int PERMISSION_EDIT_ANNOTATIONS = 32;
static final char [] PAD = {
@@ -166,8 +171,9 @@
this.userPassword = value;
}
- /** Returns the current user password
- * @return The user password
+ /**
+ * Returns the current user password.
+ * @return The user password.
*/
public String getUserPassword() {
return this.userPassword;
@@ -180,8 +186,9 @@
this.ownerPassword = value;
}
- /** Returns the owner password for the PDF
- * @return The owner password
+ /**
+ * Returns the owner password for the PDF.
+ * @return The owner password.
*/
public String getOwnerPassword() {
return this.ownerPassword;
@@ -208,8 +215,9 @@
this.allowEditContent = value;
}
- /** Set whether the document will allow annotation modificcations
- * @param value The new permission value
+ /**
+ * Set whether the document will allow annotation modifications.
+ * @param value The new permission value.
*/
public void setAllowEditAnnotation(final boolean value) {
this.allowEditAnnotations = value;
@@ -248,8 +256,9 @@
return buffer.toString();
}
- /** Returns the document file ID
- * @return The file ID
+ /**
+ * Returns the document file ID.
+ * @return The file ID.
*/
public byte [] getFileID() {
if (fileID == null) {
@@ -260,9 +269,10 @@
return fileID;
}
- /** This method returns the indexed file ID
- * @param index The index to access the file ID
- * @return The file ID
+ /**
+ * This method returns the indexed file ID.
+ * @param index The index to access the file ID.
+ * @return The file ID.
*/
public String getFileID(final int index) {
if (index == 1) {
@@ -301,7 +311,8 @@
return encryptWithKey(data, key);
}
- /** This method initializes the encryption algorithms and values
+ /**
+ * Initializes the encryption algorithms and values.
*/
public void init() {
// Generate the owner value
@@ -399,17 +410,16 @@
return encryptWithHash(data, hash, hash.length);
}
- /** Creates PSFilter for the encryption object
- * @return The resulting filter
+ /**
+ * Creates PSFilter for the encryption object.
+ * @return The resulting filter.
*/
public PSFilter makeFilter() {
return new EncryptionFilter(this);
}
/**
- * represent the object in PDF
- *
- * @return the PDF
+ * {@inheritDoc}
*/
public String toPDF() {
if (this.dictionary == null) {
Modified: trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFFileSpec.java
===================================================================
--- trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFFileSpec.java 2007-02-26 15:05:51 UTC (rev 8763)
+++ trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFFileSpec.java 2007-02-26 16:09:30 UTC (rev 8764)
@@ -34,9 +34,7 @@
*/
public class PDFFileSpec extends PDFObject {
- /**
- * the filename
- */
+ /** The filename. */
private String filename;
/**
@@ -50,9 +48,7 @@
}
/**
- * represent the object in PDF
- *
- * @return the PDF string
+ * {@inheritDoc}
*/
public String toPDF() {
final String p = new String(pdfID() + EOL
Modified: trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFFont.java
===================================================================
--- trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFFont.java 2007-02-26 15:05:51 UTC (rev 8763)
+++ trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFFont.java 2007-02-26 16:09:30 UTC (rev 8764)
@@ -89,14 +89,11 @@
*/
private PDFEncoding pdfEncoding;
- /**
- * descriptor of font metrics
- */
+ /** The descriptor of font metrics. */
private PDFFontDescriptor descriptor = null;
/**
- * Create the /Font object
- *
+ * Create the /Font object.
* @param doc The parent PDF document.
* @param fsFont The FreeStandingFont which is the basis for this PDF Font.
*/
@@ -136,9 +133,7 @@
}
/**
- * get the internal name used for this font
- *
- * @return the internal name
+ * {@inheritDoc}
*/
public String getName() {
return "F" + this.fontCount;
@@ -153,9 +148,7 @@
}
/**
- * produce the PDF representation for the object
- *
- * @return the PDF
+ * {@inheritDoc}
*/
public String toPDF() {
final StringBuffer buffer = new StringBuffer();
@@ -324,7 +317,7 @@
}
/**
- *
+ * Return the font subtype.
* @param font The Font whose PDF subtype is needed.
* @return One of {@link PDFFont#TYPE0}, {@link PDFFont#TYPE1}, or
* {@link PDFFont#TRUETYPE}.
@@ -344,7 +337,8 @@
}
/**
- * @return Returns the fsFont.
+ * Return the font-system font wrapped by this PDF font.
+ * @return Returns the font-system font.
*/
public FontUse getFsFont() {
return fsFont;
@@ -362,6 +356,7 @@
}
/**
+ * Returs the font descriptor for this font.
* @return Returns the descriptor.
*/
public PDFFontDescriptor getDescriptor() {
Modified: trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFFontDescriptor.java
===================================================================
--- trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFFontDescriptor.java 2007-02-26 15:05:51 UTC (rev 8763)
+++ trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFFontDescriptor.java 2007-02-26 16:09:30 UTC (rev 8764)
@@ -67,7 +67,7 @@
}
/**
- * make a /FontDescriptor object
+ * Construct a /FontDescriptor object.
*/
public static PDFFontDescriptor makeFontDescriptor(final PDFDocument pdfDoc,
final PDFFont font) {
@@ -84,7 +84,7 @@
}
/**
- * set the optional metrics
+ * Set the optional metrics.
*/
public void setMetrics(final int avgWidth, final int maxWidth,
final int missingWidth, final int leading, final int stemH,
@@ -98,8 +98,7 @@
}
/**
- * set the optional font file stream
- *
+ * Set the optional font file stream.
* @param subtype the font type defined in the font stream
* @param fontfile the stream containing an embedded font
*/
@@ -108,12 +107,8 @@
this.fontfile = fontfile;
}
- // public void setCharSet(){}//for subset fonts
-
/**
- * produce the PDF representation for the object
- *
- * @return the PDF
+ * {@inheritDoc}
*/
public String toPDF() {
final Font font = this.font.getFontUse().getFont();
Modified: trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFFunction.java
===================================================================
--- trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFFunction.java 2007-02-26 15:05:51 UTC (rev 8763)
+++ trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFFunction.java 2007-02-26 16:09:30 UTC (rev 8764)
@@ -77,16 +77,12 @@
*/
private int functionType = 0; // Default
- /**
- * Required: 2 * m Array of Double numbers which are possible inputs to the
- * function
- */
+ /** Required: 2 * m Array of Double numbers which are possible inputs to the
+ * function. */
private List domain = null;
- /**
- * Required: 2 * n Array of Double numbers which are possible outputs to
- * the function
- */
+ /** Required: 2 * n Array of Double numbers which are possible outputs to
+ * the function. */
private List range = null;
/* ********************TYPE 0***************************** */
Modified: trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFGoTo.java
===================================================================
--- trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFGoTo.java 2007-02-26 15:05:51 UTC (rev 8763)
+++ trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFGoTo.java 2007-02-26 16:09:30 UTC (rev 8764)
@@ -52,9 +52,7 @@
/**
- * represent the object in PDF
- *
- * @return the PDF string
+ * {@inheritDoc}
*/
public String toPDF() {
final StringBuffer buffer = new Strin...
[truncated message content] |
|
From: <vic...@us...> - 2007-02-26 17:01:47
|
Revision: 8765
http://svn.sourceforge.net/foray/?rev=8765&view=rev
Author: victormote
Date: 2007-02-26 09:01:43 -0800 (Mon, 26 Feb 2007)
Log Message:
-----------
Javadoc improvements.
Modified Paths:
--------------
trunk/foray/foray-areatree/src/java/org/foray/area/Area.java
trunk/foray/foray-areatree/src/java/org/foray/area/AreaFlexible.java
trunk/foray/foray-areatree/src/java/org/foray/area/AreaNode.java
trunk/foray/foray-areatree/src/java/org/foray/area/AreaTree.java
trunk/foray/foray-areatree/src/java/org/foray/area/ExternalGraphicArea.java
trunk/foray/foray-areatree/src/java/org/foray/area/FOLinkageNormal.java
trunk/foray/foray-areatree/src/java/org/foray/area/LeaderArea.java
trunk/foray/foray-areatree/src/java/org/foray/area/LineArea.java
trunk/foray/foray-areatree/src/java/org/foray/area/NormalBlockArea.java
trunk/foray/foray-areatree/src/java/org/foray/area/PageNumberArea.java
trunk/foray/foray-areatree/src/java/org/foray/area/PageNumberCitationArea.java
trunk/foray/foray-areatree/src/java/org/foray/area/PageRA.java
trunk/foray/foray-areatree/src/java/org/foray/area/SpanRA.java
trunk/foray/foray-areatree/src/java/org/foray/area/TableCellRA.java
trunk/foray/foray-areatree/src/java/org/foray/area/TextArea.java
trunk/foray/scripts/checkstyle-suppressions.xml
Modified: trunk/foray/foray-areatree/src/java/org/foray/area/Area.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/Area.java 2007-02-26 16:09:30 UTC (rev 8764)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/Area.java 2007-02-26 17:01:43 UTC (rev 8765)
@@ -65,7 +65,7 @@
org.axsl.areaW.Area {
/**
- *
+ * Constructor.
* @param generatedBy
* @param parentArea
*/
@@ -111,10 +111,11 @@
}
/**
- * @return The letter-spacing value that should actually be used to render
+ * Returns the letter-spacing value that should actually be used to render
* the document. This is distinguised from the traitLetterSpacingMin,
* ...Opt, and ...Max methods which return the constraints to be placed on
* the computation returned by this method.
+ * @return The letter-spacing.
*/
public int letterSpacing() {
return traitLetterSpacingOpt();
@@ -292,22 +293,22 @@
}
/**
+ * Returns the total amount of the progression-dimension that has been
+ * used by siblings.
* @return The total amount of the progression-dimension that has been
* used by siblings.
*/
public abstract int pdUsedBySiblings();
/**
- * @return The inline-progression-dimension of the border-rectangle for
- * this Area.
+ * {@inheritDoc}
*/
public int brIPD() {
return prIPD() + traitBorderStartWidth() + traitBorderEndWidth();
}
/**
- * @return The block-progression-dimension of the border-rectangle for
- * this Area.
+ * {@inheritDoc}
*/
public int brBPD() {
return prBPD() + traitBorderBeforeWidth() + traitBorderAfterWidth();
@@ -403,6 +404,7 @@
}
/**
+ * Returns the IPD of the PR.
* @return The inline-progression-dimension of the padding-rectangle for
* this Area.
*/
@@ -411,6 +413,7 @@
}
/**
+ * Returns the BPD of the PR.
* @return The block-progression-dimension of the padding-rectangle for
* this Area.
*/
@@ -502,14 +505,12 @@
}
/**
- * @return The inline-progression-dimension of the content-rectangle for
- * this Area.
+ * {@inheritDoc}
*/
public abstract int crIPD();
/**
- * @return The block-progression-dimension of the content-rectangle for
- * this Area.
+ * {@inheritDoc}
*/
public abstract int crBPD();
@@ -557,6 +558,7 @@
}
/**
+ * Returns the reference X value.
* @return The x value (from an appropriate parent) from which this Area's
* content-rectangle is computed, that is, the starting point.
*/
@@ -594,6 +596,7 @@
}
/**
+ * Returns the IPD of the NAR.
* @return The inline-progression-dimension of the
* normal-allocation-rectangle for this Area.
*/
@@ -605,6 +608,7 @@
}
/**
+ * Retursn the BPD of the NAR.
* @return The block-progression-dimension of the
* normal-allocation-rectangle for this Area.
*/
@@ -634,6 +638,7 @@
}
/**
+ * Returns the IPD of the LAR.
* @return The inline-progression-dimension of the
* large-allocation-rectangle for this Area.
*/
@@ -643,6 +648,7 @@
}
/**
+ * Returns the BPD of the LAR.
* @return The block-progression-dimension of the large-allocation-rectangle
* for this Area.
*/
@@ -672,6 +678,7 @@
}
/**
+ * Indicates whether this Area is a block area.
* @return True if this Area is a block-area, false if it is an inline-area.
* Defaults to true. Inline areas should override this method.
*/
@@ -768,24 +775,24 @@
}
/**
- *
- * @return -1 for "auto.
+ * Return the minimum BP dimension for this area.
+ * @return The minimum BP dimension for this area, or -1 for "auto".
*/
public int traitBPDimensionMin() {
return traitGeneratedBy().traitBPDimensionMin(this, nearestBaseBPD());
}
/**
- *
- * @return -1 for "auto.
+ * Return the optimum BP dimension for this area.
+ * @return The optimum BP dimension for this area, or -1 for "auto".
*/
public int traitBPDimensionOpt() {
return traitGeneratedBy().traitBPDimensionOpt(this, nearestBaseBPD());
}
/**
- *
- * @return -1 for "auto.
+ * Return the maximum BP dimension for this area.
+ * @return The maximim BP dimension for this area, or -1 for "auto".
*/
public int traitBPDimensionMax() {
return traitGeneratedBy().traitBPDimensionMax(this, nearestBaseBPD());
@@ -801,24 +808,24 @@
}
/**
- *
- * @return -1 for "auto.
+ * Return the minimum IP dimension for this area.
+ * @return The minimum IP dimension for this area, or -1 for "auto".
*/
public int traitIPDimensionMin() {
return traitGeneratedBy().traitIPDimensionMin(this, nearestBaseIPD());
}
/**
- *
- * @return -1 for "auto.
+ * Return the optimum IP dimension for this area.
+ * @return The optimum IP dimension for this area, or -1 for "auto".
*/
public int traitIPDimensionOpt() {
return traitGeneratedBy().traitIPDimensionOpt(this, nearestBaseIPD());
}
/**
- *
- * @return -1 for "auto.
+ * Return the maximum IP dimension for this area.
+ * @return The maximim IP dimension for this area, or -1 for "auto".
*/
public int traitIPDimensionMax() {
return traitGeneratedBy().traitIPDimensionMax(this, nearestBaseIPD());
@@ -863,8 +870,10 @@
}
/**
- * @return Either AXIS_HORIZONTAL or AXIS_VERTICAL, depending on the
- * relative content stacking axis and the writing-mode.
+ * Return the absolute axis for this area.
+ * @return Either {@link AbsoluteAxis#HORIZONTAL} or
+ * {@link AbsoluteAxis#VERTICAL}, depending on the relative content stacking
+ * axis and the writing-mode.
* @see #contentStackingAxisRelative()
*/
public AbsoluteAxis contentStackingAxisAbsolute() {
@@ -872,9 +881,12 @@
}
/**
- * @return One of DIRECTION_TOP_TO_BOTTOM, DIRECTION_BOTTOM_TO_TOP,
- * DIRECTION_LEFT_TO_RIGHT, or DIRECTION_RIGHT_TO_LEFT, depending on
- * the writing-mode.
+ * Return the absolute direction for this area.
+ * @return One of {@link AbsoluteDirection#TOP_TO_BOTTOM},
+ * {@link AbsoluteDirection#BOTTOM_TO_TOP},
+ * {@link AbsoluteDirection#LEFT_TO_RIGHT},
+ * or {@link AbsoluteDirection#RIGHT_TO_LEFT}, depending on the
+ * writing-mode.
*/
public AbsoluteDirection contentStackingDirectionAbsolute() {
final RelativeAxis relative = contentStackingAxisRelative();
Modified: trunk/foray/foray-areatree/src/java/org/foray/area/AreaFlexible.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/AreaFlexible.java 2007-02-26 16:09:30 UTC (rev 8764)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/AreaFlexible.java 2007-02-26 17:01:43 UTC (rev 8765)
@@ -188,6 +188,7 @@
}
/**
+ * Returns the PD used by this area.
* @return The amount of progression that should be considered "used" by
* this area when computing how much is available in the normal flow.
*/
@@ -199,6 +200,7 @@
}
/**
+ * Returns the IPD for a block area.
* @return The IPD for a block area.
*/
protected int crIPDBlockArea() {
@@ -217,6 +219,7 @@
}
/**
+ * Returns the BPD for an inline area.
* @return The BPD for an inline area.
*/
protected int crBPDInline() {
@@ -259,6 +262,7 @@
}
/**
+ * Adjusts the half-leading if an adjustment is needed.
* @param previous The previous sibling Area to this.
*/
private void checkHalfLeading(final Area previous) {
Modified: trunk/foray/foray-areatree/src/java/org/foray/area/AreaNode.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/AreaNode.java 2007-02-26 16:09:30 UTC (rev 8764)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/AreaNode.java 2007-02-26 17:01:43 UTC (rev 8765)
@@ -328,6 +328,7 @@
}
/**
+ * Returns the font style for this node.
* @return One of {@link FoValue#NORMAL},
* {@link FoValue#ITALIC}, {@link FoValue#OBLIQUE}, or
* {@link FoValue#BACKSLANT}.
@@ -377,6 +378,7 @@
}
/**
+ * Returns the ancestor Span area.
* @return The ancestor SpanRA, or null if there is none.
*/
public SpanRA ancestorSpanRA() {
@@ -388,6 +390,7 @@
}
/**
+ * Returns the ancestor link area.
* @return The ancestor LineArea, or null if there is none.
*/
public LineArea ancestorLineArea() {
Modified: trunk/foray/foray-areatree/src/java/org/foray/area/AreaTree.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/AreaTree.java 2007-02-26 16:09:30 UTC (rev 8764)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/AreaTree.java 2007-02-26 17:01:43 UTC (rev 8765)
@@ -259,6 +259,7 @@
}
/**
+ * Returns the collection of page collections that have been processed.
* @return Returns the pageCollectionsProcessed.
*/
public List<PageCollection> getPageCollectionsProcessed() {
Modified: trunk/foray/foray-areatree/src/java/org/foray/area/ExternalGraphicArea.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/ExternalGraphicArea.java 2007-02-26 16:09:30 UTC (rev 8764)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/ExternalGraphicArea.java 2007-02-26 17:01:43 UTC (rev 8765)
@@ -56,8 +56,9 @@
}
/**
- * @param parentArea
- * @param width
+ * Initializes the graphic.
+ * @param parentArea The parent area.
+ * @param width The width, in millipoints, of the graphic.
*/
private void init(final Area parentArea, final int width) {
setProgressionDimension(width);
Modified: trunk/foray/foray-areatree/src/java/org/foray/area/FOLinkageNormal.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/FOLinkageNormal.java 2007-02-26 16:09:30 UTC (rev 8764)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/FOLinkageNormal.java 2007-02-26 17:01:43 UTC (rev 8765)
@@ -104,6 +104,8 @@
}
/**
+ * Indicates whether a given area is the first one generated by this
+ * linkage.
* @param area An Area instance.
* @return True iff area is the first Area generated by this.
*/
@@ -115,6 +117,8 @@
}
/**
+ * Indicates whether a given area is the last one generated by this
+ * linkage.
* @param area An Area instance.
* @return True iff area is the first Area generated by this.
*/
@@ -126,6 +130,7 @@
}
/**
+ * Returns the number of areas generated by the FO.
* @return The current count of areas that have been generated by the FObj.
*/
public int qtyAreasGenerated() {
@@ -133,6 +138,7 @@
}
/**
+ * Returns the last area node generated by the FO.
* @return The last AreaNode generated by the parent FObj.
*/
public AreaNode getLastGeneratedBy() {
@@ -143,6 +149,7 @@
}
/**
+ * Returns the last Area generated by the FO.
* @return The last Area generated by the parent FObj.
*/
public Area getLastAreaGeneratedBy() {
Modified: trunk/foray/foray-areatree/src/java/org/foray/area/LeaderArea.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/LeaderArea.java 2007-02-26 16:09:30 UTC (rev 8764)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/LeaderArea.java 2007-02-26 17:01:43 UTC (rev 8765)
@@ -82,7 +82,8 @@
}
/**
- * @param initialProgressionDimension
+ * Initializes the progression dimension for this Area.
+ * @param initialProgressionDimension The PD to set.
*/
private void init(final int initialProgressionDimension) {
setProgressionDimension(initialProgressionDimension);
@@ -230,6 +231,7 @@
}
/**
+ * Returns the size of the leader text.
* @return The size, in millipoints, of the text portion of the leader.
* This does not count the leading or trailing space portions.
*/
Modified: trunk/foray/foray-areatree/src/java/org/foray/area/LineArea.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/LineArea.java 2007-02-26 16:09:30 UTC (rev 8764)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/LineArea.java 2007-02-26 17:01:43 UTC (rev 8765)
@@ -176,6 +176,7 @@
}
/**
+ * Computes the amount of space that can be absorbed by leader on this line.
* @param unusedSpace The amount of space, in millipoints, to be absorbed
* on this line. If negative, this amount means that Leaders should
* contract if possible. If positive, this amount means that Leaders
@@ -231,7 +232,7 @@
}
/**
- *
+ * Optimize the specified word-spacing.
*/
private void optimizeSpecifiedWordSpacing() {
final int unusedSpace = this.progressionDimensionAvailable();
@@ -258,6 +259,8 @@
}
/**
+ * Computes the amount of space on this line that can be absorbed by
+ * adjusting the word-spacing.
* @param unusedSpace The remaining amount of space, in millipoints, that
* needs to be absorbed on this line.
* @return The total size, in millipoints, that can be absorbed by
@@ -329,6 +332,8 @@
}
/**
+ * Computes the amount of space on this line that can be absorbed by
+ * adjusting the letter-spacing.
* @param unusedSpace The remaining amount of space, in millipoints, that
* needs to be absorbed on this line.
* @return The total size, in millipoints, that can be absorbed by
@@ -375,7 +380,7 @@
}
/**
- *
+ * Optimize this line for implied word-spacing.
*/
private void optimizeImpliedWordSpacing() {
final int unusedSpace = this.progressionDimensionAvailable();
@@ -443,6 +448,8 @@
}
/**
+ * Indicates whether this is the first line-area generated by the parent
+ * block.
* @return True iff this is the first LineArea instance generated by the
* parent Block.
*/
@@ -457,6 +464,8 @@
}
/**
+ * Indicates whether this is the last line-area generated by the parent
+ * block.
* @return True iff this is the last LineArea instance generated by the
* parent Block.
*/
Modified: trunk/foray/foray-areatree/src/java/org/foray/area/NormalBlockArea.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/NormalBlockArea.java 2007-02-26 16:09:30 UTC (rev 8764)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/NormalBlockArea.java 2007-02-26 17:01:43 UTC (rev 8765)
@@ -126,7 +126,7 @@
}
/**
- * @return Returns the progressionDimension.
+ * {@inheritDoc}
*/
public int getProgressionDimension() {
if (getAreaNodeParent().traitGeneratedBy() instanceof ListItem) {
Modified: trunk/foray/foray-areatree/src/java/org/foray/area/PageNumberArea.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/PageNumberArea.java 2007-02-26 16:09:30 UTC (rev 8764)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/PageNumberArea.java 2007-02-26 17:01:43 UTC (rev 8765)
@@ -53,7 +53,8 @@
}
/**
- * @param width
+ * Initialize the width of this area.
+ * @param width The width, in millipoints, to set.
*/
private void init(final int width) {
setProgressionDimension(width);
Modified: trunk/foray/foray-areatree/src/java/org/foray/area/PageNumberCitationArea.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/PageNumberCitationArea.java 2007-02-26 16:09:30 UTC (rev 8764)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/PageNumberCitationArea.java 2007-02-26 17:01:43 UTC (rev 8765)
@@ -54,7 +54,8 @@
}
/**
- * @param width
+ * Initialize the width of this area.
+ * @param width The width, in millipoints, to set.
*/
private void init(final int width) {
setProgressionDimension(width);
Modified: trunk/foray/foray-areatree/src/java/org/foray/area/PageRA.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/PageRA.java 2007-02-26 16:09:30 UTC (rev 8764)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/PageRA.java 2007-02-26 17:01:43 UTC (rev 8765)
@@ -195,7 +195,7 @@
}
/**
- *
+ * Creates the region-body for this page.
*/
private void createRegionBody(final SimplePageMaster simplePageMaster) {
if (simplePageMaster.getRegionBody() == null) {
@@ -209,7 +209,7 @@
}
/**
- *
+ * Creates the region-before for this page.
*/
private void createRegionBefore(final SimplePageMaster simplePageMaster) {
if (simplePageMaster.getRegionBefore() == null) {
@@ -220,7 +220,7 @@
}
/**
- *
+ * Creates the region-after for this page.
*/
private void createRegionAfter(final SimplePageMaster simplePageMaster) {
if (simplePageMaster.getRegionAfter() == null) {
@@ -231,7 +231,7 @@
}
/**
- *
+ * Creates the region-start for this page.
*/
private void createRegionStart(final SimplePageMaster simplePageMaster) {
if (simplePageMaster.getRegionStart() == null) {
@@ -242,7 +242,7 @@
}
/**
- *
+ * Creates the region-end for this page.
*/
private void createRegionEnd(final SimplePageMaster simplePageMaster) {
if (simplePageMaster.getRegionEnd() == null) {
@@ -542,6 +542,7 @@
}
/**
+ * Indicates whether the first area returned by a marker is on this page.
* @param marker The Marker instance that should be tested.
* @return True if the first area returned by marker is on this page.
*/
@@ -561,6 +562,7 @@
}
/**
+ * Indicates whether the last area returned by a marker is on this page.
* @param marker The Marker instance that should be tested.
* @return True if the last area returned by marker is on this page.
*/
Modified: trunk/foray/foray-areatree/src/java/org/foray/area/SpanRA.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/SpanRA.java 2007-02-26 16:09:30 UTC (rev 8764)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/SpanRA.java 2007-02-26 17:01:43 UTC (rev 8765)
@@ -65,6 +65,7 @@
}
/**
+ * Returns the width of the columns in this span.
* @return The width of each column in this span.
*/
public int getColumnWidth() {
Modified: trunk/foray/foray-areatree/src/java/org/foray/area/TableCellRA.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/TableCellRA.java 2007-02-26 16:09:30 UTC (rev 8764)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/TableCellRA.java 2007-02-26 17:01:43 UTC (rev 8765)
@@ -88,6 +88,7 @@
}
/**
+ * Returns the padding needed on the bottom of this cell to center it.
* @return Returns the centeringPaddingBottom.
*/
public int getCenteringPaddingBottom() {
@@ -95,6 +96,7 @@
}
/**
+ * Returns the padding needed on the left of this cell to center it.
* @return Returns the centeringPaddingLeft.
*/
public int getCenteringPaddingLeft() {
@@ -102,6 +104,7 @@
}
/**
+ * Returns the padding needed on the right of this cell to center it.
* @return Returns the centeringPaddingRight.
*/
public int getCenteringPaddingRight() {
@@ -109,6 +112,7 @@
}
/**
+ * Returns the padding needed on the top of this cell to center it.
* @return Returns the centeringPaddingTop.
*/
public int getCenteringPaddingTop() {
Modified: trunk/foray/foray-areatree/src/java/org/foray/area/TextArea.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/TextArea.java 2007-02-26 16:09:30 UTC (rev 8764)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/TextArea.java 2007-02-26 17:01:43 UTC (rev 8765)
@@ -126,6 +126,7 @@
}
/**
+ * Initialized the dimensions of this Area.
* @param parentArea
* @param backingOffset
* @param backingSize
@@ -225,6 +226,7 @@
}
/**
+ * Returns the raw text for this area.
* @return The raw text from the FO Tree.
*/
protected char[] getRawText() {
@@ -480,12 +482,15 @@
}
/**
+ * Returns the resolved letter-spacing, in millipoints.
* @return Returns the resolvedLetterSpacing.
*/
public int getResolvedLetterSpacing() {
return resolvedLetterSpacing;
}
+
/**
+ * Sets the resolved letter-spacing.
* @param resolvedLetterSpacing The resolvedLetterSpacing to set.
*/
public void setResolvedLetterSpacing(final int resolvedLetterSpacing) {
@@ -494,6 +499,7 @@
}
/**
+ * Returns the resolved word-spacing, in millipoints.
* @return Returns the resolvedWordSpacing.
*/
public int getWordSpacing() {
@@ -501,6 +507,7 @@
}
/**
+ * Sets the resolved word-spacing.
* @param resolvedWordSpacing The resolvedWordSpacing to set.
*/
public void setResolvedWordSpacing(final int resolvedWordSpacing) {
Modified: trunk/foray/scripts/checkstyle-suppressions.xml
===================================================================
--- trunk/foray/scripts/checkstyle-suppressions.xml 2007-02-26 16:09:30 UTC (rev 8764)
+++ trunk/foray/scripts/checkstyle-suppressions.xml 2007-02-26 17:01:43 UTC (rev 8765)
@@ -8,7 +8,7 @@
<!-- Suppress partially-implemented checks where not yet implemented. -->
- <suppress checks="Javadoc[MVS].*"
+ <suppress checks="Javadoc[MV].*"
files="org.foray.area.*"/>
<suppress checks="Javadoc[MVS].*"
files="org.foray.fotree.*"/>
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <vic...@us...> - 2007-03-09 23:49:09
|
Revision: 8766
http://svn.sourceforge.net/foray/?rev=8766&view=rev
Author: victormote
Date: 2007-03-09 15:49:09 -0800 (Fri, 09 Mar 2007)
Log Message:
-----------
1. Add Eclipse checks to ensure generics are used where they should be.
2. Fix some cases where generics should be used but were not.
Modified Paths:
--------------
trunk/foray/foray-app/.settings/org.eclipse.jdt.core.prefs
trunk/foray/foray-areatree/.settings/org.eclipse.jdt.core.prefs
trunk/foray/foray-common/.settings/org.eclipse.jdt.core.prefs
trunk/foray/foray-common/src/java/org/foray/common/ClassService.java
trunk/foray/foray-common/src/java/org/foray/common/Configuration.java
trunk/foray/foray-common/src/java/org/foray/common/OrderedTreeNode.java
trunk/foray/foray-common/src/java/org/foray/common/url/PropertyProtocolRegistration.java
trunk/foray/foray-common/src/java/org/foray/common/url/URLUtil.java
trunk/foray/foray-core/.settings/org.eclipse.jdt.core.prefs
trunk/foray/foray-font/.settings/org.eclipse.jdt.core.prefs
trunk/foray/foray-font/src/java/org/foray/font/FOrayConsumerFont.java
trunk/foray/foray-font/src/java/org/foray/font/FOrayFontConsumer.java
trunk/foray/foray-font/src/java/org/foray/font/FOrayFontServer.java
trunk/foray/foray-font/src/java/org/foray/font/FontConfigParser.java
trunk/foray/foray-font/src/java/org/foray/font/RegisteredFontFamily.java
trunk/foray/foray-fotree/.settings/org.eclipse.jdt.core.prefs
trunk/foray/foray-fotree/src/java/org/foray/fotree/FOText.java
trunk/foray/foray-fotree/src/java/org/foray/fotree/FObj.java
trunk/foray/foray-fotree/src/java/org/foray/fotree/FOrayFOTreeServer.java
trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/Block.java
trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/LayoutMasterSet.java
trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/Marker.java
trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/PageSequence.java
trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/Root.java
trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/Table.java
trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/TableCell.java
trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/TableColumn.java
trunk/foray/foray-fotree/src/java/org/foray/fotree/value/PropertyCollection.java
trunk/foray/foray-fotree/src/java/org/foray/fotree/value/ValueCollection.java
trunk/foray/foray-graphic/.settings/org.eclipse.jdt.core.prefs
trunk/foray/foray-graphic/src/java/org/foray/graphic/FOrayGraphicServer.java
trunk/foray/foray-graphic/src/java/org/foray/graphic/ImageConsumerImpl.java
trunk/foray/foray-hyphen-r/.settings/org.eclipse.jdt.core.prefs
trunk/foray/foray-hyphen-r/src/java/org/foray/hyphenR/TernaryTree.java
trunk/foray/foray-layout/.settings/org.eclipse.jdt.core.prefs
trunk/foray/foray-mif/.settings/org.eclipse.jdt.core.prefs
trunk/foray/foray-output/.settings/org.eclipse.jdt.core.prefs
trunk/foray/foray-pdf/.settings/org.eclipse.jdt.core.prefs
trunk/foray/foray-pioneer/.settings/org.eclipse.jdt.core.prefs
trunk/foray/foray-pretty/.settings/org.eclipse.jdt.core.prefs
trunk/foray/foray-ps/.settings/org.eclipse.jdt.core.prefs
trunk/foray/foray-render/.settings/org.eclipse.jdt.core.prefs
trunk/foray/foray-text/.settings/org.eclipse.jdt.core.prefs
Modified: trunk/foray/foray-app/.settings/org.eclipse.jdt.core.prefs
===================================================================
--- trunk/foray/foray-app/.settings/org.eclipse.jdt.core.prefs 2007-02-26 17:01:43 UTC (rev 8765)
+++ trunk/foray/foray-app/.settings/org.eclipse.jdt.core.prefs 2007-03-09 23:49:09 UTC (rev 8766)
@@ -1,4 +1,4 @@
-#Thu Feb 01 18:35:40 MST 2007
+#Fri Mar 09 15:04:34 MST 2007
eclipse.preferences.version=1
org.eclipse.jdt.core.compiler.codegen.inlineJsrBytecode=enabled
org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.5
@@ -7,6 +7,56 @@
org.eclipse.jdt.core.compiler.debug.lineNumber=generate
org.eclipse.jdt.core.compiler.debug.localVariable=generate
org.eclipse.jdt.core.compiler.debug.sourceFile=generate
+org.eclipse.jdt.core.compiler.problem.annotationSuperInterface=warning
org.eclipse.jdt.core.compiler.problem.assertIdentifier=error
+org.eclipse.jdt.core.compiler.problem.autoboxing=ignore
+org.eclipse.jdt.core.compiler.problem.deprecation=warning
+org.eclipse.jdt.core.compiler.problem.deprecationInDeprecatedCode=disabled
+org.eclipse.jdt.core.compiler.problem.deprecationWhenOverridingDeprecatedMethod=disabled
+org.eclipse.jdt.core.compiler.problem.discouragedReference=warning
+org.eclipse.jdt.core.compiler.problem.emptyStatement=ignore
org.eclipse.jdt.core.compiler.problem.enumIdentifier=error
+org.eclipse.jdt.core.compiler.problem.fallthroughCase=ignore
+org.eclipse.jdt.core.compiler.problem.fieldHiding=ignore
+org.eclipse.jdt.core.compiler.problem.finalParameterBound=warning
+org.eclipse.jdt.core.compiler.problem.finallyBlockNotCompletingNormally=warning
+org.eclipse.jdt.core.compiler.problem.forbiddenReference=error
+org.eclipse.jdt.core.compiler.problem.hiddenCatchBlock=warning
+org.eclipse.jdt.core.compiler.problem.incompatibleNonInheritedInterfaceMethod=warning
+org.eclipse.jdt.core.compiler.problem.incompleteEnumSwitch=ignore
+org.eclipse.jdt.core.compiler.problem.indirectStaticAccess=ignore
+org.eclipse.jdt.core.compiler.problem.localVariableHiding=ignore
+org.eclipse.jdt.core.compiler.problem.methodWithConstructorName=warning
+org.eclipse.jdt.core.compiler.problem.missingDeprecatedAnnotation=ignore
+org.eclipse.jdt.core.compiler.problem.missingOverrideAnnotation=ignore
+org.eclipse.jdt.core.compiler.problem.missingSerialVersion=warning
+org.eclipse.jdt.core.compiler.problem.noEffectAssignment=warning
+org.eclipse.jdt.core.compiler.problem.noImplicitStringConversion=warning
+org.eclipse.jdt.core.compiler.problem.nonExternalizedStringLiteral=ignore
+org.eclipse.jdt.core.compiler.problem.nullReference=ignore
+org.eclipse.jdt.core.compiler.problem.overridingPackageDefaultMethod=warning
+org.eclipse.jdt.core.compiler.problem.parameterAssignment=ignore
+org.eclipse.jdt.core.compiler.problem.possibleAccidentalBooleanAssignment=ignore
+org.eclipse.jdt.core.compiler.problem.rawTypeReference=warning
+org.eclipse.jdt.core.compiler.problem.specialParameterHidingField=disabled
+org.eclipse.jdt.core.compiler.problem.staticAccessReceiver=warning
+org.eclipse.jdt.core.compiler.problem.suppressWarnings=enabled
+org.eclipse.jdt.core.compiler.problem.syntheticAccessEmulation=ignore
+org.eclipse.jdt.core.compiler.problem.typeParameterHiding=warning
+org.eclipse.jdt.core.compiler.problem.uncheckedTypeOperation=warning
+org.eclipse.jdt.core.compiler.problem.undocumentedEmptyBlock=ignore
+org.eclipse.jdt.core.compiler.problem.unhandledWarningToken=warning
+org.eclipse.jdt.core.compiler.problem.unnecessaryElse=ignore
+org.eclipse.jdt.core.compiler.problem.unnecessaryTypeCheck=warning
+org.eclipse.jdt.core.compiler.problem.unqualifiedFieldAccess=ignore
+org.eclipse.jdt.core.compiler.problem.unusedDeclaredThrownException=ignore
+org.eclipse.jdt.core.compiler.problem.unusedDeclaredThrownExceptionWhenOverriding=disabled
+org.eclipse.jdt.core.compiler.problem.unusedImport=warning
+org.eclipse.jdt.core.compiler.problem.unusedLabel=warning
+org.eclipse.jdt.core.compiler.problem.unusedLocal=warning
+org.eclipse.jdt.core.compiler.problem.unusedParameter=ignore
+org.eclipse.jdt.core.compiler.problem.unusedParameterWhenImplementingAbstract=disabled
+org.eclipse.jdt.core.compiler.problem.unusedParameterWhenOverridingConcrete=disabled
+org.eclipse.jdt.core.compiler.problem.unusedPrivateMember=warning
+org.eclipse.jdt.core.compiler.problem.varargsArgumentNeedCast=warning
org.eclipse.jdt.core.compiler.source=1.5
Modified: trunk/foray/foray-areatree/.settings/org.eclipse.jdt.core.prefs
===================================================================
--- trunk/foray/foray-areatree/.settings/org.eclipse.jdt.core.prefs 2007-02-26 17:01:43 UTC (rev 8765)
+++ trunk/foray/foray-areatree/.settings/org.eclipse.jdt.core.prefs 2007-03-09 23:49:09 UTC (rev 8766)
@@ -1,4 +1,4 @@
-#Thu Feb 01 18:35:49 MST 2007
+#Fri Mar 09 15:04:34 MST 2007
eclipse.preferences.version=1
org.eclipse.jdt.core.compiler.codegen.inlineJsrBytecode=enabled
org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.5
@@ -7,6 +7,56 @@
org.eclipse.jdt.core.compiler.debug.lineNumber=generate
org.eclipse.jdt.core.compiler.debug.localVariable=generate
org.eclipse.jdt.core.compiler.debug.sourceFile=generate
+org.eclipse.jdt.core.compiler.problem.annotationSuperInterface=warning
org.eclipse.jdt.core.compiler.problem.assertIdentifier=error
+org.eclipse.jdt.core.compiler.problem.autoboxing=ignore
+org.eclipse.jdt.core.compiler.problem.deprecation=warning
+org.eclipse.jdt.core.compiler.problem.deprecationInDeprecatedCode=disabled
+org.eclipse.jdt.core.compiler.problem.deprecationWhenOverridingDeprecatedMethod=disabled
+org.eclipse.jdt.core.compiler.problem.discouragedReference=warning
+org.eclipse.jdt.core.compiler.problem.emptyStatement=ignore
org.eclipse.jdt.core.compiler.problem.enumIdentifier=error
+org.eclipse.jdt.core.compiler.problem.fallthroughCase=ignore
+org.eclipse.jdt.core.compiler.problem.fieldHiding=ignore
+org.eclipse.jdt.core.compiler.problem.finalParameterBound=warning
+org.eclipse.jdt.core.compiler.problem.finallyBlockNotCompletingNormally=warning
+org.eclipse.jdt.core.compiler.problem.forbiddenReference=error
+org.eclipse.jdt.core.compiler.problem.hiddenCatchBlock=warning
+org.eclipse.jdt.core.compiler.problem.incompatibleNonInheritedInterfaceMethod=warning
+org.eclipse.jdt.core.compiler.problem.incompleteEnumSwitch=ignore
+org.eclipse.jdt.core.compiler.problem.indirectStaticAccess=ignore
+org.eclipse.jdt.core.compiler.problem.localVariableHiding=ignore
+org.eclipse.jdt.core.compiler.problem.methodWithConstructorName=warning
+org.eclipse.jdt.core.compiler.problem.missingDeprecatedAnnotation=ignore
+org.eclipse.jdt.core.compiler.problem.missingOverrideAnnotation=ignore
+org.eclipse.jdt.core.compiler.problem.missingSerialVersion=warning
+org.eclipse.jdt.core.compiler.problem.noEffectAssignment=warning
+org.eclipse.jdt.core.compiler.problem.noImplicitStringConversion=warning
+org.eclipse.jdt.core.compiler.problem.nonExternalizedStringLiteral=ignore
+org.eclipse.jdt.core.compiler.problem.nullReference=ignore
+org.eclipse.jdt.core.compiler.problem.overridingPackageDefaultMethod=warning
+org.eclipse.jdt.core.compiler.problem.parameterAssignment=ignore
+org.eclipse.jdt.core.compiler.problem.possibleAccidentalBooleanAssignment=ignore
+org.eclipse.jdt.core.compiler.problem.rawTypeReference=warning
+org.eclipse.jdt.core.compiler.problem.specialParameterHidingField=disabled
+org.eclipse.jdt.core.compiler.problem.staticAccessReceiver=warning
+org.eclipse.jdt.core.compiler.problem.suppressWarnings=enabled
+org.eclipse.jdt.core.compiler.problem.syntheticAccessEmulation=ignore
+org.eclipse.jdt.core.compiler.problem.typeParameterHiding=warning
+org.eclipse.jdt.core.compiler.problem.uncheckedTypeOperation=warning
+org.eclipse.jdt.core.compiler.problem.undocumentedEmptyBlock=ignore
+org.eclipse.jdt.core.compiler.problem.unhandledWarningToken=warning
+org.eclipse.jdt.core.compiler.problem.unnecessaryElse=ignore
+org.eclipse.jdt.core.compiler.problem.unnecessaryTypeCheck=warning
+org.eclipse.jdt.core.compiler.problem.unqualifiedFieldAccess=ignore
+org.eclipse.jdt.core.compiler.problem.unusedDeclaredThrownException=ignore
+org.eclipse.jdt.core.compiler.problem.unusedDeclaredThrownExceptionWhenOverriding=disabled
+org.eclipse.jdt.core.compiler.problem.unusedImport=warning
+org.eclipse.jdt.core.compiler.problem.unusedLabel=warning
+org.eclipse.jdt.core.compiler.problem.unusedLocal=warning
+org.eclipse.jdt.core.compiler.problem.unusedParameter=ignore
+org.eclipse.jdt.core.compiler.problem.unusedParameterWhenImplementingAbstract=disabled
+org.eclipse.jdt.core.compiler.problem.unusedParameterWhenOverridingConcrete=disabled
+org.eclipse.jdt.core.compiler.problem.unusedPrivateMember=warning
+org.eclipse.jdt.core.compiler.problem.varargsArgumentNeedCast=warning
org.eclipse.jdt.core.compiler.source=1.5
Modified: trunk/foray/foray-common/.settings/org.eclipse.jdt.core.prefs
===================================================================
--- trunk/foray/foray-common/.settings/org.eclipse.jdt.core.prefs 2007-02-26 17:01:43 UTC (rev 8765)
+++ trunk/foray/foray-common/.settings/org.eclipse.jdt.core.prefs 2007-03-09 23:49:09 UTC (rev 8766)
@@ -1,4 +1,4 @@
-#Thu Feb 01 18:35:58 MST 2007
+#Fri Mar 09 15:04:34 MST 2007
eclipse.preferences.version=1
org.eclipse.jdt.core.compiler.codegen.inlineJsrBytecode=enabled
org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.5
@@ -7,6 +7,56 @@
org.eclipse.jdt.core.compiler.debug.lineNumber=generate
org.eclipse.jdt.core.compiler.debug.localVariable=generate
org.eclipse.jdt.core.compiler.debug.sourceFile=generate
+org.eclipse.jdt.core.compiler.problem.annotationSuperInterface=warning
org.eclipse.jdt.core.compiler.problem.assertIdentifier=error
+org.eclipse.jdt.core.compiler.problem.autoboxing=ignore
+org.eclipse.jdt.core.compiler.problem.deprecation=warning
+org.eclipse.jdt.core.compiler.problem.deprecationInDeprecatedCode=disabled
+org.eclipse.jdt.core.compiler.problem.deprecationWhenOverridingDeprecatedMethod=disabled
+org.eclipse.jdt.core.compiler.problem.discouragedReference=warning
+org.eclipse.jdt.core.compiler.problem.emptyStatement=ignore
org.eclipse.jdt.core.compiler.problem.enumIdentifier=error
+org.eclipse.jdt.core.compiler.problem.fallthroughCase=ignore
+org.eclipse.jdt.core.compiler.problem.fieldHiding=ignore
+org.eclipse.jdt.core.compiler.problem.finalParameterBound=warning
+org.eclipse.jdt.core.compiler.problem.finallyBlockNotCompletingNormally=warning
+org.eclipse.jdt.core.compiler.problem.forbiddenReference=error
+org.eclipse.jdt.core.compiler.problem.hiddenCatchBlock=warning
+org.eclipse.jdt.core.compiler.problem.incompatibleNonInheritedInterfaceMethod=warning
+org.eclipse.jdt.core.compiler.problem.incompleteEnumSwitch=ignore
+org.eclipse.jdt.core.compiler.problem.indirectStaticAccess=ignore
+org.eclipse.jdt.core.compiler.problem.localVariableHiding=ignore
+org.eclipse.jdt.core.compiler.problem.methodWithConstructorName=warning
+org.eclipse.jdt.core.compiler.problem.missingDeprecatedAnnotation=ignore
+org.eclipse.jdt.core.compiler.problem.missingOverrideAnnotation=ignore
+org.eclipse.jdt.core.compiler.problem.missingSerialVersion=warning
+org.eclipse.jdt.core.compiler.problem.noEffectAssignment=warning
+org.eclipse.jdt.core.compiler.problem.noImplicitStringConversion=warning
+org.eclipse.jdt.core.compiler.problem.nonExternalizedStringLiteral=ignore
+org.eclipse.jdt.core.compiler.problem.nullReference=ignore
+org.eclipse.jdt.core.compiler.problem.overridingPackageDefaultMethod=warning
+org.eclipse.jdt.core.compiler.problem.parameterAssignment=ignore
+org.eclipse.jdt.core.compiler.problem.possibleAccidentalBooleanAssignment=ignore
+org.eclipse.jdt.core.compiler.problem.rawTypeReference=warning
+org.eclipse.jdt.core.compiler.problem.specialParameterHidingField=disabled
+org.eclipse.jdt.core.compiler.problem.staticAccessReceiver=warning
+org.eclipse.jdt.core.compiler.problem.suppressWarnings=enabled
+org.eclipse.jdt.core.compiler.problem.syntheticAccessEmulation=ignore
+org.eclipse.jdt.core.compiler.problem.typeParameterHiding=warning
+org.eclipse.jdt.core.compiler.problem.uncheckedTypeOperation=warning
+org.eclipse.jdt.core.compiler.problem.undocumentedEmptyBlock=ignore
+org.eclipse.jdt.core.compiler.problem.unhandledWarningToken=warning
+org.eclipse.jdt.core.compiler.problem.unnecessaryElse=ignore
+org.eclipse.jdt.core.compiler.problem.unnecessaryTypeCheck=warning
+org.eclipse.jdt.core.compiler.problem.unqualifiedFieldAccess=ignore
+org.eclipse.jdt.core.compiler.problem.unusedDeclaredThrownException=ignore
+org.eclipse.jdt.core.compiler.problem.unusedDeclaredThrownExceptionWhenOverriding=disabled
+org.eclipse.jdt.core.compiler.problem.unusedImport=warning
+org.eclipse.jdt.core.compiler.problem.unusedLabel=warning
+org.eclipse.jdt.core.compiler.problem.unusedLocal=warning
+org.eclipse.jdt.core.compiler.problem.unusedParameter=ignore
+org.eclipse.jdt.core.compiler.problem.unusedParameterWhenImplementingAbstract=disabled
+org.eclipse.jdt.core.compiler.problem.unusedParameterWhenOverridingConcrete=disabled
+org.eclipse.jdt.core.compiler.problem.unusedPrivateMember=warning
+org.eclipse.jdt.core.compiler.problem.varargsArgumentNeedCast=warning
org.eclipse.jdt.core.compiler.source=1.5
Modified: trunk/foray/foray-common/src/java/org/foray/common/ClassService.java
===================================================================
--- trunk/foray/foray-common/src/java/org/foray/common/ClassService.java 2007-02-26 17:01:43 UTC (rev 8765)
+++ trunk/foray/foray-common/src/java/org/foray/common/ClassService.java 2007-03-09 23:49:09 UTC (rev 8766)
@@ -62,7 +62,7 @@
* services, or null if the system class loader should be used.
* @return An enumeration of the services in the class path.
*/
- public static synchronized Enumeration providers(final Class cls) {
+ public static synchronized Enumeration<?> providers(final Class<?> cls) {
ClassLoader cl = cls.getClassLoader();
// null if loaded by bootstrap class loader
if (cl == null) {
@@ -79,7 +79,7 @@
v = new Vector<String>();
providerMap.put(serviceFile, v);
- Enumeration e;
+ Enumeration<URL> e;
try {
e = cl.getResources(serviceFile);
} catch (final IOException ioe) {
@@ -88,7 +88,7 @@
while (e.hasMoreElements()) {
try {
- final URL u = (URL) e.nextElement();
+ final URL u = e.nextElement();
final InputStream is = u.openStream();
final InputStreamReader r = new InputStreamReader(is, "UTF-8");
Modified: trunk/foray/foray-common/src/java/org/foray/common/Configuration.java
===================================================================
--- trunk/foray/foray-common/src/java/org/foray/common/Configuration.java 2007-02-26 17:01:43 UTC (rev 8765)
+++ trunk/foray/foray-common/src/java/org/foray/common/Configuration.java 2007-03-09 23:49:09 UTC (rev 8766)
@@ -37,7 +37,6 @@
import java.net.URL;
import java.util.ArrayList;
import java.util.HashMap;
-import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.StringTokenizer;
@@ -166,7 +165,7 @@
* @param key a string containing the key value for the configuration value
* @return The List value, or null if the key is not defined.
*/
- protected List getListValue(final String key) {
+ protected List<?> getListValue(final String key) {
final Object obj = getValue(key);
if (obj instanceof List) {
return (List) obj;
@@ -352,16 +351,14 @@
*/
public void dumpConfiguration() {
logger.info("Dumping configuration: " + getName());
- final Iterator iterator = options.keySet().iterator();
- while (iterator.hasNext()) {
- final String key = (String) iterator.next();
+ for (String key : this.options.keySet()) {
logger.info("key: " + key);
final Object value = options.get(key);
if (value instanceof String) {
logger.info(" value: " + value);
} else if (value instanceof List) {
final StringBuffer valueString = new StringBuffer();
- final List list = (List) value;
+ final List<?> list = (List) value;
valueString.append(" value: ");
for (int i = 0; i < list.size(); i++) {
final String item = (String) list.get(i);
Modified: trunk/foray/foray-common/src/java/org/foray/common/OrderedTreeNode.java
===================================================================
--- trunk/foray/foray-common/src/java/org/foray/common/OrderedTreeNode.java 2007-02-26 17:01:43 UTC (rev 8765)
+++ trunk/foray/foray-common/src/java/org/foray/common/OrderedTreeNode.java 2007-03-09 23:49:09 UTC (rev 8766)
@@ -142,7 +142,7 @@
* {@inheritDoc}
*/
public int siblingIndex() {
- final List siblings = getSiblings();
+ final List<? extends OrderedTreeNode> siblings = getSiblings();
if (siblings == null) {
return -1;
}
Modified: trunk/foray/foray-common/src/java/org/foray/common/url/PropertyProtocolRegistration.java
===================================================================
--- trunk/foray/foray-common/src/java/org/foray/common/url/PropertyProtocolRegistration.java 2007-02-26 17:01:43 UTC (rev 8765)
+++ trunk/foray/foray-common/src/java/org/foray/common/url/PropertyProtocolRegistration.java 2007-03-09 23:49:09 UTC (rev 8766)
@@ -80,7 +80,7 @@
public static void propertyRegistration(final String protocol,
final URLStreamHandler handler) {
/* Parse the path. */
- final Class theClass = handler.getClass();
+ final Class<? extends URLStreamHandler> theClass = handler.getClass();
final String classPath = theClass.getName();
int lastTokenDelimiter = classPath.lastIndexOf('.');
final String className = classPath.substring(lastTokenDelimiter + 1,
Modified: trunk/foray/foray-common/src/java/org/foray/common/url/URLUtil.java
===================================================================
--- trunk/foray/foray-common/src/java/org/foray/common/url/URLUtil.java 2007-02-26 17:01:43 UTC (rev 8765)
+++ trunk/foray/foray-common/src/java/org/foray/common/url/URLUtil.java 2007-03-09 23:49:09 UTC (rev 8766)
@@ -77,7 +77,7 @@
* @throws MalformedURLException If it is unable to create even one
* URL instance.
*/
- public static List buildURLList(final URL[] baseURLs,
+ public static List<URL> buildURLList(final URL[] baseURLs,
final String urlSpecified)
throws MalformedURLException {
if (urlSpecified == null) {
Modified: trunk/foray/foray-core/.settings/org.eclipse.jdt.core.prefs
===================================================================
--- trunk/foray/foray-core/.settings/org.eclipse.jdt.core.prefs 2007-02-26 17:01:43 UTC (rev 8765)
+++ trunk/foray/foray-core/.settings/org.eclipse.jdt.core.prefs 2007-03-09 23:49:09 UTC (rev 8766)
@@ -1,4 +1,4 @@
-#Thu Feb 01 18:36:10 MST 2007
+#Fri Mar 09 15:04:34 MST 2007
eclipse.preferences.version=1
org.eclipse.jdt.core.compiler.codegen.inlineJsrBytecode=enabled
org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.5
@@ -7,6 +7,56 @@
org.eclipse.jdt.core.compiler.debug.lineNumber=generate
org.eclipse.jdt.core.compiler.debug.localVariable=generate
org.eclipse.jdt.core.compiler.debug.sourceFile=generate
+org.eclipse.jdt.core.compiler.problem.annotationSuperInterface=warning
org.eclipse.jdt.core.compiler.problem.assertIdentifier=error
+org.eclipse.jdt.core.compiler.problem.autoboxing=ignore
+org.eclipse.jdt.core.compiler.problem.deprecation=warning
+org.eclipse.jdt.core.compiler.problem.deprecationInDeprecatedCode=disabled
+org.eclipse.jdt.core.compiler.problem.deprecationWhenOverridingDeprecatedMethod=disabled
+org.eclipse.jdt.core.compiler.problem.discouragedReference=warning
+org.eclipse.jdt.core.compiler.problem.emptyStatement=ignore
org.eclipse.jdt.core.compiler.problem.enumIdentifier=error
+org.eclipse.jdt.core.compiler.problem.fallthroughCase=ignore
+org.eclipse.jdt.core.compiler.problem.fieldHiding=ignore
+org.eclipse.jdt.core.compiler.problem.finalParameterBound=warning
+org.eclipse.jdt.core.compiler.problem.finallyBlockNotCompletingNormally=warning
+org.eclipse.jdt.core.compiler.problem.forbiddenReference=error
+org.eclipse.jdt.core.compiler.problem.hiddenCatchBlock=warning
+org.eclipse.jdt.core.compiler.problem.incompatibleNonInheritedInterfaceMethod=warning
+org.eclipse.jdt.core.compiler.problem.incompleteEnumSwitch=ignore
+org.eclipse.jdt.core.compiler.problem.indirectStaticAccess=ignore
+org.eclipse.jdt.core.compiler.problem.localVariableHiding=ignore
+org.eclipse.jdt.core.compiler.problem.methodWithConstructorName=warning
+org.eclipse.jdt.core.compiler.problem.missingDeprecatedAnnotation=ignore
+org.eclipse.jdt.core.compiler.problem.missingOverrideAnnotation=ignore
+org.eclipse.jdt.core.compiler.problem.missingSerialVersion=warning
+org.eclipse.jdt.core.compiler.problem.noEffectAssignment=warning
+org.eclipse.jdt.core.compiler.problem.noImplicitStringConversion=warning
+org.eclipse.jdt.core.compiler.problem.nonExternalizedStringLiteral=ignore
+org.eclipse.jdt.core.compiler.problem.nullReference=ignore
+org.eclipse.jdt.core.compiler.problem.overridingPackageDefaultMethod=warning
+org.eclipse.jdt.core.compiler.problem.parameterAssignment=ignore
+org.eclipse.jdt.core.compiler.problem.possibleAccidentalBooleanAssignment=ignore
+org.eclipse.jdt.core.compiler.problem.rawTypeReference=warning
+org.eclipse.jdt.core.compiler.problem.specialParameterHidingField=disabled
+org.eclipse.jdt.core.compiler.problem.staticAccessReceiver=warning
+org.eclipse.jdt.core.compiler.problem.suppressWarnings=enabled
+org.eclipse.jdt.core.compiler.problem.syntheticAccessEmulation=ignore
+org.eclipse.jdt.core.compiler.problem.typeParameterHiding=warning
+org.eclipse.jdt.core.compiler.problem.uncheckedTypeOperation=warning
+org.eclipse.jdt.core.compiler.problem.undocumentedEmptyBlock=ignore
+org.eclipse.jdt.core.compiler.problem.unhandledWarningToken=warning
+org.eclipse.jdt.core.compiler.problem.unnecessaryElse=ignore
+org.eclipse.jdt.core.compiler.problem.unnecessaryTypeCheck=warning
+org.eclipse.jdt.core.compiler.problem.unqualifiedFieldAccess=ignore
+org.eclipse.jdt.core.compiler.problem.unusedDeclaredThrownException=ignore
+org.eclipse.jdt.core.compiler.problem.unusedDeclaredThrownExceptionWhenOverriding=disabled
+org.eclipse.jdt.core.compiler.problem.unusedImport=warning
+org.eclipse.jdt.core.compiler.problem.unusedLabel=warning
+org.eclipse.jdt.core.compiler.problem.unusedLocal=warning
+org.eclipse.jdt.core.compiler.problem.unusedParameter=ignore
+org.eclipse.jdt.core.compiler.problem.unusedParameterWhenImplementingAbstract=disabled
+org.eclipse.jdt.core.compiler.problem.unusedParameterWhenOverridingConcrete=disabled
+org.eclipse.jdt.core.compiler.problem.unusedPrivateMember=warning
+org.eclipse.jdt.core.compiler.problem.varargsArgumentNeedCast=warning
org.eclipse.jdt.core.compiler.source=1.5
Modified: trunk/foray/foray-font/.settings/org.eclipse.jdt.core.prefs
===================================================================
--- trunk/foray/foray-font/.settings/org.eclipse.jdt.core.prefs 2007-02-26 17:01:43 UTC (rev 8765)
+++ trunk/foray/foray-font/.settings/org.eclipse.jdt.core.prefs 2007-03-09 23:49:09 UTC (rev 8766)
@@ -1,4 +1,4 @@
-#Thu Feb 01 18:36:17 MST 2007
+#Fri Mar 09 15:04:34 MST 2007
eclipse.preferences.version=1
org.eclipse.jdt.core.compiler.codegen.inlineJsrBytecode=enabled
org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.5
@@ -7,6 +7,56 @@
org.eclipse.jdt.core.compiler.debug.lineNumber=generate
org.eclipse.jdt.core.compiler.debug.localVariable=generate
org.eclipse.jdt.core.compiler.debug.sourceFile=generate
+org.eclipse.jdt.core.compiler.problem.annotationSuperInterface=warning
org.eclipse.jdt.core.compiler.problem.assertIdentifier=error
+org.eclipse.jdt.core.compiler.problem.autoboxing=ignore
+org.eclipse.jdt.core.compiler.problem.deprecation=warning
+org.eclipse.jdt.core.compiler.problem.deprecationInDeprecatedCode=disabled
+org.eclipse.jdt.core.compiler.problem.deprecationWhenOverridingDeprecatedMethod=disabled
+org.eclipse.jdt.core.compiler.problem.discouragedReference=warning
+org.eclipse.jdt.core.compiler.problem.emptyStatement=ignore
org.eclipse.jdt.core.compiler.problem.enumIdentifier=error
+org.eclipse.jdt.core.compiler.problem.fallthroughCase=ignore
+org.eclipse.jdt.core.compiler.problem.fieldHiding=ignore
+org.eclipse.jdt.core.compiler.problem.finalParameterBound=warning
+org.eclipse.jdt.core.compiler.problem.finallyBlockNotCompletingNormally=warning
+org.eclipse.jdt.core.compiler.problem.forbiddenReference=error
+org.eclipse.jdt.core.compiler.problem.hiddenCatchBlock=warning
+org.eclipse.jdt.core.compiler.problem.incompatibleNonInheritedInterfaceMethod=warning
+org.eclipse.jdt.core.compiler.problem.incompleteEnumSwitch=ignore
+org.eclipse.jdt.core.compiler.problem.indirectStaticAccess=ignore
+org.eclipse.jdt.core.compiler.problem.localVariableHiding=ignore
+org.eclipse.jdt.core.compiler.problem.methodWithConstructorName=warning
+org.eclipse.jdt.core.compiler.problem.missingDeprecatedAnnotation=ignore
+org.eclipse.jdt.core.compiler.problem.missingOverrideAnnotation=ignore
+org.eclipse.jdt.core.compiler.problem.missingSerialVersion=warning
+org.eclipse.jdt.core.compiler.problem.noEffectAssignment=warning
+org.eclipse.jdt.core.compiler.problem.noImplicitStringConversion=warning
+org.eclipse.jdt.core.compiler.problem.nonExternalizedStringLiteral=ignore
+org.eclipse.jdt.core.compiler.problem.nullReference=ignore
+org.eclipse.jdt.core.compiler.problem.overridingPackageDefaultMethod=warning
+org.eclipse.jdt.core.compiler.problem.parameterAssignment=ignore
+org.eclipse.jdt.core.compiler.problem.possibleAccidentalBooleanAssignment=ignore
+org.eclipse.jdt.core.compiler.problem.rawTypeReference=warning
+org.eclipse.jdt.core.compiler.problem.specialParameterHidingField=disabled
+org.eclipse.jdt.core.compiler.problem.staticAccessReceiver=warning
+org.eclipse.jdt.core.compiler.problem.suppressWarnings=enabled
+org.eclipse.jdt.core.compiler.problem.syntheticAccessEmulation=ignore
+org.eclipse.jdt.core.compiler.problem.typeParameterHiding=warning
+org.eclipse.jdt.core.compiler.problem.uncheckedTypeOperation=warning
+org.eclipse.jdt.core.compiler.problem.undocumentedEmptyBlock=ignore
+org.eclipse.jdt.core.compiler.problem.unhandledWarningToken=warning
+org.eclipse.jdt.core.compiler.problem.unnecessaryElse=ignore
+org.eclipse.jdt.core.compiler.problem.unnecessaryTypeCheck=warning
+org.eclipse.jdt.core.compiler.problem.unqualifiedFieldAccess=ignore
+org.eclipse.jdt.core.compiler.problem...
[truncated message content] |
|
From: <vic...@us...> - 2007-03-10 01:02:36
|
Revision: 8769
http://svn.sourceforge.net/foray/?rev=8769&view=rev
Author: victormote
Date: 2007-03-09 17:02:37 -0800 (Fri, 09 Mar 2007)
Log Message:
-----------
Add generics where needed.
Modified Paths:
--------------
trunk/foray/foray-mif/src/java/org/foray/mif/MifTbl.java
trunk/foray/foray-output/src/java/org/foray/output/OutputConfig.java
trunk/foray/foray-pretty/src/java/org/foray/pretty/dtd/DTDTokenizer.java
trunk/foray/foray-render/src/java/org/foray/render/Renderer.java
trunk/foray/foray-render/src/java/org/foray/render/awt/AWTPrintRenderer.java
trunk/foray/foray-render/src/java/org/foray/render/pdf/PDFRenderer.java
Modified: trunk/foray/foray-mif/src/java/org/foray/mif/MifTbl.java
===================================================================
--- trunk/foray/foray-mif/src/java/org/foray/mif/MifTbl.java 2007-03-10 00:50:31 UTC (rev 8768)
+++ trunk/foray/foray-mif/src/java/org/foray/mif/MifTbl.java 2007-03-10 01:02:37 UTC (rev 8769)
@@ -234,8 +234,8 @@
*/
public MifPgf curPara() {
final Row curRow = this.current.get(current.size() - 1);
- final ArrayList paras = curRow.curCell().paras;
- return (MifPgf) paras.get(paras.size() - 1);
+ final ArrayList<MifPgf> paras = curRow.curCell().paras;
+ return paras.get(paras.size() - 1);
}
/**
Modified: trunk/foray/foray-output/src/java/org/foray/output/OutputConfig.java
===================================================================
--- trunk/foray/foray-output/src/java/org/foray/output/OutputConfig.java 2007-03-10 00:50:31 UTC (rev 8768)
+++ trunk/foray/foray-output/src/java/org/foray/output/OutputConfig.java 2007-03-10 01:02:37 UTC (rev 8769)
@@ -127,7 +127,7 @@
* Returns the list of PDF filters that this document should use.
* @return The list of PDF filters that this document should use.
*/
- public List optionPDFFilters() {
+ public List<?> optionPDFFilters() {
return getListValue("pdf-filters");
}
Modified: trunk/foray/foray-pretty/src/java/org/foray/pretty/dtd/DTDTokenizer.java
===================================================================
--- trunk/foray/foray-pretty/src/java/org/foray/pretty/dtd/DTDTokenizer.java 2007-03-10 00:50:31 UTC (rev 8768)
+++ trunk/foray/foray-pretty/src/java/org/foray/pretty/dtd/DTDTokenizer.java 2007-03-10 01:02:37 UTC (rev 8769)
@@ -186,10 +186,11 @@
* @param arrayList The raw list.
* @return A String array with arrayList's contents.
*/
- public static String[] arrayListToStrings(final ArrayList arrayList) {
+ public static String[] arrayListToStrings(
+ final ArrayList<String> arrayList) {
final String[] strings = new String[arrayList.size()];
for (int i = 0; i < arrayList.size(); i++) {
- strings[i] = (String) arrayList.get(i);
+ strings[i] = arrayList.get(i);
}
return strings;
}
Modified: trunk/foray/foray-render/src/java/org/foray/render/Renderer.java
===================================================================
--- trunk/foray/foray-render/src/java/org/foray/render/Renderer.java 2007-03-10 00:50:31 UTC (rev 8768)
+++ trunk/foray/foray-render/src/java/org/foray/render/Renderer.java 2007-03-10 01:02:37 UTC (rev 8769)
@@ -442,9 +442,9 @@
* @param area The area whose children should be rendered.
*/
public void renderChildren(final AreaNode area) {
- final List children = area.getChildren();
+ final List<? extends AreaNode> children = area.getChildren();
for (int i = 0; i < children.size(); i++) {
- final AreaNode child = (AreaNode) children.get(i);
+ final AreaNode child = children.get(i);
child.render(this);
}
}
@@ -595,9 +595,9 @@
* includes items like Destinations and Bookmarks.
*/
protected void renderDocumentNodes() {
- final List children = this.areaTree.getChildren();
+ final List<? extends AreaNode> children = this.areaTree.getChildren();
for (int i = 0; i < children.size(); i++) {
- final AreaNode atNode = (AreaNode) children.get(i);
+ final AreaNode atNode = children.get(i);
if (! (atNode instanceof PageCollection)) {
atNode.render(this);
}
Modified: trunk/foray/foray-render/src/java/org/foray/render/awt/AWTPrintRenderer.java
===================================================================
--- trunk/foray/foray-render/src/java/org/foray/render/awt/AWTPrintRenderer.java 2007-03-10 00:50:31 UTC (rev 8768)
+++ trunk/foray/foray-render/src/java/org/foray/render/awt/AWTPrintRenderer.java 2007-03-10 01:02:37 UTC (rev 8769)
@@ -98,9 +98,9 @@
endNumber = getPageCount();
}
- final List numbers = getInvalidPageNumbers();
+ final List<String> numbers = getInvalidPageNumbers();
for (int i = numbers.size() - 1; i > -1; i--) {
- removePage(Integer.parseInt((String) numbers.get(i)));
+ removePage(Integer.parseInt(numbers.get(i)));
}
try {
@@ -126,7 +126,7 @@
* Returns the list of invalid page numbers.
* @return The list of invalid page numbers.
*/
- private List getInvalidPageNumbers() {
+ private List<String> getInvalidPageNumbers() {
final List<String> vec = new ArrayList<String>();
final int max = getPageCount();
boolean isValid;
Modified: trunk/foray/foray-render/src/java/org/foray/render/pdf/PDFRenderer.java
===================================================================
--- trunk/foray/foray-render/src/java/org/foray/render/pdf/PDFRenderer.java 2007-03-10 00:50:31 UTC (rev 8768)
+++ trunk/foray/foray-render/src/java/org/foray/render/pdf/PDFRenderer.java 2007-03-10 01:02:37 UTC (rev 8769)
@@ -38,6 +38,7 @@
import org.foray.render.PrintRenderer;
import org.axsl.areaR.Area;
+import org.axsl.areaR.AreaNode;
import org.axsl.areaR.AreaRException;
import org.axsl.areaR.BookmarkArea;
import org.axsl.areaR.BookmarkTitleArea;
@@ -168,7 +169,7 @@
this.pdfDoc.setCreationDate(now);
// setup Encryption
addEncryption();
- final List filters = this.getOptions().optionPDFFilters();
+ final List<?> filters = this.getOptions().optionPDFFilters();
for (int i = 0; i < filters.size(); i++) {
final String filter = (String) filters.get(i);
pdfDoc.addDefaultFilter(filter);
@@ -446,7 +447,7 @@
if (area.isLinkRoot()) {
createBasicLink(area);
}
- final List children = area.getChildren();
+ final List<? extends AreaNode> children = area.getChildren();
for (int i = 0; i < children.size(); i++) {
final Object child = children.get(i);
if (! (child instanceof Area)) {
@@ -504,7 +505,7 @@
pdfOutline = parent.createPDFOutlineItem(title.getTitleText(),
area.traitInternalDestination(), color, italic, bold);
// Recursively handle child bookmarks
- final List children = area.getChildren();
+ final List<? extends AreaNode> children = area.getChildren();
for (int i = 0; i < children.size(); i++) {
final Object child = children.get(i);
if (child instanceof BookmarkArea) {
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <vic...@us...> - 2007-03-10 02:42:16
|
Revision: 8775
http://svn.sourceforge.net/foray/?rev=8775&view=rev
Author: victormote
Date: 2007-03-09 18:42:15 -0800 (Fri, 09 Mar 2007)
Log Message:
-----------
Push the location (and casting) of the parent down one level.
Modified Paths:
--------------
trunk/foray/foray-areatree/src/java/org/foray/area/AreaNode.java
trunk/foray/foray-common/src/java/org/foray/common/OrderedTreeNode.java
trunk/foray/foray-fotree/src/java/org/foray/fotree/FONode.java
trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/Bookmark.java
Modified: trunk/foray/foray-areatree/src/java/org/foray/area/AreaNode.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/AreaNode.java 2007-03-10 02:23:52 UTC (rev 8774)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/AreaNode.java 2007-03-10 02:42:15 UTC (rev 8775)
@@ -53,6 +53,9 @@
public abstract class AreaNode extends OrderedTreeNode
implements org.axsl.areaR.AreaNode, org.axsl.areaW.AreaNode {
+ /** The parent of this node. */
+ private AreaNode parent;
+
private List<AreaNode> children = new ArrayList<AreaNode>();
/** The "generated-by" trait, as defined in Section 6.1.1. */
@@ -68,7 +71,7 @@
*/
public AreaNode(final FONode generatedBy, final AreaNode parentArea,
final RetrieveMarker retrieveMarker) {
- super(parentArea);
+ this.parent = parentArea;
if (! (this instanceof AreaTree)) {
// AreaTree has no parent with which to register
getAreaNodeParent().getChildren().add(this);
@@ -80,8 +83,19 @@
}
}
+ /**
+ * {@inheritDoc}
+ */
+ public AreaNode getParent() {
+ return this.parent;
+ }
+
+ public void setParent(final AreaNode node) {
+ this.parent = node;
+ }
+
public org.axsl.areaR.AreaNode getParentOut() {
- return (org.axsl.areaR.AreaNode) getParent();
+ return getParent();
}
public List<AreaNode> getChildren() {
Modified: trunk/foray/foray-common/src/java/org/foray/common/OrderedTreeNode.java
===================================================================
--- trunk/foray/foray-common/src/java/org/foray/common/OrderedTreeNode.java 2007-03-10 02:23:52 UTC (rev 8774)
+++ trunk/foray/foray-common/src/java/org/foray/common/OrderedTreeNode.java 2007-03-10 02:42:15 UTC (rev 8775)
@@ -46,15 +46,10 @@
public abstract class OrderedTreeNode
implements org.axsl.common.OrderedTreeNode {
- /** The parent of this node. */
- private OrderedTreeNode parent;
-
/**
* Constructor.
- * @param parent This node's parent node.
*/
- public OrderedTreeNode(final OrderedTreeNode parent) {
- this.parent = parent;
+ public OrderedTreeNode() {
}
/**
@@ -110,9 +105,7 @@
/**
* {@inheritDoc}
*/
- public OrderedTreeNode getParent() {
- return this.parent;
- }
+ public abstract OrderedTreeNode getParent();
/**
* {@inheritDoc}
@@ -128,14 +121,10 @@
* {@inheritDoc}
*/
public List<? extends OrderedTreeNode> getSiblings() {
- if (parent == null) {
+ if (this.getParent() == null) {
return null;
}
- final List<? extends OrderedTreeNode> children = parent.getChildren();
- if (children == null) {
- return null;
- }
- return children;
+ return this.getParent().getChildren();
}
/**
@@ -176,14 +165,6 @@
}
/**
- * Changes this nodes parent.
- * @param newParent The new parent of this node.
- */
- public void setParent(final OrderedTreeNode newParent) {
- this.parent = newParent;
- }
-
- /**
* {@inheritDoc}
*/
public boolean hasChildren() {
Modified: trunk/foray/foray-fotree/src/java/org/foray/fotree/FONode.java
===================================================================
--- trunk/foray/foray-fotree/src/java/org/foray/fotree/FONode.java 2007-03-10 02:23:52 UTC (rev 8774)
+++ trunk/foray/foray-fotree/src/java/org/foray/fotree/FONode.java 2007-03-10 02:42:15 UTC (rev 8775)
@@ -47,15 +47,24 @@
public abstract class FONode extends OrderedTreeNode
implements org.axsl.foR.FONode {
+ private FONode parent;
+
private FONodeProxy proxy;
private FONodeResult result;
protected FONode(final FObj parent) {
- super(parent);
+ this.parent = parent;
}
/**
+ * {@inheritDoc}
+ */
+ public FONode getParent() {
+ return this.parent;
+ }
+
+ /**
* Return this node's effective parent, cast as an FObj.
* This differs from the value returned by
* @param context An object that knows how to resolve FO Tree context
Modified: trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/Bookmark.java
===================================================================
--- trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/Bookmark.java 2007-03-10 02:23:52 UTC (rev 8774)
+++ trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/Bookmark.java 2007-03-10 02:42:15 UTC (rev 8775)
@@ -112,7 +112,7 @@
}
public Bookmark getParentOutline(final FOContext context) {
- for (FONode node = (FONode) getParent();
+ for (FONode node = getParent();
node != null; node = node.effectiveParent(context)) {
if (node instanceof Bookmark) {
return (Bookmark) node;
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <vic...@us...> - 2007-03-10 02:59:22
|
Revision: 8776
http://svn.sourceforge.net/foray/?rev=8776&view=rev
Author: victormote
Date: 2007-03-09 18:59:23 -0800 (Fri, 09 Mar 2007)
Log Message:
-----------
Push the implementation of the sibling logic down one level.
Modified Paths:
--------------
trunk/foray/foray-areatree/src/java/org/foray/area/AreaNode.java
trunk/foray/foray-common/src/java/org/foray/common/OrderedTreeNode.java
trunk/foray/foray-fotree/src/java/org/foray/fotree/FONode.java
trunk/foray/foray-fotree/src/java/org/foray/fotree/FObj.java
Modified: trunk/foray/foray-areatree/src/java/org/foray/area/AreaNode.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/AreaNode.java 2007-03-10 02:42:15 UTC (rev 8775)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/AreaNode.java 2007-03-10 02:59:23 UTC (rev 8776)
@@ -103,6 +103,16 @@
}
/**
+ * {@inheritDoc}
+ */
+ public List<AreaNode> getSiblings() {
+ if (this.getParent() == null) {
+ return null;
+ }
+ return this.getParent().getChildren();
+ }
+
+ /**
* Removes this from the parent's list of children.
*/
public void remove() {
Modified: trunk/foray/foray-common/src/java/org/foray/common/OrderedTreeNode.java
===================================================================
--- trunk/foray/foray-common/src/java/org/foray/common/OrderedTreeNode.java 2007-03-10 02:42:15 UTC (rev 8775)
+++ trunk/foray/foray-common/src/java/org/foray/common/OrderedTreeNode.java 2007-03-10 02:59:23 UTC (rev 8776)
@@ -120,12 +120,7 @@
/**
* {@inheritDoc}
*/
- public List<? extends OrderedTreeNode> getSiblings() {
- if (this.getParent() == null) {
- return null;
- }
- return this.getParent().getChildren();
- }
+ public abstract List<? extends OrderedTreeNode> getSiblings();
/**
* {@inheritDoc}
Modified: trunk/foray/foray-fotree/src/java/org/foray/fotree/FONode.java
===================================================================
--- trunk/foray/foray-fotree/src/java/org/foray/fotree/FONode.java 2007-03-10 02:42:15 UTC (rev 8775)
+++ trunk/foray/foray-fotree/src/java/org/foray/fotree/FONode.java 2007-03-10 02:59:23 UTC (rev 8776)
@@ -39,6 +39,8 @@
import org.apache.commons.logging.Log;
+import java.util.List;
+
import javax.swing.tree.TreeNode;
/**
@@ -47,7 +49,7 @@
public abstract class FONode extends OrderedTreeNode
implements org.axsl.foR.FONode {
- private FONode parent;
+ private FObj parent;
private FONodeProxy proxy;
@@ -60,7 +62,7 @@
/**
* {@inheritDoc}
*/
- public FONode getParent() {
+ public FObj getParent() {
return this.parent;
}
@@ -122,6 +124,16 @@
/**
* {@inheritDoc}
*/
+ public List<FONode> getSiblings() {
+ if (this.getParent() == null) {
+ return null;
+ }
+ return this.getParent().getChildren();
+ }
+
+ /**
+ * {@inheritDoc}
+ */
public void setProxy(final FONodeProxy proxy) {
this.proxy = proxy;
}
Modified: trunk/foray/foray-fotree/src/java/org/foray/fotree/FObj.java
===================================================================
--- trunk/foray/foray-fotree/src/java/org/foray/fotree/FObj.java 2007-03-10 02:42:15 UTC (rev 8775)
+++ trunk/foray/foray-fotree/src/java/org/foray/fotree/FObj.java 2007-03-10 02:59:23 UTC (rev 8776)
@@ -28,6 +28,7 @@
package org.foray.fotree;
+import org.foray.common.OrderedTreeNode;
import org.foray.common.XMLCharacter;
import org.foray.fotree.fo.obj.Table;
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <vic...@us...> - 2007-03-10 03:38:24
|
Revision: 8778
http://svn.sourceforge.net/foray/?rev=8778&view=rev
Author: victormote
Date: 2007-03-09 19:38:10 -0800 (Fri, 09 Mar 2007)
Log Message:
-----------
Conform to axsl changes renaming methods.
Modified Paths:
--------------
trunk/foray/foray-areatree/src/java/org/foray/area/PageRA.java
trunk/foray/foray-areatree/src/java/org/foray/area/TextArea.java
trunk/foray/foray-fotree/src/java/org/foray/fotree/FONode.java
trunk/foray/foray-fotree/src/java/org/foray/fotree/FOText.java
trunk/foray/foray-fotree/src/java/org/foray/fotree/FObj.java
trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/ConditionalPageMasterReference.java
trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/PageSequenceMaster.java
trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/SubSequenceSpecifier.java
trunk/foray/foray-pioneer/src/java/org/foray/pioneer/AbstractTableBodyPL.java
trunk/foray/foray-pioneer/src/java/org/foray/pioneer/BlockContainerPL.java
trunk/foray/foray-pioneer/src/java/org/foray/pioneer/BlockPL.java
trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FObjMixedPL.java
trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FObjPL.java
trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FootnoteBodyPL.java
trunk/foray/foray-pioneer/src/java/org/foray/pioneer/ListBlockPL.java
trunk/foray/foray-pioneer/src/java/org/foray/pioneer/ListItemBodyPL.java
trunk/foray/foray-pioneer/src/java/org/foray/pioneer/ListItemLabelPL.java
trunk/foray/foray-pioneer/src/java/org/foray/pioneer/ListItemPL.java
trunk/foray/foray-pioneer/src/java/org/foray/pioneer/StaticContentPL.java
trunk/foray/foray-pioneer/src/java/org/foray/pioneer/TableCellPL.java
trunk/foray/foray-pioneer/src/java/org/foray/pioneer/TablePL.java
Modified: trunk/foray/foray-areatree/src/java/org/foray/area/PageRA.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/PageRA.java 2007-03-10 03:05:46 UTC (rev 8777)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/PageRA.java 2007-03-10 03:38:10 UTC (rev 8778)
@@ -582,7 +582,7 @@
}
private FOLinkageNormal markerParentLinkage(final Marker marker) {
- final FObj parent = marker.parentFO();
+ final FObj parent = marker.getParent();
final FOLinkage proxy = linkage(parent, null);
if (proxy instanceof FOLinkageNormal) {
return (FOLinkageNormal) proxy;
Modified: trunk/foray/foray-areatree/src/java/org/foray/area/TextArea.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/TextArea.java 2007-03-10 03:05:46 UTC (rev 8777)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/TextArea.java 2007-03-10 03:38:10 UTC (rev 8778)
@@ -595,7 +595,7 @@
return (FObj) generatedBy;
}
/* If generated by FOText. */
- return generatedBy.parentFO();
+ return generatedBy.getParent();
}
public void render(final RenderVisitor visitor) {
Modified: trunk/foray/foray-fotree/src/java/org/foray/fotree/FONode.java
===================================================================
--- trunk/foray/foray-fotree/src/java/org/foray/fotree/FONode.java 2007-03-10 03:05:46 UTC (rev 8777)
+++ trunk/foray/foray-fotree/src/java/org/foray/fotree/FONode.java 2007-03-10 03:38:10 UTC (rev 8778)
@@ -67,6 +67,11 @@
}
/**
+ * {@inheritDoc}
+ */
+ public abstract List<FONode> getChildren();
+
+ /**
* Return this node's effective parent, cast as an FObj.
* This differs from the value returned by
* @param context An object that knows how to resolve FO Tree context
@@ -109,10 +114,6 @@
return forayRetrieve.getParent();
}
- public org.axsl.foR.FObj parentFO() {
- return this.getParent();
- }
-
/**
* {@inheritDoc}
*/
@@ -169,7 +170,7 @@
/**
* {@inheritDoc}
*/
- public org.axsl.foR.FONode getFONodeChildAt(final int childIndex) {
+ public FONode getChildAt(final int childIndex) {
return (FONode) super.getChildAt(childIndex);
}
Modified: trunk/foray/foray-fotree/src/java/org/foray/fotree/FOText.java
===================================================================
--- trunk/foray/foray-fotree/src/java/org/foray/fotree/FOText.java 2007-03-10 03:05:46 UTC (rev 8777)
+++ trunk/foray/foray-fotree/src/java/org/foray/fotree/FOText.java 2007-03-10 03:38:10 UTC (rev 8778)
@@ -28,7 +28,6 @@
package org.foray.fotree;
-import org.foray.common.OrderedTreeNode;
import org.foray.common.WKConstants;
import org.foray.common.XMLCharacter;
import org.foray.fotree.fo.obj.BookmarkTitle;
@@ -101,7 +100,7 @@
* Store the text raw and process it one-the-fly. */
return;
}
- if (this.parentFO() instanceof BookmarkTitle) {
+ if (this.getParent() instanceof BookmarkTitle) {
/* BookmarkTitle keeps its text raw always. */
return;
}
@@ -112,14 +111,10 @@
this.filterStatus = FILTER_PRE_TRANSFORM;
}
- public List<? extends OrderedTreeNode> getChildren() {
+ public List<FONode> getChildren() {
return null;
}
- public List<FONode> childrenFO() {
- return null;
- }
-
public boolean getAllowsChildren() {
return false;
}
@@ -1011,15 +1006,15 @@
}
public String getSystemId() {
- return this.parentFO().getSystemId();
+ return this.getParent().getSystemId();
}
public int getLine() {
- return this.parentFO().getLine();
+ return this.getParent().getLine();
}
public int getColumn() {
- return this.parentFO().getColumn();
+ return this.getParent().getColumn();
}
public FONodeProxy makeProxy(final ProxyFactory factory) {
Modified: trunk/foray/foray-fotree/src/java/org/foray/fotree/FObj.java
===================================================================
--- trunk/foray/foray-fotree/src/java/org/foray/fotree/FObj.java 2007-03-10 03:05:46 UTC (rev 8777)
+++ trunk/foray/foray-fotree/src/java/org/foray/fotree/FObj.java 2007-03-10 03:38:10 UTC (rev 8778)
@@ -360,13 +360,6 @@
/**
* {@inheritDoc}
*/
- public List<FONode> childrenFO() {
- return children;
- }
-
- /**
- * {@inheritDoc}
- */
public boolean getAllowsChildren() {
return true;
}
Modified: trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/ConditionalPageMasterReference.java
===================================================================
--- trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/ConditionalPageMasterReference.java 2007-03-10 03:05:46 UTC (rev 8777)
+++ trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/ConditionalPageMasterReference.java 2007-03-10 03:38:10 UTC (rev 8778)
@@ -104,7 +104,7 @@
*/
public RepeatablePMAlternatives repeatablePMAlternatives() {
/* Cast verified at construction. */
- return (RepeatablePMAlternatives) this.parentFO();
+ return (RepeatablePMAlternatives) this.getParent();
}
/**
Modified: trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/PageSequenceMaster.java
===================================================================
--- trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/PageSequenceMaster.java 2007-03-10 03:05:46 UTC (rev 8777)
+++ trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/PageSequenceMaster.java 2007-03-10 03:38:10 UTC (rev 8778)
@@ -118,7 +118,7 @@
*/
public LayoutMasterSet layoutMasterSet() {
/* Cast verified at construction. */
- return (LayoutMasterSet) this.parentFO();
+ return (LayoutMasterSet) this.getParent();
}
public String getName() {
Modified: trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/SubSequenceSpecifier.java
===================================================================
--- trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/SubSequenceSpecifier.java 2007-03-10 03:05:46 UTC (rev 8777)
+++ trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/SubSequenceSpecifier.java 2007-03-10 03:38:10 UTC (rev 8778)
@@ -78,7 +78,7 @@
*/
public PageSequenceMaster pageSequenceMaster() {
/* Cast verified at validateAncestry(). */
- return (PageSequenceMaster) this.parentFO();
+ return (PageSequenceMaster) this.getParent();
}
/**
Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/AbstractTableBodyPL.java
===================================================================
--- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/AbstractTableBodyPL.java 2007-03-10 03:05:46 UTC (rev 8777)
+++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/AbstractTableBodyPL.java 2007-03-10 03:38:10 UTC (rev 8778)
@@ -174,11 +174,11 @@
areaContainerRef = new WeakReference<ContainerRA>(areaContainer);
List<TableRow> keepWith = new ArrayList<TableRow>();
- final int numChildren = node.childrenFO().size();
+ final int numChildren = node.getChildren().size();
TableRow lastRow = null;
boolean endKeepGroup = true;
for (int i = getProgress(); i < numChildren; i++) {
- final Object child = node.childrenFO().get(i);
+ final Object child = node.getChildren().get(i);
if (child instanceof Marker) {
final MarkerPL markerPL = (MarkerPL) getLayoutProxy(
(FONode) child);
@@ -217,7 +217,7 @@
*/
boolean bRowStartsArea = i == getProgress();
if (bRowStartsArea == false && keepWith.size() > 0) {
- if (node.childrenFO().indexOf(keepWith.get(0))
+ if (node.getChildren().indexOf(keepWith.get(0))
== getProgress()) {
bRowStartsArea = true;
}
Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/BlockContainerPL.java
===================================================================
--- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/BlockContainerPL.java 2007-03-10 03:05:46 UTC (rev 8777)
+++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/BlockContainerPL.java 2007-03-10 03:38:10 UTC (rev 8778)
@@ -59,7 +59,7 @@
this.node, retrieveMarker);
for (int i = this.getProgress(); i < this.node.getChildCount(); i++) {
- final FONode fo = this.node.getFONodeChildAt(i);
+ final FONode fo = this.node.getChildAt(i);
final FObjPL fobjPL = (FObjPL) getLayoutProxy(fo);
fobjPL.layout(blockContainer, retrieveMarker);
}
Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/BlockPL.java
===================================================================
--- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/BlockPL.java 2007-03-10 03:05:46 UTC (rev 8777)
+++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/BlockPL.java 2007-03-10 03:38:10 UTC (rev 8778)
@@ -108,7 +108,7 @@
blockArea = area.makeNormalBlockArea(node, retrieveMarker);
for (int i = getProgress(); i < node.getChildCount(); i++) {
- final FONode fo = node.getFONodeChildAt(i);
+ final FONode fo = node.getChildAt(i);
final FONodePL nodePL = this.getLayoutProxy(fo);
final int status = nodePL.layout(blockArea, retrieveMarker);
if (Status.isIncomplete(status)) {
Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FObjMixedPL.java
===================================================================
--- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FObjMixedPL.java 2007-03-10 03:05:46 UTC (rev 8777)
+++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FObjMixedPL.java 2007-03-10 03:38:10 UTC (rev 8778)
@@ -53,8 +53,8 @@
if (getProgress() == FONodePL.START) {
setProgress(0);
}
- for (int i = getProgress(); i < node.childrenFO().size(); i++) {
- final FONode fo = node.childrenFO().get(i);
+ for (int i = getProgress(); i < node.getChildren().size(); i++) {
+ final FONode fo = node.getChildren().get(i);
final int status = getLayoutProxy(fo).layout(area, retrieveMarker);
if (Status.isIncomplete(status)) {
setProgress(i);
Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FObjPL.java
===================================================================
--- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FObjPL.java 2007-03-10 03:05:46 UTC (rev 8777)
+++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FObjPL.java 2007-03-10 03:38:10 UTC (rev 8778)
@@ -89,7 +89,7 @@
}
List<? extends FONode> getChildren() {
- return ((FObj) this.getFONode()).childrenFO();
+ return ((FObj) this.getFONode()).getChildren();
}
protected int layoutChildren(final Area area,
@@ -99,8 +99,8 @@
if (start == FONodePL.START) {
start = 0;
}
- for (int i = start; i < node.childrenFO().size(); i++) {
- final FONode fo = node.childrenFO().get(i);
+ for (int i = start; i < node.getChildren().size(); i++) {
+ final FONode fo = node.getChildren().get(i);
final FONodePL nodePL = this.getLayoutProxy(fo);
final int status = nodePL.layout(area, retrieveMarker);
if (Status.isIncomplete(status)) {
Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FootnoteBodyPL.java
===================================================================
--- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FootnoteBodyPL.java 2007-03-10 03:05:46 UTC (rev 8777)
+++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FootnoteBodyPL.java 2007-03-10 03:38:10 UTC (rev 8778)
@@ -60,9 +60,9 @@
}
final FootnoteRA referenceArea = (FootnoteRA) area;
- final int numChildren = this.node.childrenFO().size();
+ final int numChildren = this.node.getChildren().size();
for (int i = getProgress(); i < numChildren; i++) {
- final FONode fo = this.node.getFONodeChildAt(i);
+ final FONode fo = this.node.getChildAt(i);
final FONodePL foNodePL = getLayoutProxy(fo);
final int status = foNodePL.layout(referenceArea, retrieveMarker);
if (Status.isIncomplete(status)) {
Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/ListBlockPL.java
===================================================================
--- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/ListBlockPL.java 2007-03-10 03:05:46 UTC (rev 8777)
+++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/ListBlockPL.java 2007-03-10 03:38:10 UTC (rev 8778)
@@ -63,9 +63,9 @@
final ListBlockArea blockArea = area.makeListBlockArea(this.node,
retrieveMarker);
- final int numChildren = this.node.childrenFO().size();
+ final int numChildren = this.node.getChildren().size();
for (int i = listBlockPL.getProgress(); i < numChildren; i++) {
- final ListItem listItem = (ListItem) this.node.childrenFO().get(i);
+ final ListItem listItem = (ListItem) this.node.getChildren().get(i);
final ListItemPL listItemPL = (ListItemPL) getLayoutProxy(
listItem);
int status = listItemPL.layout(blockArea, retrieveMarker);
Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/ListItemBodyPL.java
===================================================================
--- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/ListItemBodyPL.java 2007-03-10 03:05:46 UTC (rev 8777)
+++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/ListItemBodyPL.java 2007-03-10 03:38:10 UTC (rev 8778)
@@ -62,9 +62,9 @@
* of areas returned by each of the children of the fo:list-item-body.
*/
- final int numChildren = this.node.childrenFO().size();
+ final int numChildren = this.node.getChildren().size();
for (int i = getProgress(); i < numChildren; i++) {
- final FObj fo = (FObj) this.node.childrenFO().get(i);
+ final FObj fo = (FObj) this.node.getChildren().get(i);
final int status = getLayoutProxy(fo).layout(area, retrieveMarker);
if (Status.isIncomplete(status)) {
Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/ListItemLabelPL.java
===================================================================
--- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/ListItemLabelPL.java 2007-03-10 03:05:46 UTC (rev 8777)
+++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/ListItemLabelPL.java 2007-03-10 03:38:10 UTC (rev 8778)
@@ -51,14 +51,14 @@
public int layout(final Area area, final RetrieveMarker retrieveMarker)
throws AreaWException {
- final int numChildren = this.node.childrenFO().size();
+ final int numChildren = this.node.getChildren().size();
if (numChildren != 1) {
throw new AreaWException("Non-standard restriction: "
+ "list-item-label must have exactly one block.");
}
- final Block block = (Block) this.node.childrenFO().get(0);
+ final Block block = (Block) this.node.getChildren().get(0);
/*
* For calculating the lineage - The fo:list-item-label formatting
Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/ListItemPL.java
===================================================================
--- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/ListItemPL.java 2007-03-10 03:05:46 UTC (rev 8777)
+++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/ListItemPL.java 2007-03-10 03:38:10 UTC (rev 8778)
@@ -70,7 +70,7 @@
/* Now lay out the list-item-label inside the new block-area. */
final ListItemLabel label =
- (ListItemLabel) this.node.childrenFO().get(0);
+ (ListItemLabel) this.node.getChildren().get(0);
int status;
// what follows doesn't yet take into account whether the
// body failed completely or only got some text in
@@ -84,7 +84,7 @@
}
/* Now create a BlockArea to contain the list-item-body. */
- final ListItemBody body = (ListItemBody) this.node.childrenFO().get(1);
+ final ListItemBody body = (ListItemBody) this.node.getChildren().get(1);
final ListItemBodyPL bodyPL = (ListItemBodyPL) getLayoutProxy(body);
status = bodyPL.layout(group, retrieveMarker);
if (Status.isIncomplete(status)) {
Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/StaticContentPL.java
===================================================================
--- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/StaticContentPL.java 2007-03-10 03:05:46 UTC (rev 8777)
+++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/StaticContentPL.java 2007-03-10 03:38:10 UTC (rev 8778)
@@ -50,10 +50,10 @@
public int layout(final Area area, final RetrieveMarker retrieveMarker)
throws AreaWException {
- final int numChildren = this.node.childrenFO().size();
+ final int numChildren = this.node.getChildren().size();
for (int i = 0; i < numChildren; i++) {
- final FObj fo = (FObj) this.node.childrenFO().get(i);
+ final FObj fo = (FObj) this.node.getChildren().get(i);
int status = getLayoutProxy(fo).layout(area, retrieveMarker);
if (Status.isIncomplete(status)) {
Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/TableCellPL.java
===================================================================
--- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/TableCellPL.java 2007-03-10 03:05:46 UTC (rev 8777)
+++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/TableCellPL.java 2007-03-10 03:38:10 UTC (rev 8778)
@@ -110,9 +110,9 @@
areaContainer = cellArea;
- final int numChildren = this.node.childrenFO().size();
+ final int numChildren = this.node.getChildren().size();
for (int i = getProgress(); bDone == false && i < numChildren; i++) {
- final FObj fo = (FObj) this.node.childrenFO().get(i);
+ final FObj fo = (FObj) this.node.getChildren().get(i);
// Overflows may cause a row to be re-layedout,
// need to pass already processed content.
Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/TablePL.java
===================================================================
--- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/TablePL.java 2007-03-10 03:05:46 UTC (rev 8777)
+++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/TablePL.java 2007-03-10 03:38:10 UTC (rev 8778)
@@ -100,8 +100,8 @@
+ "indicating column-width");
}
- for (int i = getProgress(); i < node.childrenFO().size(); i++) {
- final FONode fo = node.childrenFO().get(i);
+ for (int i = getProgress(); i < node.getChildren().size(); i++) {
+ final FONode fo = node.getChildren().get(i);
if (fo instanceof Marker) {
final MarkerPL markerPL = (MarkerPL) getLayoutProxy(fo);
markerPL.layout(area, retrieveMarker);
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <vic...@us...> - 2007-03-10 03:40:15
|
Revision: 8779
http://svn.sourceforge.net/foray/?rev=8779&view=rev
Author: victormote
Date: 2007-03-09 19:40:16 -0800 (Fri, 09 Mar 2007)
Log Message:
-----------
Remove unneeded casts.
Modified Paths:
--------------
trunk/foray/foray-fotree/src/java/org/foray/fotree/FONode.java
trunk/foray/foray-pioneer/src/java/org/foray/pioneer/ContinuedLabelPL.java
trunk/foray/foray-pioneer/src/java/org/foray/pioneer/RetrieveMarkerPL.java
Modified: trunk/foray/foray-fotree/src/java/org/foray/fotree/FONode.java
===================================================================
--- trunk/foray/foray-fotree/src/java/org/foray/fotree/FONode.java 2007-03-10 03:38:10 UTC (rev 8778)
+++ trunk/foray/foray-fotree/src/java/org/foray/fotree/FONode.java 2007-03-10 03:40:16 UTC (rev 8779)
@@ -162,7 +162,7 @@
return;
}
for (int i = 0; i < this.getChildren().size(); i++) {
- final FONode node = (FONode) this.getChildren().get(i);
+ final FONode node = this.getChildren().get(i);
node.reset();
}
}
Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/ContinuedLabelPL.java
===================================================================
--- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/ContinuedLabelPL.java 2007-03-10 03:38:10 UTC (rev 8778)
+++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/ContinuedLabelPL.java 2007-03-10 03:40:16 UTC (rev 8779)
@@ -68,7 +68,7 @@
if (tableArea != null && tableArea.getPreviousSibling() != null) {
final int numChildren = this.label.getChildren().size();
for (int i = getProgress(); i < numChildren; i++) {
- final FONode fo = (FONode) this.label.getChildren().get(i);
+ final FONode fo = this.label.getChildren().get(i);
int status;
if (Status.isIncomplete(status
= getLayoutProxy(fo).layout(area, retrieveMarker))) {
Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/RetrieveMarkerPL.java
===================================================================
--- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/RetrieveMarkerPL.java 2007-03-10 03:38:10 UTC (rev 8778)
+++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/RetrieveMarkerPL.java 2007-03-10 03:40:16 UTC (rev 8779)
@@ -64,7 +64,7 @@
markerPL.resetProgress();
markerPL.setProgress(0);
for (int i = 0; i < bestMarker.getChildren().size(); i++) {
- final FONode fo = (FONode) bestMarker.getChildren().get(i);
+ final FONode fo = bestMarker.getChildren().get(i);
getLayoutProxy(fo).layout(area, this.node);
}
return Status.OK;
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <vic...@us...> - 2007-03-10 03:53:41
|
Revision: 8780
http://svn.sourceforge.net/foray/?rev=8780&view=rev
Author: victormote
Date: 2007-03-09 19:53:42 -0800 (Fri, 09 Mar 2007)
Log Message:
-----------
Conform to axsl changes renaming methods.
Modified Paths:
--------------
trunk/foray/foray-areatree/src/java/org/foray/area/Area.java
trunk/foray/foray-areatree/src/java/org/foray/area/AreaNode.java
trunk/foray/foray-areatree/src/java/org/foray/area/FOLinkageNormal.java
trunk/foray/foray-areatree/src/java/org/foray/area/LineArea.java
trunk/foray/foray-areatree/src/java/org/foray/area/NormalBlockArea.java
trunk/foray/foray-pioneer/src/java/org/foray/pioneer/AbstractFlowPL.java
trunk/foray/foray-pioneer/src/java/org/foray/pioneer/AbstractTableBodyPL.java
trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FONodePL.java
trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FOTextPL.java
trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FootnoteBodyPL.java
trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FootnotePL.java
trunk/foray/foray-pioneer/src/java/org/foray/pioneer/MarkerPL.java
trunk/foray/foray-pioneer/src/java/org/foray/pioneer/PioneerLS.java
trunk/foray/foray-pioneer/src/java/org/foray/pioneer/RetrieveMarkerPL.java
Modified: trunk/foray/foray-areatree/src/java/org/foray/area/Area.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/Area.java 2007-03-10 03:40:16 UTC (rev 8779)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/Area.java 2007-03-10 03:53:42 UTC (rev 8780)
@@ -83,9 +83,9 @@
}
public BlockContainerRA getNearestAncestorAreaContainer() {
- AreaNode areaNode = this.getAreaNodeParent();
+ AreaNode areaNode = this.getParent();
while (areaNode != null && !(areaNode instanceof BlockContainerRA)) {
- areaNode = areaNode.getAreaNodeParent();
+ areaNode = areaNode.getParent();
}
return (BlockContainerRA) areaNode;
}
@@ -206,7 +206,7 @@
if (getParent() == null) {
return true;
}
- final List<AreaNode> siblings = getAreaNodeParent().getChildren();
+ final List<AreaNode> siblings = getParent().getChildren();
if (siblings == null) {
return true;
}
@@ -220,7 +220,7 @@
if (getParent() == null) {
return true;
}
- final List<AreaNode> siblings = getAreaNodeParent().getChildren();
+ final List<AreaNode> siblings = getParent().getChildren();
if (siblings == null) {
return true;
}
Modified: trunk/foray/foray-areatree/src/java/org/foray/area/AreaNode.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/AreaNode.java 2007-03-10 03:40:16 UTC (rev 8779)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/AreaNode.java 2007-03-10 03:53:42 UTC (rev 8780)
@@ -31,7 +31,6 @@
import org.foray.common.OrderedTreeNode;
import org.axsl.areaW.AreaWException;
-import org.axsl.areaW.PageArea;
import org.axsl.common.FoValue;
import org.axsl.foR.FOContext;
import org.axsl.foR.FONode;
@@ -74,7 +73,7 @@
this.parent = parentArea;
if (! (this instanceof AreaTree)) {
// AreaTree has no parent with which to register
- getAreaNodeParent().getChildren().add(this);
+ getParent().getChildren().add(this);
// Root can't do this because the AreaTreeControl isn't registered.
this.generatedBy = linkage(generatedBy, retrieveMarker);
final FOLinkageNormal normalLinkage = this.getNormalLinkage(
@@ -117,7 +116,7 @@
*/
public void remove() {
// Remove from the Area Tree
- getAreaNodeParent().removeChild(this);
+ getParent().removeChild(this);
// Remove from the FO-Area Tree cross-reference.
this.getNormalLinkage().unregisterGeneratedArea(this);
}
@@ -200,23 +199,11 @@
}
public AreaTree getAreaTree() {
- return getAreaNodeParent().getAreaTree();
+ return getParent().getAreaTree();
}
- public AreaNode getAreaNodeParent() {
- return (AreaNode) getParent();
- }
-
- public org.axsl.areaW.AreaNode getWritableParent() {
- return (org.axsl.areaW.AreaNode) getParent();
- }
-
- public org.axsl.areaW.Area getWritableParentArea() {
- return getParentArea();
- }
-
public Area getParentArea() {
- final AreaNode parent = getAreaNodeParent();
+ final AreaNode parent = getParent();
if (parent == null) {
return null;
}
@@ -238,7 +225,7 @@
}
public Area ancestorBlockAreaNotALineArea() {
- final AreaNode parent = getAreaNodeParent();
+ final AreaNode parent = getParent();
if (parent == null) {
return null;
}
@@ -253,7 +240,7 @@
}
public NormalBlockArea ancestorNormalBlockArea() {
- final AreaNode parent = getAreaNodeParent();
+ final AreaNode parent = getParent();
if (parent == null) {
return null;
}
@@ -276,23 +263,19 @@
}
public PageRA getPage() {
- return getAreaNodeParent().getPage();
+ return getParent().getPage();
}
- public PageArea getWritablePage() {
- return getAreaNodeParent().getPage();
- }
-
public FontConsumer getFontConsumer() {
- return getAreaNodeParent().getFontConsumer();
+ return getParent().getFontConsumer();
}
public TextServer getTextServer() {
- return getAreaNodeParent().getTextServer();
+ return getParent().getTextServer();
}
public Log getLogger() {
- return getAreaNodeParent().getLogger();
+ return getParent().getLogger();
}
/**
@@ -304,7 +287,7 @@
if (this instanceof Area && traitGeneratedBy().isBlockLevelFO()) {
return (Area) this;
}
- return getAreaNodeParent().nearestGeneratedByBlockLevelFO();
+ return getParent().nearestGeneratedByBlockLevelFO();
}
/**
@@ -406,7 +389,7 @@
* @return The ancestor SpanRA, or null if there is none.
*/
public SpanRA ancestorSpanRA() {
- final AreaNode parent = getAreaNodeParent();
+ final AreaNode parent = getParent();
if (parent == null) {
return null;
}
@@ -418,7 +401,7 @@
* @return The ancestor LineArea, or null if there is none.
*/
public LineArea ancestorLineArea() {
- final AreaNode parent = getAreaNodeParent();
+ final AreaNode parent = getParent();
if (parent == null) {
return null;
}
@@ -434,7 +417,7 @@
* implementation instead of the interface (for internal AreaTree use).
*/
public TableRA ancestorTableRA() {
- final AreaNode parent = getAreaNodeParent();
+ final AreaNode parent = getParent();
if (parent == null) {
return null;
}
@@ -449,7 +432,7 @@
}
public PageCollection ancestorPageCollection() {
- final AreaNode parent = getAreaNodeParent();
+ final AreaNode parent = getParent();
if (parent == null) {
return null;
}
Modified: trunk/foray/foray-areatree/src/java/org/foray/area/FOLinkageNormal.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/FOLinkageNormal.java 2007-03-10 03:40:16 UTC (rev 8779)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/FOLinkageNormal.java 2007-03-10 03:53:42 UTC (rev 8780)
@@ -54,7 +54,7 @@
}
public void registerGeneratedArea(final AreaNode areaNode) {
- final AreaNode parent = areaNode.getAreaNodeParent();
+ final AreaNode parent = areaNode.getParent();
if (parent != null) {
/*
* If the parent was generated by the same FObj, then we shouldn't
Modified: trunk/foray/foray-areatree/src/java/org/foray/area/LineArea.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/LineArea.java 2007-03-10 03:40:16 UTC (rev 8779)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/LineArea.java 2007-03-10 03:53:42 UTC (rev 8780)
@@ -457,7 +457,7 @@
if (! this.isFirstChildOfParent()) {
return false;
}
- if (! getAreaNodeParent().isFirstChildOfGeneratedBy()) {
+ if (! getParent().isFirstChildOfGeneratedBy()) {
return false;
}
return true;
@@ -473,7 +473,7 @@
if (! this.isLastChildOfParent()) {
return false;
}
- if (! getAreaNodeParent().isLastChildOfGeneratedBy()) {
+ if (! getParent().isLastChildOfGeneratedBy()) {
return false;
}
return true;
@@ -681,7 +681,7 @@
public void cleanup() {
resetChildren();
setProgressionDimension(0);
- this.getAreaNodeParent().removeChild(this);
+ this.getParent().removeChild(this);
}
public int rrIPD() {
Modified: trunk/foray/foray-areatree/src/java/org/foray/area/NormalBlockArea.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/NormalBlockArea.java 2007-03-10 03:40:16 UTC (rev 8779)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/NormalBlockArea.java 2007-03-10 03:53:42 UTC (rev 8780)
@@ -129,7 +129,7 @@
* {@inheritDoc}
*/
public int getProgressionDimension() {
- if (getAreaNodeParent().traitGeneratedBy() instanceof ListItem) {
+ if (getParent().traitGeneratedBy() instanceof ListItem) {
return listItemPD();
}
return getRawProgressionDimension();
Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/AbstractFlowPL.java
===================================================================
--- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/AbstractFlowPL.java 2007-03-10 03:40:16 UTC (rev 8779)
+++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/AbstractFlowPL.java 2007-03-10 03:53:42 UTC (rev 8780)
@@ -162,7 +162,7 @@
// I don't much like exposing this. (AHS 001217)
final NormalFlowRA column = (NormalFlowRA) currentArea;
// Cast verified at construction.
- final SpanRA span = (SpanRA) column.getWritableParent();
+ final SpanRA span = (SpanRA) column.getParent();
span.setCurrentColumn(span.getCurrentColumn() + 1);
i--;
}
Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/AbstractTableBodyPL.java
===================================================================
--- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/AbstractTableBodyPL.java 2007-03-10 03:40:16 UTC (rev 8779)
+++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/AbstractTableBodyPL.java 2007-03-10 03:53:42 UTC (rev 8780)
@@ -104,7 +104,7 @@
Area area = inputArea;
Area parent = null;
- while ((parent = area.getWritableParentArea()) != null &&
+ while ((parent = area.getParentArea()) != null &&
parent.hasChildren() == false) {
// The area will be the first non-space child in its parent
// Note: it's not added yet!
Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FONodePL.java
===================================================================
--- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FONodePL.java 2007-03-10 03:40:16 UTC (rev 8779)
+++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FONodePL.java 2007-03-10 03:53:42 UTC (rev 8780)
@@ -229,7 +229,7 @@
}
// It did not fit on the line. Create new line & try again.
final NormalBlockArea blockArea
- = (NormalBlockArea) lineArea.getWritableParentArea();
+ = (NormalBlockArea) lineArea.getParentArea();
lineArea = blockArea.createNextLineArea(false);
final BlockPL blockPL = this.layout.getBlockPL(blockArea);
blockPL.setCurrentLineArea(lineArea);
@@ -259,7 +259,7 @@
if (area instanceof NormalBlockArea) {
blockArea = (NormalBlockArea) area;
} else {
- blockArea = area.ancestorWritableNormalBlockArea();
+ blockArea = area.ancestorNormalBlockArea();
}
if (blockArea == null) {
final FONode foNode = this.getFONode();
Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FOTextPL.java
===================================================================
--- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FOTextPL.java 2007-03-10 03:40:16 UTC (rev 8779)
+++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FOTextPL.java 2007-03-10 03:53:42 UTC (rev 8780)
@@ -83,7 +83,7 @@
if (la == null) {
return start;
}
- final NormalBlockArea ba = la.ancestorWritableNormalBlockArea();
+ final NormalBlockArea ba = la.ancestorNormalBlockArea();
start = addTextItemToLine(la, lineText, start, end, retrieveMarker);
while (start != -1) {
final BlockPL blockPL = getLayout().getBlockPL(ba);
Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FootnoteBodyPL.java
===================================================================
--- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FootnoteBodyPL.java 2007-03-10 03:40:16 UTC (rev 8779)
+++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FootnoteBodyPL.java 2007-03-10 03:53:42 UTC (rev 8780)
@@ -98,7 +98,7 @@
if (footArea.hasChildren()) {
return;
}
- final PageSequence pageSeq = bac.getWritablePage()
+ final PageSequence pageSeq = bac.getPage()
.getWritablePageCollection().getPageSequence();
final StaticContent separator = pageSeq.getFootnoteSeparator();
if (separator == null) {
Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FootnotePL.java
===================================================================
--- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FootnotePL.java 2007-03-10 03:40:16 UTC (rev 8779)
+++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FootnotePL.java 2007-03-10 03:53:42 UTC (rev 8780)
@@ -67,7 +67,7 @@
/* Layout the FootnoteBody. */
final FootnoteBody fbody = this.node.getFootnoteBody();
final FootnoteBodyPL fbPL = (FootnoteBodyPL) getLayoutProxy(fbody);
- final PageArea page = area.getWritablePage();
+ final PageArea page = area.getPage();
/* If the footnote cannot be entirely laid out on the current page,
* it will be added to the list of pending footnotes. */
fbPL.layoutFootnote(page, retrieveMarker);
Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/MarkerPL.java
===================================================================
--- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/MarkerPL.java 2007-03-10 03:40:16 UTC (rev 8779)
+++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/MarkerPL.java 2007-03-10 03:53:42 UTC (rev 8780)
@@ -48,7 +48,7 @@
public int layout(final Area area, final RetrieveMarker retrieveMarker) {
// no layout action desired
- area.getWritablePage().registerMarker(this.node);
+ area.getPage().registerMarker(this.node);
return Status.OK;
}
Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/PioneerLS.java
===================================================================
--- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/PioneerLS.java 2007-03-10 03:40:16 UTC (rev 8779)
+++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/PioneerLS.java 2007-03-10 03:53:42 UTC (rev 8780)
@@ -255,7 +255,7 @@
// if first ColumnArea, empty, _and_ in odd page,
// return OK
if (!colArea.hasChildren() && (colArea.siblingIndex() == 0)
- && (colArea.getWritablePage().getNumber() % 2 != 0)) {
+ && (colArea.getPage().getNumber() % 2 != 0)) {
return Status.OK;
}
return Status.FORCE_PAGE_BREAK_ODD;
@@ -264,7 +264,7 @@
// if first ColumnArea, empty, _and_ in even page,
// return OK
if (!colArea.hasChildren() && (colArea.siblingIndex() == 0)
- && (colArea.getWritablePage().getNumber() % 2 == 0)) {
+ && (colArea.getPage().getNumber() % 2 == 0)) {
return Status.OK;
}
return Status.FORCE_PAGE_BREAK_EVEN;
Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/RetrieveMarkerPL.java
===================================================================
--- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/RetrieveMarkerPL.java 2007-03-10 03:40:16 UTC (rev 8779)
+++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/RetrieveMarkerPL.java 2007-03-10 03:53:42 UTC (rev 8780)
@@ -54,7 +54,7 @@
/* RetrieveMarker can only exist in static content, so we don't care
* about tracking or setting progress at all. It either fits or it
* doesn't. */
- final PageArea containingPage = area.getWritablePage();
+ final PageArea containingPage = area.getPage();
final Marker bestMarker = containingPage.bestMarker(this.node);
if (bestMarker == null) {
return Status.OK;
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <vic...@us...> - 2007-03-10 17:35:13
|
Revision: 8783
http://svn.sourceforge.net/foray/?rev=8783&view=rev
Author: victormote
Date: 2007-03-10 09:35:12 -0800 (Sat, 10 Mar 2007)
Log Message:
-----------
Javadoc improvements.
Modified Paths:
--------------
trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/ExternalGraphic.java
trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/Region.java
trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/RegionBefore.java
trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/RegionBody.java
trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/RegionEnd.java
trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/RegionStart.java
trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/SimplePageMaster.java
trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/Table.java
trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/TableCell.java
trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/TableColumn.java
trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/prop/AbsoluteOffset.java
trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/prop/BorderColor.java
trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/prop/BorderStyle.java
trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/prop/BorderWidth.java
trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/prop/ContentDimension.java
trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/prop/Enumerated.java
trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/prop/Indent.java
trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/prop/LineHeight.java
trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/prop/Margin.java
trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/prop/Padding.java
trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/prop/PageDimension.java
trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/prop/TextDecoration.java
trunk/foray/foray-fotree/src/java/org/foray/fotree/parse/PropertyParser.java
trunk/foray/foray-fotree/src/java/org/foray/fotree/parse/PropertyTokenizer.java
trunk/foray/foray-fotree/src/java/org/foray/fotree/value/DtAngle.java
trunk/foray/foray-fotree/src/java/org/foray/fotree/value/DtCharacter.java
trunk/foray/foray-fotree/src/java/org/foray/fotree/value/DtColor.java
trunk/foray/foray-fotree/src/java/org/foray/fotree/value/DtCountry.java
trunk/foray/foray-fotree/src/java/org/foray/fotree/value/DtInteger.java
trunk/foray/foray-fotree/src/java/org/foray/fotree/value/DtLanguage.java
trunk/foray/foray-fotree/src/java/org/foray/fotree/value/DtLength.java
trunk/foray/foray-fotree/src/java/org/foray/fotree/value/DtName.java
trunk/foray/foray-fotree/src/java/org/foray/fotree/value/DtPercentage.java
trunk/foray/foray-fotree/src/java/org/foray/fotree/value/DtScript.java
trunk/foray/foray-fotree/src/java/org/foray/fotree/value/DtString.java
trunk/foray/foray-fotree/src/java/org/foray/fotree/value/DtTextDeco.java
trunk/foray/foray-fotree/src/java/org/foray/fotree/value/DtURI.java
trunk/foray/foray-fotree/src/java/org/foray/fotree/value/ExprMultiplicative.java
trunk/foray/foray-fotree/src/java/org/foray/fotree/value/ExprMultiplicativeOper.java
trunk/foray/foray-fotree/src/java/org/foray/fotree/value/ExprUnary.java
trunk/foray/foray-fotree/src/java/org/foray/fotree/value/ExprUnaryOper.java
trunk/foray/foray-fotree/src/java/org/foray/fotree/value/Function.java
trunk/foray/foray-fotree/src/java/org/foray/fotree/value/PropertyCollection.java
trunk/foray/foray-fotree/src/java/org/foray/fotree/value/ValueCollection.java
trunk/foray/scripts/checkstyle-suppressions.xml
Modified: trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/ExternalGraphic.java
===================================================================
--- trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/ExternalGraphic.java 2007-03-10 16:43:26 UTC (rev 8782)
+++ trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/ExternalGraphic.java 2007-03-10 17:35:12 UTC (rev 8783)
@@ -118,6 +118,7 @@
}
/**
+ * Returns the resolved Graphic instance.
* @return The resolved Graphic instance encapsulated by this FO.
*/
public Graphic getGraphic(final FOContext context) {
Modified: trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/Region.java
===================================================================
--- trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/Region.java 2007-03-10 16:43:26 UTC (rev 8782)
+++ trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/Region.java 2007-03-10 17:35:12 UTC (rev 8783)
@@ -123,6 +123,7 @@
}
/**
+ * Returns the default region name.
* Returns the default region name (xsl-region-before, xsl-region-start,
* etc.)
*/
@@ -134,8 +135,7 @@
}
/**
- * Checks to see if a given region name is one of the reserved names
- *
+ * Checks to see if a given region name is one of the reserved names.
* @param name a region name to check
* @return true if the name parameter is a reserved region name
*/
Modified: trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/RegionBefore.java
===================================================================
--- trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/RegionBefore.java 2007-03-10 16:43:26 UTC (rev 8782)
+++ trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/RegionBefore.java 2007-03-10 17:35:12 UTC (rev 8783)
@@ -71,7 +71,7 @@
}
/**
- * Inherited documentation: @inheritDoc
+ * {@inheritDoc}
*/
public int getXPositionVPContent(final FOContext context) {
final int pageWidth = getPageMaster().traitPageWidth();
@@ -83,7 +83,7 @@
}
/**
- * Inherited documentation: @inheritDoc
+ * {@inheritDoc}
*/
public int getYPositionVPContent(final FOContext context) {
final int pageWidth = getPageMaster().traitPageWidth();
@@ -92,7 +92,7 @@
}
/**
- * Inherited documentation: @inheritDoc
+ * {@inheritDoc}
*/
public int getWidthVPContent(final FOContext context) {
final int pageWidth = getPageMaster().traitPageWidth();
@@ -107,12 +107,15 @@
}
/**
- * Inherited documentation: @inheritDoc
+ * {@inheritDoc}
*/
public int getHeightVPContent(final FOContext context) {
return traitExtent();
}
+ /**
+ * {@inheritDoc}
+ */
public FONodeProxy makeProxy(final ProxyFactory factory) {
return factory.makeProxy(this);
}
Modified: trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/RegionBody.java
===================================================================
--- trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/RegionBody.java 2007-03-10 16:43:26 UTC (rev 8782)
+++ trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/RegionBody.java 2007-03-10 17:35:12 UTC (rev 8783)
@@ -71,7 +71,7 @@
}
/**
- * Inherited documentation: @inheritDoc
+ * {@inheritDoc}
*/
public int getXPositionVPContent(final FOContext context) {
final int pageWidth = getPageMaster().traitPageWidth();
@@ -82,7 +82,7 @@
}
/**
- * Inherited documentation: @inheritDoc
+ * {@inheritDoc}
*/
public int getYPositionVPContent(final FOContext context) {
final int pageWidth = getPageMaster().traitPageWidth();
@@ -94,7 +94,7 @@
}
/**
- * Inherited documentation: @inheritDoc
+ * {@inheritDoc}
*/
public int getWidthVPContent(final FOContext context) {
final int pageWidth = getPageMaster().traitPageWidth();
@@ -106,7 +106,7 @@
}
/**
- * Inherited documentation: @inheritDoc
+ * {@inheritDoc}
*/
public int getHeightVPContent(final FOContext context) {
final int pageWidth = getPageMaster().traitPageWidth();
@@ -117,6 +117,9 @@
- this.getMarginBottom(context, pageWidth);
}
+ /**
+ * {@inheritDoc}
+ */
public FONodeProxy makeProxy(final ProxyFactory factory) {
return factory.makeProxy(this);
}
Modified: trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/RegionEnd.java
===================================================================
--- trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/RegionEnd.java 2007-03-10 16:43:26 UTC (rev 8782)
+++ trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/RegionEnd.java 2007-03-10 17:35:12 UTC (rev 8783)
@@ -70,7 +70,7 @@
}
/**
- * Inherited documentation: @inheritDoc
+ * {@inheritDoc}
*/
public int getXPositionVPContent(final FOContext context) {
return getPageMaster().getXPositionRAContent()
@@ -79,7 +79,7 @@
}
/**
- * Inherited documentation: @inheritDoc
+ * {@inheritDoc}
*/
public int getYPositionVPContent(final FOContext context) {
int yPosition = getPageMaster().getYPositionRAContent();
@@ -90,14 +90,14 @@
}
/**
- * Inherited documentation: @inheritDoc
+ * {@inheritDoc}
*/
public int getWidthVPContent(final FOContext context) {
return traitExtent();
}
/**
- * Inherited documentation: @inheritDoc
+ * {@inheritDoc}
*/
public int getHeightVPContent(final FOContext context) {
int height = getPageMaster().getHeightRAContent();
@@ -110,6 +110,9 @@
return height;
}
+ /**
+ * {@inheritDoc}
+ */
public FONodeProxy makeProxy(final ProxyFactory factory) {
return factory.makeProxy(this);
}
Modified: trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/RegionStart.java
===================================================================
--- trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/RegionStart.java 2007-03-10 16:43:26 UTC (rev 8782)
+++ trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/RegionStart.java 2007-03-10 17:35:12 UTC (rev 8783)
@@ -62,23 +62,29 @@
return;
}
+ /**
+ * {@inheritDoc}
+ */
public String getName() {
return "region-start";
}
+ /**
+ * {@inheritDoc}
+ */
public String getDefaultRegionName() {
return "xsl-region-start";
}
/**
- * Inherited documentation: @inheritDoc
+ * {@inheritDoc}
*/
public int getXPositionVPContent(final FOContext context) {
return getPageMaster().getXPositionRAContent();
}
/**
- * Inherited documentation: @inheritDoc
+ * {@inheritDoc}
*/
public int getYPositionVPContent(final FOContext context) {
int yPosition = getPageMaster().getYPositionRAContent();
@@ -89,14 +95,14 @@
}
/**
- * Inherited documentation: @inheritDoc
+ * {@inheritDoc}
*/
public int getWidthVPContent(final FOContext context) {
return traitExtent();
}
/**
- * Inherited documentation: @inheritDoc
+ * {@inheritDoc}
*/
public int getHeightVPContent(final FOContext context) {
int height = getPageMaster().getHeightRAContent();
@@ -109,6 +115,9 @@
return height;
}
+ /**
+ * {@inheritDoc}
+ */
public FONodeProxy makeProxy(final ProxyFactory factory) {
return factory.makeProxy(this);
}
Modified: trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/SimplePageMaster.java
===================================================================
--- trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/SimplePageMaster.java 2007-03-10 16:43:26 UTC (rev 8782)
+++ trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/SimplePageMaster.java 2007-03-10 17:35:12 UTC (rev 8783)
@@ -219,6 +219,7 @@
}
/**
+ * Returns the X position of the upper-left corner of the page.
* @return The X Position of the upper left corner of the page's reference
* area's content rectangle, in millipoints.
*/
@@ -229,6 +230,7 @@
}
/**
+ * Returns the Y position of the upper-left corner of the page.
* @return The Y Position of the upper left corner of the page's reference
* area's content rectangle, in millipoints.
*/
@@ -240,6 +242,7 @@
}
/**
+ * Returns the width of the page.
* @return The width of the page's reference area's content rectangle, in
* millipoints.
*/
@@ -252,6 +255,7 @@
}
/**
+ * Returns the height of the page.
* @return The height of the page's reference area's content rectangle, in
* millipoints.
*/
Modified: trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/Table.java
===================================================================
--- trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/Table.java 2007-03-10 16:43:26 UTC (rev 8782)
+++ trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/Table.java 2007-03-10 17:35:12 UTC (rev 8783)
@@ -136,15 +136,22 @@
}
}
+ /**
+ * {@inheritDoc}
+ */
public String getName() {
return "table";
}
+ /**
+ * {@inheritDoc}
+ */
public void end() throws FOTreeException {
return;
}
/**
+ * Process one column of the table.
* @param columnNumber
* @param c
* @throws FOTreeException
@@ -217,23 +224,30 @@
return this.columns[index];
}
+ /**
+ * {@inheritDoc}
+ */
public org.axsl.foR.fo.TableColumn[] getTableColumns() {
return this.columns;
}
/**
- * @return Returns the tableFooter.
+ * {@inheritDoc}
*/
public org.axsl.foR.fo.TableFooter getTableFooter() {
return tableFooter;
}
+
/**
- * @return Returns the tableHeader.
+ * {@inheritDoc}
*/
public org.axsl.foR.fo.TableHeader getTableHeader() {
return tableHeader;
}
+ /**
+ * {@inheritDoc}
+ */
public FONodeProxy makeProxy(final ProxyFactory factory) {
return factory.makeProxy(this);
}
Modified: trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/TableCell.java
===================================================================
--- trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/TableCell.java 2007-03-10 16:43:26 UTC (rev 8782)
+++ trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/TableCell.java 2007-03-10 17:35:12 UTC (rev 8783)
@@ -95,6 +95,7 @@
}
/**
+ * Returns the previous table cell.
* @return The previous TableCell object in the parent TableRow, or null
* if this is the first cell in the row.
*/
@@ -118,6 +119,7 @@
}
/**
+ * Returns the next table cell.
* @return The next TableCell object in the parent TableRow, or null if this
* is the last cell in the row.
*/
Modified: trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/TableColumn.java
===================================================================
--- trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/TableColumn.java 2007-03-10 16:43:26 UTC (rev 8782)
+++ trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/TableColumn.java 2007-03-10 17:35:12 UTC (rev 8783)
@@ -93,7 +93,7 @@
}
/**
- *
+ * Returns the previous table column.
* @return The previous TableColumn object in the table, or null if this
* is the first column.
*/
@@ -117,7 +117,7 @@
}
/**
- *
+ * Returns the next table column.
* @return The next TableColumn object in the table, or null if this
* is the last column.
*/
Modified: trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/prop/AbsoluteOffset.java
===================================================================
--- trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/prop/AbsoluteOffset.java 2007-03-10 16:43:26 UTC (rev 8782)
+++ trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/prop/AbsoluteOffset.java 2007-03-10 17:35:12 UTC (rev 8783)
@@ -122,8 +122,9 @@
}
/**
+ * Returns the property associated with a given direction.
* @param direction One of the absolute directional constants.
- * @return String representation of the raw property name.
+ * @return The property associated with <code>direction</code>.
*/
public static FoProperty rawPropertyName(final Compass direction) {
if (direction == Compass.TOP) {
Modified: trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/prop/BorderColor.java
===================================================================
--- trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/prop/BorderColor.java 2007-03-10 16:43:26 UTC (rev 8782)
+++ trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/prop/BorderColor.java 2007-03-10 17:35:12 UTC (rev 8783)
@@ -133,8 +133,9 @@
}
/**
+ * Returns the property associated with a given directional constant.
* @param direction One of the directional constants.
- * @return String representation of the raw property name.
+ * @return The property associated with <code>direction</code>.
*/
public static FoProperty rawPropertyType(final Compass direction) {
if (direction == Compass.BEFORE) {
Modified: trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/prop/BorderStyle.java
===================================================================
--- trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/prop/BorderStyle.java 2007-03-10 16:43:26 UTC (rev 8782)
+++ trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/prop/BorderStyle.java 2007-03-10 17:35:12 UTC (rev 8783)
@@ -97,6 +97,7 @@
}
/**
+ * Converts the raw value to simple value.
* @param value
* @throws PropertyException
*/
@@ -176,8 +177,9 @@
}
/**
+ * Converts a raw directional constant into its related property.
* @param direction One of the directional constants.
- * @return String representation of the raw property name.
+ * @return The property related to <code>direction</code>.
*/
public static FoProperty rawPropertyType(final Compass direction) {
if (direction == Compass.BEFORE) {
Modified: trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/prop/BorderWidth.java
===================================================================
--- trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/prop/BorderWidth.java 2007-03-10 16:43:26 UTC (rev 8782)
+++ trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/prop/BorderWidth.java 2007-03-10 17:35:12 UTC (rev 8783)
@@ -229,8 +229,9 @@
}
/**
+ * Converts a raw direction into its related property.
* @param direction One of the directional constants.
- * @return String representation of the raw property name.
+ * @return The property related to <code>direction</code>.
*/
public static FoProperty rawPropertyType(final Compass direction) {
if (direction == Compass.BEFORE) {
Modified: trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/prop/ContentDimension.java
===================================================================
--- trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/prop/ContentDimension.java 2007-03-10 16:43:26 UTC (rev 8782)
+++ trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/prop/ContentDimension.java 2007-03-10 17:35:12 UTC (rev 8783)
@@ -145,6 +145,7 @@
}
/**
+ * Converts an absolute axis into its related property.
* @param absoluteAxis One of the absolute axes (either AXIS_HORIZONTAL,
* or AXIS_VERTICAL).
* @return Either {@link FoProperty#CONTENT_WIDTH} or
Modified: trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/prop/Enumerated.java
===================================================================
--- trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/prop/Enumerated.java 2007-03-10 16:43:26 UTC (rev 8782)
+++ trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/prop/Enumerated.java 2007-03-10 17:35:12 UTC (rev 8783)
@@ -40,9 +40,7 @@
import org.axsl.foR.FOContext;
/**
- * This class handles the following properties:
- * absolute-position,
- *
+ * Properties that have only enumerated values.
*/
public class Enumerated extends AbstractFoProperty {
@@ -342,7 +340,7 @@
}
/**
- *
+ * Returns the inherited value for this property.
* @param context An object that knows how to resolve FO Tree context
* issues.
* @param fobj This is the ancestor FObj node that should be used to get
Modified: trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/prop/Indent.java
===================================================================
--- trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/prop/Indent.java 2007-03-10 16:43:26 UTC (rev 8782)
+++ trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/prop/Indent.java 2007-03-10 17:35:12 UTC (rev 8783)
@@ -136,8 +136,9 @@
}
/**
+ * Converts a directional constant into its related property.
* @param direction One of the directional constants.
- * @return String representation of the raw property name.
+ * @return The property related to <code>direction</code>.
*/
public static FoProperty rawPropertyType(final Compass direction) {
if (direction == Compass.START) {
Modified: trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/prop/LineHeight.java
===================================================================
--- trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/prop/LineHeight.java 2007-03-10 16:43:26 UTC (rev 8782)
+++ trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/prop/LineHeight.java 2007-03-10 17:35:12 UTC (rev 8783)
@@ -119,6 +119,7 @@
}
/**
+ * Returns the value for this property.
* @param rangeID One of MINIMUM, OPTIMUM, OR MAXIMUM.
*/
public int getValue(final FOContext context, final byte rangeID,
Modified: trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/prop/Margin.java
===================================================================
--- trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/prop/Margin.java 2007-03-10 16:43:26 UTC (rev 8782)
+++ trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/prop/Margin.java 2007-03-10 17:35:12 UTC (rev 8783)
@@ -207,8 +207,9 @@
}
/**
+ * Converts a directional constant into its related property.
* @param direction One of the absolute directional constants.
- * @return String representation of the raw property name.
+ * @return The property related to <code>direction</code>.
*/
public static FoProperty rawPropertyType(final Compass direction) {
if (direction == Compass.TOP) {
Modified: trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/prop/Padding.java
===================================================================
--- trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/prop/Padding.java 2007-03-10 16:43:26 UTC (rev 8782)
+++ trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/prop/Padding.java 2007-03-10 17:35:12 UTC (rev 8783)
@@ -206,8 +206,9 @@
}
/**
+ * Converts a directional constant into its related property.
* @param direction One of the directional constants.
- * @return String representation of the raw property name.
+ * @return The property related to <code>direction</code>.
*/
public static FoProperty rawPropertyType(final Compass direction) {
if (direction == Compass.BEFORE) {
Modified: trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/prop/PageDimension.java
===================================================================
--- trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/prop/PageDimension.java 2007-03-10 16:43:26 UTC (rev 8782)
+++ trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/prop/PageDimension.java 2007-03-10 17:35:12 UTC (rev 8783)
@@ -135,8 +135,9 @@
}
/**
+ * Converts an absolute axis into its related property.
* @param axis One of the absolute axes.
- * @return String representation of the raw property name.
+ * @return The property related to <code>direction</code>.
*/
public static FoProperty rawPropertyType(final AbsoluteAxis axis) {
if (axis == AbsoluteAxis.HORIZONTAL) {
Modified: trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/prop/TextDecoration.java
===================================================================
--- trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/prop/TextDecoration.java 2007-03-10 16:43:26 UTC (rev 8782)
+++ trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/prop/TextDecoration.java 2007-03-10 17:35:12 UTC (rev 8783)
@@ -94,6 +94,7 @@
}
/**
+ * Processes one keyword.
* @param value
* @throws PropertyException
*/
Modified: trunk/foray/foray-fotree/src/java/org/foray/fotree/parse/PropertyParser.java
===================================================================
--- trunk/foray/foray-fotree/src/java/org/foray/fotree/parse/PropertyParser.java 2007-03-10 16:43:26 UTC (rev 8782)
+++ trunk/foray/foray-fotree/src/java/org/foray/fotree/parse/PropertyParser.java 2007-03-10 17:35:12 UTC (rev 8783)
@@ -65,7 +65,7 @@
private PropertyList propertyList;
- /** Stack of functions being evaluated */
+ /** Stack of functions being evaluated. */
private Stack<Function> stkFunction;
/**
Modified: trunk/foray/foray-fotree/src/java/org/foray/fotree/parse/PropertyTokenizer.java
===================================================================
--- trunk/foray/foray-fotree/src/java/org/foray/fotree/parse/PropertyTokenizer.java 2007-03-10 16:43:26 UTC (rev 8782)
+++ trunk/foray/foray-fotree/src/java/org/foray/fotree/parse/PropertyTokenizer.java 2007-03-10 17:35:12 UTC (rev 8783)
@@ -393,6 +393,7 @@
}
/**
+ * Returns the current token value.
* @return Returns the currentTokenValue.
*/
public String getCurrentTokenValue() {
@@ -400,6 +401,7 @@
}
/**
+ * Returns the current token.
* @return Returns the currentToken.
*/
public int getCurrentToken() {
@@ -407,6 +409,7 @@
}
/**
+ * Returns the current unit length.
* @return Returns the currentUnitLength.
*/
public int getCurrentUnitLength() {
Modified: trunk/foray/foray-fotree/src/java/org/foray/fotree/value/DtAngle.java
===================================================================
--- trunk/foray/foray-fotree/src/java/org/foray/fotree/value/DtAngle.java 2007-03-10 16:43:26 UTC (rev 8782)
+++ trunk/foray/foray-fotree/src/java/org/foray/fotree/value/DtAngle.java 2007-03-10 17:35:12 UTC (rev 8783)
@@ -43,7 +43,7 @@
/** The signed number value. */
private float value = 0;
- /** The unit identifier **/
+ /** The unit identifier. **/
private byte unitID;
/**
@@ -61,6 +61,7 @@
}
/**
+ * Returns the value of this angle.
* @return The normalized value of this angle, i.e. a value between 0
* and 360 degrees, in degrees.
*/
Modified: trunk/foray/foray-fotree/src/java/org/foray/fotree/value/DtCharacter.java
===================================================================
--- trunk/foray/foray-fotree/src/java/org/foray/fotree/value/DtCharacter.java 2007-03-10 16:43:26 UTC (rev 8782)
+++ trunk/foray/foray-fotree/src/java/org/foray/fotree/value/DtCharacter.java 2007-03-10 17:35:12 UTC (rev 8783)
@@ -45,6 +45,7 @@
}
/**
+ * Returns the value.
* @return The char value.
*/
public char getValue() {
Modified: trunk/foray/foray-fotree/src/java/org/foray/fotree/value/DtColor.java
===================================================================
--- trunk/foray/foray-fotree/src/java/org/foray/fotree/value/DtColor.java 2007-03-10 16:43:26 UTC (rev 8782)
+++ trunk/foray/foray-fotree/src/java/org/foray/fotree/value/DtColor.java 2007-03-10 17:35:12 UTC (rev 8783)
@@ -295,6 +295,7 @@
}
/**
+ * Returns the color value.
* @return The color.
*/
public Color getValue() {
@@ -413,6 +414,7 @@
}
/**
+ * Converts a String color description to a DtColor instance.
* set the colour given a particular String specifying either a
* colour name or #RGB or #RRGGBB
*/
Modified: trunk/foray/foray-fotree/src/java/org/foray/fotree/value/DtCountry.java
===================================================================
--- trunk/foray/foray-fotree/src/java/org/foray/fotree/value/DtCountry.java 2007-03-10 16:43:26 UTC (rev 8782)
+++ trunk/foray/foray-fotree/src/java/org/foray/fotree/value/DtCountry.java 2007-03-10 17:35:12 UTC (rev 8783)
@@ -50,6 +50,7 @@
}
/**
+ * Return the value.
* @return The value of this number.
*/
public String getValue() {
Modified: trunk/foray/foray-fotree/src/java/org/foray/fotree/value/DtInteger.java
===================================================================
--- trunk/foray/foray-fotree/src/java/org/foray/fotree/value/DtInteger.java 2007-03-10 16:43:26 UTC (rev 8782)
+++ trunk/foray/foray-fotree/src/java/org/foray/fotree/value/DtInteger.java 2007-03-10 17:35:12 UTC (rev 8783)
@@ -46,6 +46,7 @@
}
/**
+ * Return the value.
* @return The value of this number.
*/
public int getValue() {
Modified: trunk/foray/foray-fotree/src/java/org/foray/fotree/value/DtLanguage.java
===================================================================
--- trunk/foray/foray-fotree/src/java/org/foray/fotree/value/DtLanguage.java 2007-03-10 16:43:26 UTC (rev 8782)
+++ trunk/foray/foray-fotree/src/java/org/foray/fotree/value/DtLanguage.java 2007-03-10 17:35:12 UTC (rev 8783)
@@ -49,6 +49,7 @@
}
/**
+ * Return the value.
* @return The value of this number.
*/
public String getValue() {
Modified: trunk/foray/foray-fotree/src/java/org/foray/fotree/value/DtLength.java
===================================================================
--- trunk/foray/foray-fotree/src/java/org/foray/fotree/value/DtLength.java 2007-03-10 16:43:26 UTC (rev 8782)
+...
[truncated message content] |
|
From: <vic...@us...> - 2007-03-13 17:19:50
|
Revision: 8795
http://svn.sourceforge.net/foray/?rev=8795&view=rev
Author: victormote
Date: 2007-03-13 10:18:30 -0700 (Tue, 13 Mar 2007)
Log Message:
-----------
Javadoc improvements.
Modified Paths:
--------------
trunk/foray/foray-areatree/src/java/org/foray/area/AreaFlexible.java
trunk/foray/foray-areatree/src/java/org/foray/area/AreaNode.java
trunk/foray/foray-areatree/src/java/org/foray/area/AreaTree.java
trunk/foray/foray-areatree/src/java/org/foray/area/FOLinkageMarker.java
trunk/foray/foray-areatree/src/java/org/foray/area/FOrayAreaTreeFactory.java
trunk/foray/foray-areatree/src/java/org/foray/area/GenericContainer.java
trunk/foray/foray-areatree/src/java/org/foray/area/LineArea.java
trunk/foray/foray-areatree/src/java/org/foray/area/MainRA.java
trunk/foray/foray-areatree/src/java/org/foray/area/MarkerContentArea.java
trunk/foray/foray-areatree/src/java/org/foray/area/PageCollection.java
trunk/foray/foray-areatree/src/java/org/foray/area/PageRA.java
trunk/foray/foray-areatree/src/java/org/foray/area/RegionRABody.java
trunk/foray/foray-areatree/src/java/org/foray/area/SpanRA.java
trunk/foray/foray-areatree/src/java/org/foray/area/TableCellRA.java
trunk/foray/foray-areatree/src/java/org/foray/area/TableRA.java
trunk/foray/scripts/checkstyle-suppressions.xml
Modified: trunk/foray/foray-areatree/src/java/org/foray/area/AreaFlexible.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/AreaFlexible.java 2007-03-13 16:58:48 UTC (rev 8794)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/AreaFlexible.java 2007-03-13 17:18:30 UTC (rev 8795)
@@ -40,18 +40,11 @@
*/
public abstract class AreaFlexible extends Area {
- /**
- * See {@link #getProgressionDimension()} for a description of
- * "progression dimension".
- */
- /*
- * It is conceivable that this variable could be replaced by a computation
- * that accumulates the sizes of the child nodes.
- */
+ /** See {@link #getProgressionDimension()} for a description of
+ * "progression dimension". */
private int progressionDimension = 0;
- /**
- * See {@link #getAnteriorSpace()} for a description of "anterior space".
+ /** See {@link #getAnteriorSpace()} for a description of "anterior space".
*/
private int anteriorSpace;
Modified: trunk/foray/foray-areatree/src/java/org/foray/area/AreaNode.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/AreaNode.java 2007-03-13 16:58:48 UTC (rev 8794)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/AreaNode.java 2007-03-13 17:18:30 UTC (rev 8795)
@@ -55,6 +55,7 @@
/** The parent of this node. */
private AreaNode parent;
+ /** The children of this node. */
private List<AreaNode> children = new ArrayList<AreaNode>();
/** The "generated-by" trait, as defined in Section 6.1.1. */
Modified: trunk/foray/foray-areatree/src/java/org/foray/area/AreaTree.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/AreaTree.java 2007-03-13 16:58:48 UTC (rev 8794)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/AreaTree.java 2007-03-13 17:18:30 UTC (rev 8795)
@@ -56,9 +56,16 @@
public class AreaTree extends NonArea implements org.axsl.areaR.AreaTree,
org.axsl.areaW.AreaTree {
+ /** The font consumer for this area tree. */
private FontConsumer fontConsumer;
+
+ /** The text server for this area tree. */
private TextServer textServer;
+
+ /** The logger. */
private Log logger;
+
+ /** The list of markers in this document. */
private List<Marker> documentMarkers = new ArrayList<Marker>();
/**
Modified: trunk/foray/foray-areatree/src/java/org/foray/area/FOLinkageMarker.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/FOLinkageMarker.java 2007-03-13 16:58:48 UTC (rev 8794)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/FOLinkageMarker.java 2007-03-13 17:18:30 UTC (rev 8795)
@@ -71,13 +71,13 @@
* So the net effect is that we have forced a {@link RetrieveMarker} into
* the key that tracks this content.</p>
*/
+ private Map<RetrieveMarker, FOLinkage> map
+ = new HashMap<RetrieveMarker, FOLinkage>();
/* TODO: Since the typical case presumably has the marker being used with
* only one retrieve-marker, a HashMap is probably overkill. We should
* probably use parallel arrays of size 1 for this information, and just
* do the array copy if it is needed. Alternatively, use parallel ArrayLists
* with an initial value of 1. */
- private Map<RetrieveMarker, FOLinkage> map
- = new HashMap<RetrieveMarker, FOLinkage>();
public FOLinkageMarker(final FONode foGenerator) throws AreaWException {
super(foGenerator);
Modified: trunk/foray/foray-areatree/src/java/org/foray/area/FOrayAreaTreeFactory.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/FOrayAreaTreeFactory.java 2007-03-13 16:58:48 UTC (rev 8794)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/FOrayAreaTreeFactory.java 2007-03-13 17:18:30 UTC (rev 8795)
@@ -41,7 +41,10 @@
*/
public class FOrayAreaTreeFactory implements AreaTreeFactory {
+ /** The logger. */
private Log logger;
+
+ /** The text server for this factory. */
private TextServer textServer;
public FOrayAreaTreeFactory(final Log logger, final TextServer textServer) {
Modified: trunk/foray/foray-areatree/src/java/org/foray/area/GenericContainer.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/GenericContainer.java 2007-03-13 16:58:48 UTC (rev 8794)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/GenericContainer.java 2007-03-13 17:18:30 UTC (rev 8795)
@@ -37,7 +37,10 @@
public abstract class GenericContainer extends ContainerRA
implements org.axsl.areaW.GenericContainer {
+ /** The x position of this container (content rectangle??). */
private int xPosition = 0;
+
+ /** The y position of this container (content rectangle??).*/
private int yPosition = 0;
public GenericContainer(final FObj generatedBy, final Area parentArea,
Modified: trunk/foray/foray-areatree/src/java/org/foray/area/LineArea.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/LineArea.java 2007-03-13 16:58:48 UTC (rev 8794)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/LineArea.java 2007-03-13 17:18:30 UTC (rev 8795)
@@ -57,7 +57,7 @@
org.axsl.areaR.LineArea,
org.axsl.areaW.LineArea {
- // Whether the line has already had the leader sizes adjusted.
+ /** Indicates whether the line has already had the leader sizes adjusted. */
private boolean optimized = false;
public LineArea(final FObj generatedBy, final NormalBlockArea parentArea,
Modified: trunk/foray/foray-areatree/src/java/org/foray/area/MainRA.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/MainRA.java 2007-03-13 16:58:48 UTC (rev 8794)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/MainRA.java 2007-03-13 17:18:30 UTC (rev 8795)
@@ -51,6 +51,7 @@
private static final int SPAN_SAFETY_FACTOR = (int) Math.round(
2 * 12000 * 1.3);
+ /** Indicates whether this is a new span area. */
private boolean isNewSpanArea;
public MainRA(final RegionBody generatedBy,
Modified: trunk/foray/foray-areatree/src/java/org/foray/area/MarkerContentArea.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/MarkerContentArea.java 2007-03-13 16:58:48 UTC (rev 8794)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/MarkerContentArea.java 2007-03-13 17:18:30 UTC (rev 8795)
@@ -40,6 +40,7 @@
public class MarkerContentArea extends AbstractPlaceholder
implements org.axsl.areaW.MarkerContentArea {
+ /** The marker that generated the descendant content. */
private Marker marker;
public MarkerContentArea(final RetrieveMarker generatedBy,
Modified: trunk/foray/foray-areatree/src/java/org/foray/area/PageCollection.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/PageCollection.java 2007-03-13 16:58:48 UTC (rev 8794)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/PageCollection.java 2007-03-13 17:18:30 UTC (rev 8795)
@@ -65,6 +65,8 @@
private List<Marker> currentPageSequenceMarkers = new ArrayList<Marker>();
+ /** The page-master resolver used to resolve page creation for this page
+ * collection. */
private PageMasterResolver pageMasterResolver;
/**
Modified: trunk/foray/foray-areatree/src/java/org/foray/area/PageRA.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/PageRA.java 2007-03-13 16:58:48 UTC (rev 8794)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/PageRA.java 2007-03-13 17:18:30 UTC (rev 8795)
@@ -60,15 +60,28 @@
public class PageRA extends AreaFixed implements PageArea,
org.axsl.areaW.PageArea {
+ /** The child region-body. */
private RegionRABody body;
+
+ /** The child region-before. */
private RegionRA before;
+
+ /** The child region-after. */
private RegionRA after;
+
+ /** The child region-start. */
private RegionRA start;
+
+ /** The child region-end. */
private RegionRA end;
+ /** The numeric page number for this page. */
private int pageNumber = 0;
+
+ /** The formatted page number for this page. */
private String formattedPageNumber;
+ /** The list of markers found on this page. */
private List<Marker> markers = null;
PageRA(final SimplePageMaster spm, final PageCollection areaTree) {
Modified: trunk/foray/foray-areatree/src/java/org/foray/area/RegionRABody.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/RegionRABody.java 2007-03-13 16:58:48 UTC (rev 8794)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/RegionRABody.java 2007-03-13 17:18:30 UTC (rev 8795)
@@ -45,12 +45,21 @@
public class RegionRABody extends AreaFixed implements RegionBodyArea,
org.axsl.areaW.RegionRABody {
- // the 3 primary reference areas
+ /** The child main reference area. */
private MainRA mainReferenceArea;
+
+ /** The child before-float reference area. */
private BeforeFloatRA beforeFloatReferenceArea;
+
+ /** The child footnote reference area. */
private FootnoteRA footnoteReferenceArea;
+ /** The size, in millipoints, of the block-progression-dimension of the
+ * footnote reference area. */
private int dimensionFootnoteRA;
+
+ /** The size, in millipoints, of the block-progression-dimension of the
+ * before-float reference area. */
private int dimensionBeforeFloatRA;
public RegionRABody(final RegionBody generatedBy, final PageRA parentArea,
Modified: trunk/foray/foray-areatree/src/java/org/foray/area/SpanRA.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/SpanRA.java 2007-03-13 16:58:48 UTC (rev 8794)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/SpanRA.java 2007-03-13 17:18:30 UTC (rev 8795)
@@ -44,9 +44,10 @@
public class SpanRA extends AreaFlexible implements SpanArea,
org.axsl.areaW.SpanRA {
+ /** The currently active column. */
private int currentColumn = 1;
- // has the area been balanced?
+ /** Indicates whether the area has been balanced. */
private boolean isBalanced = false;
public SpanRA(final RegionBody generatedBy, final MainRA parentArea,
Modified: trunk/foray/foray-areatree/src/java/org/foray/area/TableCellRA.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/TableCellRA.java 2007-03-13 16:58:48 UTC (rev 8794)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/TableCellRA.java 2007-03-13 17:18:30 UTC (rev 8795)
@@ -41,13 +41,20 @@
public class TableCellRA extends ContainerRA implements TableCellArea,
org.axsl.areaW.TableCellArea {
- /*
- * Adjustments to padding that are due to centering. (Probably only used
- * by TableCells for the display-align property).
- */
+ /** Adjustment to the top padding due to centering from the "display-align"
+ * property. */
private int centeringPaddingTop = 0;
+
+ /** Adjustment to the bottom padding due to centering from the
+ * "display-align" property. */
private int centeringPaddingBottom = 0;
+
+ /** Adjustment to the left padding due to centering from the "display-align"
+ * property. */
private int centeringPaddingLeft = 0;
+
+ /** Adjustment to the right padding due to centering from the
+ * "display-align" property. */
private int centeringPaddingRight = 0;
public TableCellRA(final TableCell generatedBy,
Modified: trunk/foray/foray-areatree/src/java/org/foray/area/TableRA.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/TableRA.java 2007-03-13 16:58:48 UTC (rev 8794)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/TableRA.java 2007-03-13 17:18:30 UTC (rev 8795)
@@ -46,8 +46,11 @@
public class TableRA extends AbstractNormalBlockArea implements TableArea,
org.axsl.areaW.TableArea {
- private static final int MINCOLWIDTH = 10000; // 10pt
+ /** Constant indicating the minimum column width, in millipoints, that is
+ * 10 points. */
+ private static final int MINCOLWIDTH = 10000;
+ /** The resolved width of the columns in this table. */
private int[] resolvedColumnWidth = null;
public TableRA(final Table generatedBy, final Area parentArea,
Modified: trunk/foray/scripts/checkstyle-suppressions.xml
===================================================================
--- trunk/foray/scripts/checkstyle-suppressions.xml 2007-03-13 16:58:48 UTC (rev 8794)
+++ trunk/foray/scripts/checkstyle-suppressions.xml 2007-03-13 17:18:30 UTC (rev 8795)
@@ -8,7 +8,7 @@
<!-- Suppress partially-implemented checks where not yet implemented. -->
- <suppress checks="Javadoc[MV].*"
+ <suppress checks="Javadoc[M].*"
files="org.foray.area.*"/>
<suppress checks="Javadoc[MV].*"
files="org.foray.fotree.*"/>
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <vic...@us...> - 2007-03-13 19:34:32
|
Revision: 8799
http://svn.sourceforge.net/foray/?rev=8799&view=rev
Author: victormote
Date: 2007-03-13 12:34:32 -0700 (Tue, 13 Mar 2007)
Log Message:
-----------
Conform to axsl changes renaming methods.
Modified Paths:
--------------
trunk/foray/foray-areatree/src/java/org/foray/area/PageCollection.java
trunk/foray/foray-areatree/src/java/org/foray/area/PageRA.java
trunk/foray/foray-areatree/src/java/org/foray/area/RegionRABody.java
trunk/foray/foray-layout/src/java/org/foray/layout/LayoutStrategy.java
trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FootnoteBodyPL.java
trunk/foray/foray-pioneer/src/java/org/foray/pioneer/PioneerLS.java
Modified: trunk/foray/foray-areatree/src/java/org/foray/area/PageCollection.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/PageCollection.java 2007-03-13 19:21:24 UTC (rev 8798)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/PageCollection.java 2007-03-13 19:34:32 UTC (rev 8799)
@@ -372,7 +372,7 @@
PageRA startingPage = null;
/* TODO: Remove cast on following line. */
startingPage = (PageRA) getNextPage(Force.NONE, false);
- final RegionRABody bodyArea = startingPage.getRegionRABody();
+ final RegionRABody bodyArea = startingPage.getRegionBody();
final MainRA mainRA = bodyArea.getMainRA();
final RegionBody body = (RegionBody) mainRA.traitGeneratedBy();
int columnsNeeded = -1;
Modified: trunk/foray/foray-areatree/src/java/org/foray/area/PageRA.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/PageRA.java 2007-03-13 19:21:24 UTC (rev 8798)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/PageRA.java 2007-03-13 19:34:32 UTC (rev 8799)
@@ -29,8 +29,6 @@
package org.foray.area;
import org.axsl.areaR.PageArea;
-import org.axsl.areaR.RegionArea;
-import org.axsl.areaR.RegionBodyArea;
import org.axsl.areaR.RenderVisitor;
import org.axsl.areaW.AreaWException;
import org.axsl.areaW.PageCollection.Force;
@@ -142,62 +140,38 @@
/**
* {@inheritDoc}
*/
- public RegionArea getRegionAfter() {
+ public RegionRA getRegionAfter() {
return this.after;
}
/**
* {@inheritDoc}
*/
- public RegionArea getRegionBefore() {
+ public RegionRA getRegionBefore() {
return this.before;
}
/**
* {@inheritDoc}
*/
- public RegionArea getRegionStart() {
+ public RegionRA getRegionStart() {
return this.start;
}
/**
* {@inheritDoc}
*/
- public RegionArea getRegionEnd() {
+ public RegionRA getRegionEnd() {
return this.end;
}
/**
* {@inheritDoc}
*/
- public RegionBodyArea getRegionBody() {
+ public RegionRABody getRegionBody() {
return this.body;
}
- public RegionRABody getRegionRABody() {
- return this.body;
- }
-
- public org.axsl.areaW.RegionRABody getWritableRegionBody() {
- return this.body;
- }
-
- public org.axsl.areaW.RegionArea getWritableRegionAfter() {
- return this.after;
- }
-
- public org.axsl.areaW.RegionArea getWritableRegionBefore() {
- return this.before;
- }
-
- public org.axsl.areaW.RegionArea getWritableRegionStart() {
- return this.start;
- }
-
- public org.axsl.areaW.RegionArea getWritableRegionEnd() {
- return this.end;
- }
-
public int getHeight() {
return traitGeneratedBy().traitPageHeight();
}
Modified: trunk/foray/foray-areatree/src/java/org/foray/area/RegionRABody.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/RegionRABody.java 2007-03-13 19:21:24 UTC (rev 8798)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/RegionRABody.java 2007-03-13 19:34:32 UTC (rev 8799)
@@ -202,7 +202,7 @@
public Area getOverflowArea(final Area childRequesting)
throws AreaWException {
final PageRA page = (PageRA) getParentArea().getOverflowArea(this);
- return page.getRegionRABody();
+ return page.getRegionBody();
}
public int traitColumnCount() {
Modified: trunk/foray/foray-layout/src/java/org/foray/layout/LayoutStrategy.java
===================================================================
--- trunk/foray/foray-layout/src/java/org/foray/layout/LayoutStrategy.java 2007-03-13 19:21:24 UTC (rev 8798)
+++ trunk/foray/foray-layout/src/java/org/foray/layout/LayoutStrategy.java 2007-03-13 19:34:32 UTC (rev 8799)
@@ -218,19 +218,19 @@
// region-before
layoutStaticContent(pageSeq, simpleMaster.getRegionBefore(),
- pageArea.getWritableRegionBefore());
+ pageArea.getRegionBefore());
// region-after
layoutStaticContent(pageSeq, simpleMaster.getRegionAfter(),
- pageArea.getWritableRegionAfter());
+ pageArea.getRegionAfter());
// region-start
layoutStaticContent(pageSeq, simpleMaster.getRegionStart(),
- pageArea.getWritableRegionStart());
+ pageArea.getRegionStart());
// region-end
layoutStaticContent(pageSeq, simpleMaster.getRegionEnd(),
- pageArea.getWritableRegionEnd());
+ pageArea.getRegionEnd());
}
}
Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FootnoteBodyPL.java
===================================================================
--- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FootnoteBodyPL.java 2007-03-13 19:21:24 UTC (rev 8798)
+++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FootnoteBodyPL.java 2007-03-13 19:34:32 UTC (rev 8799)
@@ -75,7 +75,7 @@
public boolean layoutFootnote(final PageArea p,
final RetrieveMarker retrieveMarker) {
- final RegionRABody bac = p.getWritableRegionBody();
+ final RegionRABody bac = p.getRegionBody();
final FootnoteRA footArea = bac.getWritableFootnoteRA();
try {
layoutFootnoteSeparator(bac, footArea, retrieveMarker);
Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/PioneerLS.java
===================================================================
--- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/PioneerLS.java 2007-03-13 19:21:24 UTC (rev 8798)
+++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/PioneerLS.java 2007-03-13 19:34:32 UTC (rev 8799)
@@ -186,7 +186,7 @@
* Because of markers, lay out the fo:flow first, then the
* static content. This is likely also justifiable because of spec.
*/
- final RegionRABody bodyArea = currentPage.getWritableRegionBody();
+ final RegionRABody bodyArea = currentPage.getRegionBody();
final FlowPL flowPL = (FlowPL) flow.getProxy();
flowPL.layout(bodyArea, null);
this.formatStaticContent(currentPage);
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <vic...@us...> - 2007-03-13 19:39:57
|
Revision: 8800
http://svn.sourceforge.net/foray/?rev=8800&view=rev
Author: victormote
Date: 2007-03-13 12:39:56 -0700 (Tue, 13 Mar 2007)
Log Message:
-----------
Conform to axsl changes renaming methods.
Modified Paths:
--------------
trunk/foray/foray-areatree/src/java/org/foray/area/PageRA.java
trunk/foray/foray-layout/src/java/org/foray/layout/LayoutStrategy.java
trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FootnoteBodyPL.java
Modified: trunk/foray/foray-areatree/src/java/org/foray/area/PageRA.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/PageRA.java 2007-03-13 19:34:32 UTC (rev 8799)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/PageRA.java 2007-03-13 19:39:56 UTC (rev 8800)
@@ -96,10 +96,6 @@
return getAreaTreeParent();
}
- public org.axsl.areaW.PageCollection getWritablePageCollection() {
- return getAreaTreeParent();
- }
-
private PageCollection getAreaTreeParent() {
assert getParent() instanceof PageCollection :
"Parent of Page Area must be a PageCollection";
Modified: trunk/foray/foray-layout/src/java/org/foray/layout/LayoutStrategy.java
===================================================================
--- trunk/foray/foray-layout/src/java/org/foray/layout/LayoutStrategy.java 2007-03-13 19:34:32 UTC (rev 8799)
+++ trunk/foray/foray-layout/src/java/org/foray/layout/LayoutStrategy.java 2007-03-13 19:39:56 UTC (rev 8800)
@@ -212,7 +212,7 @@
*/
public void formatStaticContent(final PageArea pageArea)
throws AreaWException {
- final PageCollection areaTree = pageArea.getWritablePageCollection();
+ final PageCollection areaTree = pageArea.getPageCollection();
final PageSequence pageSeq = areaTree.getPageSequence();
final SimplePageMaster simpleMaster = pageArea.getPageMaster();
Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FootnoteBodyPL.java
===================================================================
--- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FootnoteBodyPL.java 2007-03-13 19:34:32 UTC (rev 8799)
+++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FootnoteBodyPL.java 2007-03-13 19:39:56 UTC (rev 8800)
@@ -99,7 +99,7 @@
return;
}
final PageSequence pageSeq = bac.getPage()
- .getWritablePageCollection().getPageSequence();
+ .getPageCollection().getPageSequence();
final StaticContent separator = pageSeq.getFootnoteSeparator();
if (separator == null) {
return;
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <vic...@us...> - 2007-03-13 21:23:39
|
Revision: 8805
http://svn.sourceforge.net/foray/?rev=8805&view=rev
Author: victormote
Date: 2007-03-13 14:08:01 -0700 (Tue, 13 Mar 2007)
Log Message:
-----------
Conform to axsl changes renaming methods.
Modified Paths:
--------------
trunk/foray/foray-areatree/src/java/org/foray/area/RegionRABody.java
trunk/foray/foray-pioneer/src/java/org/foray/pioneer/AbstractFlowPL.java
trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FootnoteBodyPL.java
Modified: trunk/foray/foray-areatree/src/java/org/foray/area/RegionRABody.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/RegionRABody.java 2007-03-13 20:57:01 UTC (rev 8804)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/RegionRABody.java 2007-03-13 21:08:01 UTC (rev 8805)
@@ -83,28 +83,24 @@
return mainReferenceArea;
}
- public MainRA getMainRA() {
- return mainReferenceArea;
- }
-
/**
* {@inheritDoc}
*/
- public org.axsl.areaW.MainRA getWritableMainRA() {
+ public MainRA getMainRA() {
return mainReferenceArea;
}
/**
* {@inheritDoc}
*/
- public org.axsl.areaW.BeforeFloatRA getWritableBeforeFloatRA() {
+ public org.axsl.areaW.BeforeFloatRA getBeforeFloatRA() {
return this.beforeFloatReferenceArea;
}
/**
* {@inheritDoc}
*/
- public org.axsl.areaW.FootnoteRA getWritableFootnoteRA() {
+ public org.axsl.areaW.FootnoteRA getFootnoteRA() {
return footnoteReferenceArea;
}
Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/AbstractFlowPL.java
===================================================================
--- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/AbstractFlowPL.java 2007-03-13 20:57:01 UTC (rev 8804)
+++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/AbstractFlowPL.java 2007-03-13 21:08:01 UTC (rev 8805)
@@ -109,10 +109,10 @@
for (int i = getProgress(); i < numChildren; i++) {
final FObj fo = (FObj) getFO().getChildren().get(i);
- if (bac.getWritableMainRA().isBalancingRequired(fo)) {
+ if (bac.getMainRA().isBalancingRequired(fo)) {
// reset the the just-done span area in preparation
// for a backtrack for balancing
- bac.getWritableMainRA().resetSpanArea();
+ bac.getMainRA().resetSpanArea();
rollback(getProgressSnapshot());
// one less because of the "continue"
@@ -120,9 +120,9 @@
continue;
}
// current column area
- final Area currentArea = bac.getWritableMainRA()
+ final Area currentArea = bac.getMainRA()
.getNextWritableArea(fo);
- if (bac.getWritableMainRA().isNewSpanArea()) {
+ if (bac.getMainRA().isNewSpanArea()) {
setProgress(i);
setProgressSnapshot(getProgressSnapshot(new
ArrayList<Integer>()));
@@ -144,7 +144,7 @@
// should probably return AREA_FULL_NONE if first
// or perhaps an entirely new status code
}
- if (bac.getWritableMainRA().isLastColumn()) {
+ if (bac.getMainRA().isLastColumn()) {
if (getStatus() == Status.FORCE_COLUMN_BREAK) {
setProgress(i);
// same thing
Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FootnoteBodyPL.java
===================================================================
--- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FootnoteBodyPL.java 2007-03-13 20:57:01 UTC (rev 8804)
+++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FootnoteBodyPL.java 2007-03-13 21:08:01 UTC (rev 8805)
@@ -76,7 +76,7 @@
public boolean layoutFootnote(final PageArea p,
final RetrieveMarker retrieveMarker) {
final RegionRABody bac = p.getRegionBody();
- final FootnoteRA footArea = bac.getWritableFootnoteRA();
+ final FootnoteRA footArea = bac.getFootnoteRA();
try {
layoutFootnoteSeparator(bac, footArea, retrieveMarker);
final int status = layout(footArea, retrieveMarker);
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <vic...@us...> - 2007-03-14 01:11:36
|
Revision: 8821
http://svn.sourceforge.net/foray/?rev=8821&view=rev
Author: victormote
Date: 2007-03-13 18:11:37 -0700 (Tue, 13 Mar 2007)
Log Message:
-----------
Javadoc improvements.
Modified Paths:
--------------
trunk/foray/foray-areatree/src/java/org/foray/area/Area.java
trunk/foray/scripts/checkstyle-suppressions.xml
Modified: trunk/foray/foray-areatree/src/java/org/foray/area/Area.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/Area.java 2007-03-14 00:46:02 UTC (rev 8820)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/Area.java 2007-03-14 01:11:37 UTC (rev 8821)
@@ -1115,37 +1115,57 @@
return traitGeneratedBy().traitIPDimensionMax(this, nearestBaseIPD());
}
+ /**
+ * Returns the page-width trait of this area.
+ * @return The page-width trait of this area.
+ * @see FObj#traitPageWidth()
+ */
public int traitPageWidth() {
return traitGeneratedBy().traitPageWidth();
}
+ /**
+ * Returns the page-height trait of this area.
+ * @return The page-height trait of this area.
+ * @see FObj#traitPageHeight()
+ */
public int traitPageHeight() {
return traitGeneratedBy().traitPageHeight();
}
/**
* Tells which axis (horizontal or vertical) is the block-progression axis.
- * @return Either AXIS_HORIZONTAL or AXIS_VERTICAL, or -1 if writing-mode
- * is invalid.
+ * @return Either {@link AbsoluteAxis#HORIZONTAL} or
+ * {@link AbsoluteAxis#VERTICAL}, or null if writing-mode is invalid.
*/
public AbsoluteAxis getBPAxis() {
return traitGeneratedBy().getBPAxis(this);
}
+ /**
+ * Tells which axis (horizontal or vertical) is the inline-progression axis.
+ * @return Either {@link AbsoluteAxis#HORIZONTAL} or
+ * {@link AbsoluteAxis#VERTICAL}, or null if writing-mode is invalid.
+ */
public AbsoluteAxis getIPAxis() {
return traitGeneratedBy().getIPAxis(this);
}
+ /**
+ * Returns the writing-mode for this area.
+ * @return The writing-mode for this area.
+ * @see FObj#getWritingMode(FOContext)
+ */
public WritingMode getWritingMode() {
return traitGeneratedBy().getWritingMode(this);
}
/**
- * @return Either AXIS_BP or AXIS_IP, depending on whether the contents of
- * this area stack in the block-progression-direction or the
+ * Returns the content stacking axis for this area.
+ * @return Either {@Link RelativeAxis#BLOCK_PROGRESSION} or
+ * {@link RelativeAxis#INLINE_PROGRESSION}, depending on whether the
+ * contents of this area stack in the block-progression-direction or the
* inline-progression-direction.
- */
- /*
* The default value is that contents stack in the BPD. Classes that
* stack in the IPD should override this method.
*/
@@ -1177,18 +1197,34 @@
return getWritingMode().getAbsoluteDirFromRelativeAxis(relative);
}
+ /**
+ * Returns the top margin for this area.
+ * @return The top margin for this area.
+ */
public int getMarginTop() {
return traitGeneratedBy().getMarginTop(this, traitPageWidth());
}
+ /**
+ * Returns the bottom margin for this area.
+ * @return The bottom margin for this area.
+ */
public int getMarginBottom() {
return traitGeneratedBy().getMarginBottom(this, traitPageWidth());
}
+ /**
+ * Returns the left margin for this area.
+ * @return The left margin for this area.
+ */
public int getMarginLeft() {
return traitGeneratedBy().getMarginLeft(this, traitPageWidth());
}
+ /**
+ * Returns the right margin for this area.
+ * @return The right margin for this area.
+ */
public int getMarginRight() {
return traitGeneratedBy().getMarginRight(this, traitPageWidth());
}
@@ -1208,6 +1244,12 @@
*/
public abstract void setProgressionDimension(int progressionDimension);
+ /**
+ * Set the minimum progression dimension for this Area. If the current
+ * progression dimension value is less than this value, it will be
+ * increased to this minimum. Otherwise, it is ignored.
+ * @param minimumPD The minimum progression dimension to set.
+ */
public abstract void setMinimumProgressionDimension(int minimumPD);
/**
@@ -1234,22 +1276,41 @@
* @param childRequesting Child Areas ask
* @return The younger sister Area that should be used to handle the
* overflow condition.
+ * @throws AreaWException If the Area is unable to find or create the
+ * overflow area.
*/
public abstract Area getOverflowArea(Area childRequesting)
throws AreaWException;
+ /**
+ * Returns the half-leading optimum trait for this area.
+ * @return The half-leading optimum trait for this area.
+ * @see FObj#traitHalfLeadingOpt(FOContext)
+ */
public int traitHalfLeadingOpt() {
return traitGeneratedBy().traitHalfLeadingOpt(this);
}
+ /**
+ * Indicates whether this area is a reference area.
+ * @return True iff this area is a reference area.
+ */
public boolean traitIsReferenceArea() {
return traitGeneratedBy().isRAGenerator();
}
+ /**
+ * Returns the reference-orientation trait for this area.
+ * @return The reference-orientation trait for this area.
+ */
public FoValue traitReferenceOrientation() {
return traitGeneratedBy().traitReferenceOrientation(this);
}
+ /**
+ * Returns the cumulative reference orientation for this area.
+ * @return The cumulative reference orientation for this area, in degrees.
+ */
public short referenceOrientationCumulative() {
/* TODO: This needs to be rewritten. There is a mismatch between the
* FoValue items returned and the "degrees" concept that needs to be
@@ -1268,26 +1329,54 @@
// return (short) (cumulative % WKConstants.DEGREES_PER_CIRCLE);
}
+ /**
+ * Returns the extent trait for this area.
+ * @return The extent trait for this area.
+ * @see FObj#traitExtent()
+ */
public int traitExtent() {
return traitGeneratedBy().traitExtent();
}
+ /**
+ * Returns the whitespace-treatment trait for this area.
+ * @return The whitespace-treatment trait for this area.
+ * @see FObj#traitWhiteSpaceTreatment(FOContext)
+ */
public FoValue traitWhiteSpaceTreatment() {
return traitGeneratedBy().traitWhiteSpaceTreatment(this);
}
+ /**
+ * Indicates whether this is the first child of the "generated by".
+ * @return True iff this is the first child of the "generated by".
+ */
public boolean traitIsFirst() {
return this.isFirstChildOfGeneratedBy();
}
+ /**
+ * Indicates whether this is the last child of the "generated by".
+ * @return True iff this is the last child of the "generated by".
+ */
public boolean traitIsLast() {
return this.isLastChildOfGeneratedBy();
}
+ /**
+ * Returns the wrap-option trait for this area.
+ * @return The wrap-option trait for this area.
+ * @see FObj#traitWrapOption(FOContext)
+ */
public FoValue traitWrapOption() {
return traitGeneratedBy().traitWrapOption(this);
}
+ /**
+ * Returns the language trait for this area.
+ * @return The language trait for this area.
+ * @see FObj#traitLanguage(FOContext)
+ */
public String traitLanguage() {
return traitGeneratedBy().traitLanguage(this);
}
@@ -1299,10 +1388,20 @@
return traitGeneratedBy().traitScaling(this);
}
+ /**
+ * Returns the text-align trait for this area.
+ * @return The text-align trait for this area.
+ * @see FObj#traitTextAlign(FOContext)
+ */
public FoValue traitTextAlign() {
return traitGeneratedBy().traitTextAlign(this);
}
+ /**
+ * Returns the alignment-baseline trait for this area.
+ * @return The alignment-baseline trait for this area.
+ * @see FObj#traitAlignmentBaseline(FOContext)
+ */
public FoValue traitAlignmentBaseline() {
return traitGeneratedBy().traitAlignmentBaseline(this);
}
@@ -1314,14 +1413,29 @@
return traitGeneratedBy().traitOverflow(this);
}
+ /**
+ * Returns the ref-id trait for this area.
+ * @return The ref-id trait for this area.
+ * @see FObj#traitRefId(FOContext)
+ */
public String traitRefId() {
return traitGeneratedBy().traitRefId(this);
}
+ /**
+ * Returns the hyphenation-character trait for this area.
+ * @return The hyphenation-character trait for this area.
+ * @see FObj#traitWrapOption(FOContext)
+ */
public int traitHyphenationCharacter() {
return traitGeneratedBy().traitHyphenationCharacter(this);
}
+ /**
+ * Returns the dominant-baseline trait for this area.
+ * @return The dominant-baseline trait for this area.
+ * @see FObj#traitWrapOption(FOContext)
+ */
public Baseline traitDominantBaseline() {
return traitGeneratedBy().traitDominantBaseline(this);
}
@@ -1382,6 +1496,10 @@
return link.getDestination();
}
+ /**
+ * Returns the width of the hyphenation character.
+ * @return The width, in millipoints, of the hyphenation character.
+ */
public int getHyphenWidth() {
final int hyphenChar = traitHyphenationCharacter();
return getCharWidth(hyphenChar);
@@ -1411,6 +1529,10 @@
brBPD() / WKConstants.MILLIPOINTS_PER_POINT);
}
+ /**
+ * Indicates whether the background repeats on the X axis for this area.
+ * @return True iff the background repeats on the X axis for this area.
+ */
public boolean backgroundRepeatX() {
switch (traitBackgroundRepeat()) {
case REPEAT_Y:
@@ -1421,6 +1543,10 @@
return true;
}
+ /**
+ * Indicates whether the background repeats on the Y axis for this area.
+ * @return True iff the background repeats on the Y axis for this area.
+ */
public boolean backgroundRepeatY() {
switch (traitBackgroundRepeat()) {
case REPEAT_X:
@@ -1467,21 +1593,41 @@
retrieveMarker);
}
+ /**
+ * Returns the top trait for this area.
+ * @return The top trait for this area.
+ * @see FObj#traitTop(FOContext, int)
+ */
public int traitTop() {
final Area ancestor = this.ancestorBlockAreaNotALineArea();
return traitGeneratedBy().traitTop(this, ancestor.crBPD());
}
+ /**
+ * Returns the bottom trait for this area.
+ * @return The bottom trait for this area.
+ * @see FObj#traitBottom(FOContext, int)
+ */
public int traitBottom() {
final Area ancestor = this.ancestorBlockAreaNotALineArea();
return traitGeneratedBy().traitBottom(this, ancestor.crBPD());
}
+ /**
+ * Returns the left trait for this area.
+ * @return The left trait for this area.
+ * @see FObj#traitLeft(FOContext, int)
+ */
public int traitLeft() {
final Area ancestor = this.ancestorBlockAreaNotALineArea();
return traitGeneratedBy().traitLeft(this, ancestor.crIPD());
}
+ /**
+ * Returns the right trait for this area.
+ * @return The right trait for this area.
+ * @see FObj#traitRight(FOContext, int)
+ */
public int traitRight() {
final Area ancestor = this.ancestorBlockAreaNotALineArea();
return traitGeneratedBy().traitRight(this, ancestor.crIPD());
@@ -1512,6 +1658,10 @@
return true;
}
+ /**
+ * Indicates whether the parent progression dimension should be adjusted.
+ * @return True iff the parent progression dimension should be adjusted.
+ */
public boolean shouldAdjustParentPD() {
/* If not in the normal flow, the parent's dimensions are not used up
* as this grows. */
Modified: trunk/foray/scripts/checkstyle-suppressions.xml
===================================================================
--- trunk/foray/scripts/checkstyle-suppressions.xml 2007-03-14 00:46:02 UTC (rev 8820)
+++ trunk/foray/scripts/checkstyle-suppressions.xml 2007-03-14 01:11:37 UTC (rev 8821)
@@ -8,8 +8,6 @@
<!-- Suppress partially-implemented checks where not yet implemented. -->
- <suppress checks="Javadoc[M].*"
- files="org.foray.area.*"/>
<suppress checks="Javadoc[MV].*"
files="org.foray.fotree.*"/>
<suppress checks="Javadoc[MV].*"
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <vic...@us...> - 2007-03-14 15:41:31
|
Revision: 8822
http://svn.sourceforge.net/foray/?rev=8822&view=rev
Author: victormote
Date: 2007-03-14 08:41:30 -0700 (Wed, 14 Mar 2007)
Log Message:
-----------
Conform to axsl changes renaming methods.
Modified Paths:
--------------
trunk/foray/foray-areatree/src/java/org/foray/area/PageCollection.java
trunk/foray/foray-layout/src/java/org/foray/layout/LayoutStrategy.java
Modified: trunk/foray/foray-areatree/src/java/org/foray/area/PageCollection.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/PageCollection.java 2007-03-14 01:11:37 UTC (rev 8821)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/PageCollection.java 2007-03-14 15:41:30 UTC (rev 8822)
@@ -368,14 +368,6 @@
/**
* {@inheritDoc}
*/
- public org.axsl.areaW.AreaTree getWritableAreaTree() {
- // Cast validated during construction.
- return (org.axsl.areaW.AreaTree) getParent();
- }
-
- /**
- * {@inheritDoc}
- */
public org.axsl.areaW.SpanRA startingReferenceArea(final FObj lastFObj,
final FObj nextFObj) throws AreaWException {
if (lastFObj != null) {
Modified: trunk/foray/foray-layout/src/java/org/foray/layout/LayoutStrategy.java
===================================================================
--- trunk/foray/foray-layout/src/java/org/foray/layout/LayoutStrategy.java 2007-03-14 01:11:37 UTC (rev 8821)
+++ trunk/foray/foray-layout/src/java/org/foray/layout/LayoutStrategy.java 2007-03-14 15:41:30 UTC (rev 8822)
@@ -80,9 +80,9 @@
public void formatPageSequence(final PageCollection pageCollection)
throws AreaWException {
if (areaTree == null) {
- areaTree = pageCollection.getWritableAreaTree();
+ areaTree = pageCollection.getAreaTree();
} else {
- if (areaTree != pageCollection.getWritableAreaTree()) {
+ if (areaTree != pageCollection.getAreaTree()) {
throw new AreaWException("Cannot reuse a LayoutStrategy "
+ "instance.");
}
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <vic...@us...> - 2007-03-14 15:55:12
|
Revision: 8823
http://svn.sourceforge.net/foray/?rev=8823&view=rev
Author: victormote
Date: 2007-03-14 08:55:05 -0700 (Wed, 14 Mar 2007)
Log Message:
-----------
Conform to axsl changes renaming methods.
Modified Paths:
--------------
trunk/foray/foray-areatree/src/java/org/foray/area/MainRA.java
trunk/foray/foray-pioneer/src/java/org/foray/pioneer/AbstractFlowPL.java
Modified: trunk/foray/foray-areatree/src/java/org/foray/area/MainRA.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/MainRA.java 2007-03-14 15:41:30 UTC (rev 8822)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/MainRA.java 2007-03-14 15:55:05 UTC (rev 8823)
@@ -64,17 +64,12 @@
}
/**
- * Depending on the column-count of the next FO, determine whether
- * a new span area needs to be constructed or not, and return the
- * appropriate ColumnArea.
- * The next cut of this method should also inspect the FO to see
- * whether the area to be returned ought not to be the footnote
- * or before-float reference area.
- * @param fo The next formatting object
- * @return the next column area (possibly the current one)
- * @throws AreaWException For an invalid span value.
+ * {@inheritDoc}
*/
- public NormalFlowRA getNextArea(final FObj fo) throws AreaWException {
+ public NormalFlowRA getNormalFlow(final FObj fo) throws AreaWException {
+ /* The next cut of this method should also inspect the FO to see
+ * whether the area to be returned ought not to be the footnote
+ * or before-float reference area.*/
isNewSpanArea = false;
FoValue span = FoValue.NONE;
@@ -117,14 +112,6 @@
}
/**
- * {@inheritDoc}
- */
- public org.axsl.areaW.NormalFlowRA getNextWritableArea(final FObj fo)
- throws AreaWException {
- return this.getNextArea(fo);
- }
-
- /**
* Add a new span area with specified number of column areas.
* @param numColumns The number of columns in the new span area.
* @return The next normal flow area.
Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/AbstractFlowPL.java
===================================================================
--- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/AbstractFlowPL.java 2007-03-14 15:41:30 UTC (rev 8822)
+++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/AbstractFlowPL.java 2007-03-14 15:55:05 UTC (rev 8823)
@@ -120,8 +120,7 @@
continue;
}
// current column area
- final Area currentArea = bac.getMainRA()
- .getNextWritableArea(fo);
+ final Area currentArea = bac.getMainRA().getNormalFlow(fo);
if (bac.getMainRA().isNewSpanArea()) {
setProgress(i);
setProgressSnapshot(getProgressSnapshot(new
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <vic...@us...> - 2007-03-14 16:47:45
|
Revision: 8825
http://svn.sourceforge.net/foray/?rev=8825&view=rev
Author: victormote
Date: 2007-03-14 09:47:34 -0700 (Wed, 14 Mar 2007)
Log Message:
-----------
Roll GenericContainer into AbstractTableContainer.
Modified Paths:
--------------
trunk/foray/foray-areatree/src/java/org/foray/area/AbstractTableContainer.java
trunk/foray/foray-pioneer/src/java/org/foray/pioneer/AbstractTableBodyPL.java
Removed Paths:
-------------
trunk/foray/foray-areatree/src/java/org/foray/area/GenericContainer.java
Modified: trunk/foray/foray-areatree/src/java/org/foray/area/AbstractTableContainer.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/AbstractTableContainer.java 2007-03-14 16:08:03 UTC (rev 8824)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/AbstractTableContainer.java 2007-03-14 16:47:34 UTC (rev 8825)
@@ -38,10 +38,16 @@
/**
* Abstract superclass for table-body, table-header, and table-footer areas.
*/
-public abstract class AbstractTableContainer extends GenericContainer
+public abstract class AbstractTableContainer extends ContainerRA
implements BackgroundArea,
org.axsl.areaW.AbstractTableContainer {
+ /** The x position of this container (content rectangle??). */
+ private int xPosition = 0;
+
+ /** The y position of this container (content rectangle??).*/
+ private int yPosition = 0;
+
/**
* Constructor.
* @param generatedBy The FO node generating this area.
@@ -69,4 +75,32 @@
return this.traitBackgroundImage();
}
+ /**
+ * {@inheritDoc}
+ */
+ public void setXPosition(final int xPosition) {
+ this.xPosition = xPosition;
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public int getXPosition() {
+ return this.xPosition;
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public void setYPosition(final int yPosition) {
+ this.yPosition = yPosition;
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public int getYPosition() {
+ return this.yPosition;
+ }
+
}
Deleted: trunk/foray/foray-areatree/src/java/org/foray/area/GenericContainer.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/GenericContainer.java 2007-03-14 16:08:03 UTC (rev 8824)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/GenericContainer.java 2007-03-14 16:47:34 UTC (rev 8825)
@@ -1,86 +0,0 @@
-/*
- * Copyright 2004 The FOray Project.
- * http://www.foray.org
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- *
- * This work is in part derived from the following work(s), used with the
- * permission of the licensor:
- * Apache FOP, licensed by the Apache Software Foundation
- *
- */
-
-/*
- * $LastChangedRevision$
- * $LastChangedDate$
- * $LastChangedBy$
- */
-
-package org.foray.area;
-
-import org.axsl.foR.FObj;
-import org.axsl.foR.fo.RetrieveMarker;
-
-/**
- * Abstract superclass for generic container Areas.
- */
-public abstract class GenericContainer extends ContainerRA
- implements org.axsl.areaW.GenericContainer {
-
- /** The x position of this container (content rectangle??). */
- private int xPosition = 0;
-
- /** The y position of this container (content rectangle??).*/
- private int yPosition = 0;
-
- /**
- * Constructor.
- * @param generatedBy The FO node generating this area.
- * @param parentArea The parent area.
- * @param retrieveMarker The ancestor retrieve-marker, if any, for this
- * area.
- */
- public GenericContainer(final FObj generatedBy, final Area parentArea,
- final RetrieveMarker retrieveMarker) {
- super(generatedBy, parentArea, retrieveMarker);
- }
-
- /**
- * {@inheritDoc}
- */
- public void setXPosition(final int xPosition) {
- this.xPosition = xPosition;
- }
-
- /**
- * {@inheritDoc}
- */
- public int getXPosition() {
- return this.xPosition;
- }
-
- /**
- * {@inheritDoc}
- */
- public void setYPosition(final int yPosition) {
- this.yPosition = yPosition;
- }
-
- /**
- * {@inheritDoc}
- */
- public int getYPosition() {
- return this.yPosition;
- }
-
-}
Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/AbstractTableBodyPL.java
===================================================================
--- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/AbstractTableBodyPL.java 2007-03-14 16:08:03 UTC (rev 8824)
+++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/AbstractTableBodyPL.java 2007-03-14 16:47:34 UTC (rev 8825)
@@ -28,11 +28,11 @@
package org.foray.pioneer;
+import org.axsl.areaW.AbstractTableContainer;
import org.axsl.areaW.Area;
import org.axsl.areaW.AreaWException;
import org.axsl.areaW.BlockContainerRA;
import org.axsl.areaW.ContainerRA;
-import org.axsl.areaW.GenericContainer;
import org.axsl.areaW.NormalBlockArea;
import org.axsl.areaW.TableArea;
import org.axsl.common.FoValue;
@@ -68,15 +68,15 @@
}
public void setYPosition(final int value) {
- ((GenericContainer) areaContainerRef.get()).setYPosition(value);
+ ((AbstractTableContainer) areaContainerRef.get()).setYPosition(value);
}
public int getYPosition() {
- return ((GenericContainer) areaContainerRef.get()).getYPosition();
+ return ((AbstractTableContainer) areaContainerRef.get()).getYPosition();
}
public int getHeight(final FOContext context) {
- return ((GenericContainer) areaContainerRef.get()).crBPD()
+ return ((AbstractTableContainer) areaContainerRef.get()).crBPD()
+ getReal().traitSpaceBeforeOptimum(context)
+ getReal().traitSpaceAfterOptimum(context);
}
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <vic...@us...> - 2007-03-14 18:36:24
|
Revision: 8832
http://svn.sourceforge.net/foray/?rev=8832&view=rev
Author: victormote
Date: 2007-03-14 11:36:25 -0700 (Wed, 14 Mar 2007)
Log Message:
-----------
Conform to axsl changes removing some methods allowing external placement of the table header, footer, and body.
Modified Paths:
--------------
trunk/foray/foray-areatree/src/java/org/foray/area/AbstractTableContainer.java
trunk/foray/foray-pioneer/src/java/org/foray/pioneer/AbstractTableBodyPL.java
trunk/foray/foray-pioneer/src/java/org/foray/pioneer/TablePL.java
Modified: trunk/foray/foray-areatree/src/java/org/foray/area/AbstractTableContainer.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/AbstractTableContainer.java 2007-03-14 18:16:26 UTC (rev 8831)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/AbstractTableContainer.java 2007-03-14 18:36:25 UTC (rev 8832)
@@ -42,12 +42,6 @@
implements BackgroundArea,
org.axsl.areaW.AbstractTableContainer {
- /** The x position of this container (content rectangle??). */
- private int xPosition = 0;
-
- /** The y position of this container (content rectangle??).*/
- private int yPosition = 0;
-
/**
* Constructor.
* @param generatedBy The FO node generating this area.
@@ -75,32 +69,4 @@
return this.traitBackgroundImage();
}
- /**
- * {@inheritDoc}
- */
- public void setXPosition(final int xPosition) {
- this.xPosition = xPosition;
- }
-
- /**
- * {@inheritDoc}
- */
- public int getXPosition() {
- return this.xPosition;
- }
-
- /**
- * {@inheritDoc}
- */
- public void setYPosition(final int yPosition) {
- this.yPosition = yPosition;
- }
-
- /**
- * {@inheritDoc}
- */
- public int getYPosition() {
- return this.yPosition;
- }
-
}
Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/AbstractTableBodyPL.java
===================================================================
--- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/AbstractTableBodyPL.java 2007-03-14 18:16:26 UTC (rev 8831)
+++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/AbstractTableBodyPL.java 2007-03-14 18:36:25 UTC (rev 8832)
@@ -67,14 +67,6 @@
super(tableBody, layout);
}
- public void setYPosition(final int value) {
- ((AbstractTableContainer) areaContainerRef.get()).setYPosition(value);
- }
-
- public int getYPosition() {
- return ((AbstractTableContainer) areaContainerRef.get()).getYPosition();
- }
-
public int getHeight(final FOContext context) {
return ((AbstractTableContainer) areaContainerRef.get()).crBPD()
+ getReal().traitSpaceBeforeOptimum(context)
Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/TablePL.java
===================================================================
--- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/TablePL.java 2007-03-14 18:16:26 UTC (rev 8831)
+++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/TablePL.java 2007-03-14 18:36:25 UTC (rev 8832)
@@ -33,7 +33,6 @@
import org.axsl.areaW.NormalBlockArea;
import org.axsl.areaW.TableArea;
import org.axsl.common.FoValue;
-import org.axsl.foR.FOContext;
import org.axsl.foR.FONode;
import org.axsl.foR.fo.Marker;
import org.axsl.foR.fo.RetrieveMarker;
@@ -116,8 +115,6 @@
return Status.OK;
}
} else if (fo instanceof TableBody) {
- final TableBodyPL tableBodyPL =
- (TableBodyPL) getLayoutProxy(fo);
TableHeader th = node.getTableHeader();
final TableHeaderPL tableHeaderPL = (TableHeaderPL)
getLayoutProxy(th);
@@ -182,29 +179,11 @@
if (areaContainer.crBPD() > 0) {
area.incrementProgressionDimension(
areaContainer.crBPD());
- if (node.getTableFooter() != null
- && ! node.traitTableOmitFooterAtBreak(area)) {
- // move footer to bottom of area and move up body
- final int yPosition = getTableFooterYPosition(area,
- tf);
- tableBodyPL.setYPosition(yPosition);
- tableFooterPL.setYPosition(yPosition
- + tableBodyPL.getHeight(area));
- }
status = Status.AREA_FULL_SOME;
}
return status;
}
this.bodyCount++;
- if (node.getTableFooter() != null
- && ! node.traitTableOmitFooterAtBreak(area)) {
- // move footer to bottom of area and move up body
- // space before and after footer will make this wrong
- final int yPosition = getTableFooterYPosition(area, tf);
- tableBodyPL.setYPosition(yPosition);
- tableFooterPL.setYPosition(yPosition
- + tableBodyPL.getHeight(area));
- }
}
}
@@ -255,12 +234,12 @@
return Status.OK;
}
- // FIXME: this seems odd.
- public int getTableFooterYPosition(final FOContext context,
- final TableFooter tFooter) {
- final TableFooterPL tfPL = (TableFooterPL) getLayoutProxy(tFooter);
- return tfPL.getYPosition() - tFooter.traitSpaceBeforeOptimum(context);
- }
+// // FIXME: this seems odd.
+// public int getTableFooterYPosition(final FOContext context,
+// final TableFooter tFooter) {
+// final TableFooterPL tfPL = (TableFooterPL) getLayoutProxy(tFooter);
+// return tfPL.getYPosition() - tFooter.traitSpaceBeforeOptimum(context);
+// }
/**
* {@inheritDoc}
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <vic...@us...> - 2007-03-14 20:16:40
|
Revision: 8833
http://svn.sourceforge.net/foray/?rev=8833&view=rev
Author: victormote
Date: 2007-03-14 13:16:41 -0700 (Wed, 14 Mar 2007)
Log Message:
-----------
1. Conform to axsl removal of SpanRA interface.
2. Change the FOray SpanRA class to extend ContainerRA.
Modified Paths:
--------------
trunk/foray/foray-areatree/src/java/org/foray/area/SpanRA.java
trunk/foray/foray-render/src/java/org/foray/render/Renderer.java
trunk/foray/foray-render/src/java/org/foray/render/xml/XMLRenderer.java
Modified: trunk/foray/foray-areatree/src/java/org/foray/area/SpanRA.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/SpanRA.java 2007-03-14 18:36:25 UTC (rev 8832)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/SpanRA.java 2007-03-14 20:16:41 UTC (rev 8833)
@@ -29,7 +29,6 @@
package org.foray.area;
import org.axsl.areaR.RenderVisitor;
-import org.axsl.areaR.SpanArea;
import org.axsl.areaW.AreaWException;
import org.axsl.common.FoValue;
import org.axsl.foR.FObj;
@@ -41,8 +40,7 @@
* span-reference-area. The best guess is that it is generated by the
* region-body fo.
*/
-public class SpanRA extends AreaFlexible implements SpanArea,
- org.axsl.areaW.SpanRA {
+public class SpanRA extends ContainerRA implements org.axsl.areaW.SpanRA {
/** The currently active column. */
private int currentColumn = 1;
Modified: trunk/foray/foray-render/src/java/org/foray/render/Renderer.java
===================================================================
--- trunk/foray/foray-render/src/java/org/foray/render/Renderer.java 2007-03-14 18:36:25 UTC (rev 8832)
+++ trunk/foray/foray-render/src/java/org/foray/render/Renderer.java 2007-03-14 20:16:41 UTC (rev 8833)
@@ -66,7 +66,6 @@
import org.axsl.areaR.RegionArea;
import org.axsl.areaR.RegionBodyArea;
import org.axsl.areaR.SVGArea;
-import org.axsl.areaR.SpanArea;
import org.axsl.areaR.TableArea;
import org.axsl.areaR.TableCellArea;
import org.axsl.areaR.TextArea;
@@ -426,13 +425,6 @@
/**
* {@inheritDoc}
*/
- public void render(final SpanArea area) {
- renderChildren(area);
- }
-
- /**
- * {@inheritDoc}
- */
public void render(final NormalFlowArea area) {
renderChildren(area);
}
Modified: trunk/foray/foray-render/src/java/org/foray/render/xml/XMLRenderer.java
===================================================================
--- trunk/foray/foray-render/src/java/org/foray/render/xml/XMLRenderer.java 2007-03-14 18:36:25 UTC (rev 8832)
+++ trunk/foray/foray-render/src/java/org/foray/render/xml/XMLRenderer.java 2007-03-14 20:16:41 UTC (rev 8833)
@@ -59,7 +59,6 @@
import org.axsl.areaR.RegionArea;
import org.axsl.areaR.RegionBodyArea;
import org.axsl.areaR.SVGArea;
-import org.axsl.areaR.SpanArea;
import org.axsl.areaR.TableArea;
import org.axsl.areaR.TableCellArea;
import org.axsl.areaR.TextArea;
@@ -314,18 +313,6 @@
/**
* {@inheritDoc}
*/
- public void render(final SpanArea area) {
- final StringBuffer buffer = new StringBuffer();
- outputGeneratedBy(area, buffer);
- writeStartTag(area, buffer);
- outputAllRectangles(area);
- renderChildren(area);
- writeEndTag(area);
- }
-
- /**
- * {@inheritDoc}
- */
public void render(final NormalFlowArea area) {
final StringBuffer buffer = new StringBuffer();
outputGeneratedBy(area, buffer);
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <vic...@us...> - 2007-03-14 20:26:18
|
Revision: 8834
http://svn.sourceforge.net/foray/?rev=8834&view=rev
Author: victormote
Date: 2007-03-14 13:26:18 -0700 (Wed, 14 Mar 2007)
Log Message:
-----------
1. Conform to axsl removal of NormalFlowArea interface.
2. Change the FOray NormalFlowRA class to extend ContainerRA.
Modified Paths:
--------------
trunk/foray/foray-areatree/src/java/org/foray/area/NormalFlowRA.java
trunk/foray/foray-render/src/java/org/foray/render/Renderer.java
trunk/foray/foray-render/src/java/org/foray/render/xml/XMLRenderer.java
Modified: trunk/foray/foray-areatree/src/java/org/foray/area/NormalFlowRA.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/NormalFlowRA.java 2007-03-14 20:16:41 UTC (rev 8833)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/NormalFlowRA.java 2007-03-14 20:26:18 UTC (rev 8834)
@@ -28,7 +28,6 @@
package org.foray.area;
-import org.axsl.areaR.NormalFlowArea;
import org.axsl.areaR.RenderVisitor;
import org.axsl.areaW.AreaWException;
import org.axsl.foR.FObj;
@@ -38,8 +37,8 @@
* @see SpanRA for comments about FOray's philosophy of creating
* span-reference-areas and normal-flow-reference-areas.
*/
-public class NormalFlowRA extends AreaFlexible implements NormalFlowArea,
- org.axsl.areaW.NormalFlowRA {
+public class NormalFlowRA extends ContainerRA
+ implements org.axsl.areaW.NormalFlowRA {
/**
* Constructor.
Modified: trunk/foray/foray-render/src/java/org/foray/render/Renderer.java
===================================================================
--- trunk/foray/foray-render/src/java/org/foray/render/Renderer.java 2007-03-14 20:16:41 UTC (rev 8833)
+++ trunk/foray/foray-render/src/java/org/foray/render/Renderer.java 2007-03-14 20:26:18 UTC (rev 8834)
@@ -58,7 +58,6 @@
import org.axsl.areaR.LineArea;
import org.axsl.areaR.MainReferenceArea;
import org.axsl.areaR.NormalBlockArea;
-import org.axsl.areaR.NormalFlowArea;
import org.axsl.areaR.PageArea;
import org.axsl.areaR.PageCollection;
import org.axsl.areaR.PageNumberArea;
@@ -423,13 +422,6 @@
}
/**
- * {@inheritDoc}
- */
- public void render(final NormalFlowArea area) {
- renderChildren(area);
- }
-
- /**
* Render the children of a given node.
* @param area The area whose children should be rendered.
*/
Modified: trunk/foray/foray-render/src/java/org/foray/render/xml/XMLRenderer.java
===================================================================
--- trunk/foray/foray-render/src/java/org/foray/render/xml/XMLRenderer.java 2007-03-14 20:16:41 UTC (rev 8833)
+++ trunk/foray/foray-render/src/java/org/foray/render/xml/XMLRenderer.java 2007-03-14 20:26:18 UTC (rev 8834)
@@ -53,7 +53,6 @@
import org.axsl.areaR.LineArea;
import org.axsl.areaR.MainReferenceArea;
import org.axsl.areaR.NormalBlockArea;
-import org.axsl.areaR.NormalFlowArea;
import org.axsl.areaR.PageArea;
import org.axsl.areaR.PageNumberCitationArea;
import org.axsl.areaR.RegionArea;
@@ -313,18 +312,6 @@
/**
* {@inheritDoc}
*/
- public void render(final NormalFlowArea area) {
- final StringBuffer buffer = new StringBuffer();
- outputGeneratedBy(area, buffer);
- writeStartTag(area, buffer);
- outputAllRectangles(area);
- renderChildren(area);
- writeEndTag(area);
- }
-
- /**
- * {@inheritDoc}
- */
public void render(final NormalBlockArea area) {
final StringBuffer buffer = new StringBuffer();
outputGeneratedBy(area, buffer);
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <vic...@us...> - 2007-03-15 20:40:28
|
Revision: 8852
http://svn.sourceforge.net/foray/?rev=8852&view=rev
Author: victormote
Date: 2007-03-15 13:40:23 -0700 (Thu, 15 Mar 2007)
Log Message:
-----------
Javadoc improvements.
Modified Paths:
--------------
trunk/foray/foray-pioneer/src/java/org/foray/pioneer/AbstractTableBodyPL.java
trunk/foray/foray-pioneer/src/java/org/foray/pioneer/BlockPL.java
trunk/foray/foray-pioneer/src/java/org/foray/pioneer/RowCellArray.java
trunk/foray/foray-pioneer/src/java/org/foray/pioneer/RowSpanMgr.java
trunk/foray/scripts/checkstyle-suppressions.xml
Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/AbstractTableBodyPL.java
===================================================================
--- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/AbstractTableBodyPL.java 2007-03-15 20:31:56 UTC (rev 8851)
+++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/AbstractTableBodyPL.java 2007-03-15 20:40:23 UTC (rev 8852)
@@ -54,6 +54,7 @@
*/
public abstract class AbstractTableBodyPL extends FObjPL {
+ /** The table container into which content is being placed. */
private AbstractTableContainer tableContainer;
/** The row span manager for this table. */
Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/BlockPL.java
===================================================================
--- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/BlockPL.java 2007-03-15 20:31:56 UTC (rev 8851)
+++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/BlockPL.java 2007-03-15 20:40:23 UTC (rev 8852)
@@ -60,6 +60,8 @@
* before aborting layout. */
private int infLoopThreshhold = DEFAULT_LOOPS_ALLOWED;
+ /** Indicates whether we have already checked for a "break before"
+ * condition. */
private boolean breakStatusBeforeChecked = false;
/** The current line area being processed. */
Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/RowCellArray.java
===================================================================
--- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/RowCellArray.java 2007-03-15 20:31:56 UTC (rev 8851)
+++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/RowCellArray.java 2007-03-15 20:40:23 UTC (rev 8852)
@@ -35,10 +35,18 @@
*/
public class RowCellArray {
+ /** Enumeration of the possible cell states. */
public enum State {
+ /** The cell is in an unknown state. */
UNKNOWN,
+
+ /** The cell is empty. */
EMPTY,
+
+ /** The cell is the start of a span???? */
CELLSTART,
+
+ /** The cell is included in a span???? */
CELLSPAN;
}
Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/RowSpanMgr.java
===================================================================
--- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/RowSpanMgr.java 2007-03-15 20:31:56 UTC (rev 8851)
+++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/RowSpanMgr.java 2007-03-15 20:40:23 UTC (rev 8852)
@@ -40,10 +40,16 @@
* Inner class storing information for one span item.
*/
class SpanInfo {
+ /** The height of the cell. */
private int cellHeight;
+
+ /** The total height of the row. */
private int totalRowHeight;
+
+ /** The number of rows in the span that have not yet been processed. */
private int rowsRemaining;
- // int numCols; // both V and H span
+
+ /** The encapsulated table cell. */
private TableCell cell;
SpanInfo(final TableCell cell, final int cellHeight,
@@ -83,8 +89,10 @@
}
}
- private SpanInfo spanInfo[];
+ /** The array of span info items. */
+ private SpanInfo[] spanInfo;
+ /** Indicates whether keeps should be ignored. */
private boolean ignoreKeeps = false;
public RowSpanMgr(final int numCols) {
Modified: trunk/foray/scripts/checkstyle-suppressions.xml
===================================================================
--- trunk/foray/scripts/checkstyle-suppressions.xml 2007-03-15 20:31:56 UTC (rev 8851)
+++ trunk/foray/scripts/checkstyle-suppressions.xml 2007-03-15 20:40:23 UTC (rev 8852)
@@ -12,7 +12,7 @@
files="org.foray.fotree.*"/>
<suppress checks="Javadoc[MV].*"
files="org.foray.pdf.*"/>
- <suppress checks="Javadoc[MV].*"
+ <suppress checks="Javadoc[M].*"
files="org.foray.pioneer.*"/>
<suppress checks="Javadoc[MV].*"
files="org.foray.render.*"/>
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|