[FOray-commit] SF.net SVN: foray: [7845] trunk/foray/foray-ps/src/java/org/foray/ps
Modular XSL-FO Implementation for Java.
Status: Alpha
Brought to you by:
victormote
Menu
▾
▴
[FOray-commit] SF.net SVN: foray: [7845] trunk/foray/foray-ps/src/java/org/foray/ps
|
From: <vic...@us...> - 2006-08-30 14:37:30
|
Revision: 7845 Author: victormote Date: 2006-08-30 07:36:27 -0700 (Wed, 30 Aug 2006) ViewCVS: http://svn.sourceforge.net/foray/?rev=7845&view=rev Log Message: ----------- Add javadoc. Modified Paths: -------------- trunk/foray/foray-app/src/java/org/foray/app/FOray.java trunk/foray/foray-app/src/java/org/foray/app/ant/FOrayAntTaskStarter.java trunk/foray/foray-app/src/java/org/foray/demo/embed/model/ProjectTeamInputSource.java trunk/foray/foray-mif/src/java/org/foray/mif/MIFDocument.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/BlockContainerPL.java trunk/foray/foray-pioneer/src/java/org/foray/pioneer/BlockPL.java trunk/foray/foray-pioneer/src/java/org/foray/pioneer/ContinuedLabelPL.java trunk/foray/foray-pioneer/src/java/org/foray/pioneer/ExternalGraphicPL.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/FObjMixedPL.java trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FObjPL.java trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FlowPL.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/InstreamForeignObjectPL.java trunk/foray/foray-pioneer/src/java/org/foray/pioneer/LeaderPL.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/MarkerPL.java trunk/foray/foray-pioneer/src/java/org/foray/pioneer/PageNumberCitationPL.java trunk/foray/foray-pioneer/src/java/org/foray/pioneer/PageNumberPL.java trunk/foray/foray-pioneer/src/java/org/foray/pioneer/RetrieveMarkerPL.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/foray-pioneer/src/java/org/foray/pioneer/StaticContentPL.java trunk/foray/foray-pioneer/src/java/org/foray/pioneer/Status.java trunk/foray/foray-pioneer/src/java/org/foray/pioneer/TableBodyPL.java trunk/foray/foray-pioneer/src/java/org/foray/pioneer/TableCellPL.java trunk/foray/foray-pioneer/src/java/org/foray/pioneer/TableFooterPL.java trunk/foray/foray-pioneer/src/java/org/foray/pioneer/TableHeaderPL.java trunk/foray/foray-pioneer/src/java/org/foray/pioneer/TablePL.java trunk/foray/foray-pioneer/src/java/org/foray/pioneer/TableRowPL.java trunk/foray/foray-pretty/src/java/org/foray/pretty/FOrayPretty.java trunk/foray/foray-pretty/src/java/org/foray/pretty/dtd/DTDTokenizer.java trunk/foray/foray-ps/src/java/org/foray/ps/PSColor.java trunk/foray/foray-ps/src/java/org/foray/ps/filter/ASCII85Filter.java trunk/foray/foray-ps/src/java/org/foray/ps/java2d/demo/DemoFrame.java trunk/foray/foray-render/src/java/org/foray/render/awt/AWTPrintRenderer.java trunk/foray/foray-render/src/java/org/foray/render/awt/AWTRenderer.java trunk/foray/foray-render/src/java/org/foray/render/awt/viewer/GoToPageDialog.java trunk/foray/foray-render/src/java/org/foray/render/awt/viewer/IconToolBar.java trunk/foray/foray-render/src/java/org/foray/render/awt/viewer/PreviewDialogAboutBox.java trunk/foray/foray-render/src/java/org/foray/render/awt/viewer/ProgressListener.java trunk/foray/foray-render/src/java/org/foray/render/pcl/PCLStream.java trunk/foray/foray-render/src/java/org/foray/render/ps/PSStream.java trunk/foray/foray-render/src/java/org/foray/render/svg/SVGRenderer.java trunk/foray/foray-render/src/java/org/foray/render/txt/TXTStream.java trunk/foray/foray-text/src/java/org/foray/text/line/LineBreaker.java Modified: trunk/foray/foray-app/src/java/org/foray/app/FOray.java =================================================================== --- trunk/foray/foray-app/src/java/org/foray/app/FOray.java 2006-08-30 01:48:34 UTC (rev 7844) +++ trunk/foray/foray-app/src/java/org/foray/app/FOray.java 2006-08-30 14:36:27 UTC (rev 7845) @@ -32,6 +32,9 @@ import java.io.FileNotFoundException; +/** + * Command-line entry point to the FOray application. + */ public class FOray { public static void main(final String[] args) { CommandLineOptions options = null; Modified: trunk/foray/foray-app/src/java/org/foray/app/ant/FOrayAntTaskStarter.java =================================================================== --- trunk/foray/foray-app/src/java/org/foray/app/ant/FOrayAntTaskStarter.java 2006-08-30 01:48:34 UTC (rev 7844) +++ trunk/foray/foray-app/src/java/org/foray/app/ant/FOrayAntTaskStarter.java 2006-08-30 14:36:27 UTC (rev 7845) @@ -53,6 +53,9 @@ import java.net.MalformedURLException; import java.net.URL; +/** + * Ant Starter implementation for FOray. + */ class FOrayAntTaskStarter extends Starter { /** The parent task for this starter. */ Modified: trunk/foray/foray-app/src/java/org/foray/demo/embed/model/ProjectTeamInputSource.java =================================================================== --- trunk/foray/foray-app/src/java/org/foray/demo/embed/model/ProjectTeamInputSource.java 2006-08-30 01:48:34 UTC (rev 7844) +++ trunk/foray/foray-app/src/java/org/foray/demo/embed/model/ProjectTeamInputSource.java 2006-08-30 14:36:27 UTC (rev 7845) @@ -26,6 +26,9 @@ import org.xml.sax.InputSource; +/** + * An InputSource wrapper of a {@link ProjectTeam} instance. + */ public class ProjectTeamInputSource extends InputSource { private ProjectTeam projectTeam; Modified: trunk/foray/foray-mif/src/java/org/foray/mif/MIFDocument.java =================================================================== --- trunk/foray/foray-mif/src/java/org/foray/mif/MIFDocument.java 2006-08-30 01:48:34 UTC (rev 7844) +++ trunk/foray/foray-mif/src/java/org/foray/mif/MIFDocument.java 2006-08-30 14:36:27 UTC (rev 7845) @@ -101,6 +101,9 @@ return buf.toString(); } + /** + * A MIF ID. + */ class ID { private int idCounter = 1; @@ -111,23 +114,29 @@ } + /** + * A MIF Font Format. + */ class FontFormat { public FontFormat() {} } + /** + * A MIF Paragraph Format. + */ class ParagraphFormat extends FontFormat { public ParagraphFormat() {} int startIndent; int endIndent; - - - } + /** + * A MIF Document. + */ class Document { protected int height; protected int width; @@ -142,16 +151,21 @@ stream.write(buf); } - } + /** + * A MIF PolyLine. + */ class PolyLine { public PolyLine() {} } + /** + * A MIF Import Object. + */ class ImportObject { private String url; @@ -201,6 +215,9 @@ } + /** + * A MIF Frame. + */ class Frame { private int ID; @@ -265,6 +282,9 @@ } + /** + * A MIF Text Rectangle. + */ class TextRect { private int rx, ry, w, h; private int numCols; @@ -325,6 +345,9 @@ } + /** + * A MIF Page. + */ class Page { private String pageType; private String pageBackground; @@ -373,6 +396,9 @@ } } + /** + * A MIF Flow. + */ abstract class Flow { public Flow() {} @@ -381,7 +407,9 @@ public abstract void startPara(); } - + /** + * A MIF Text Flow. + */ class TextFlow extends Flow { ArrayList paras; @@ -427,6 +455,9 @@ } + /** + * A MIF Paragraph. + */ class Para { ArrayList paraLines; @@ -494,6 +525,9 @@ } + /** + * A MIF Paragraph Line. + */ class ParaLine { ArrayList content; int textRectID; @@ -552,6 +586,9 @@ } + /** + * A MIF Paragraph Catalog. + */ class PgfCatalog { ArrayList pgfs; // Paragraph formats @@ -565,18 +602,27 @@ } + /** + * A MIF Color. + */ class Color { public Color() {} } + /** + * A MIF Color Catalog. + */ class ColorCatalog { public ColorCatalog() {} } + /** + * A MIF Ruling. + */ class Ruling { int penWidth; @@ -603,6 +649,9 @@ } + /** + * A MIF Ruling Catalog. + */ class RulingCatalog { // Contains multiple rulings @@ -629,18 +678,30 @@ } + /** + * A MIF Table Format. + */ class TblFormat { public TblFormat() {} } + /** + * A MIF Table Catalog. + */ class TblCatalog { public TblCatalog() {} } + /** + * A MIF Table. + */ class Tbl extends Flow { + /** + * A MIF Table Column. + */ class TblColumn { private int width; public TblColumn(final int width) { @@ -659,8 +720,14 @@ } + /** + * A MIF Table Row. + */ class Row { + /** + * A MIF Table Cell. + */ class Cell { private ArrayList paras; // Paras @@ -814,30 +881,45 @@ } + /** + * A MIF Cross-Reference Format. + */ class XRefFormat { public XRefFormat() {} } + /** + * A MIF Cross-Reference Info. + */ class CrossRefInfo { public CrossRefInfo() {} } + /** + * A MIF Cross-Reference. + */ class XRef { public XRef() {} } + /** + * A MIF Marker. + */ class Marker { public Marker() {} } + /** + * A MIF Book Component. + */ class BookComponent { Document document; @@ -928,6 +1010,9 @@ } + /** + * A MIF Element Set. + */ class ElementSet { public ElementSet() {} Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/AbstractFlowPL.java =================================================================== --- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/AbstractFlowPL.java 2006-08-30 01:48:34 UTC (rev 7844) +++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/AbstractFlowPL.java 2006-08-30 14:36:27 UTC (rev 7845) @@ -25,18 +25,22 @@ package org.foray.pioneer; import org.axsl.areaW.Area; +import org.axsl.areaW.AreaWException; import org.axsl.areaW.NormalFlowRA; import org.axsl.areaW.RegionRABody; import org.axsl.areaW.SpanRA; - -import org.axsl.areaW.AreaWException; import org.axsl.foR.FObj; import org.axsl.foR.fo.AbstractFlow; +import org.axsl.foR.fo.Flow; import org.axsl.foR.fo.Region; import org.axsl.foR.fo.RetrieveMarker; +import org.axsl.foR.fo.StaticContent; import java.util.ArrayList; +/** + * Abstract Pioneer Layout for {@link Flow} and {@link StaticContent}. + */ public abstract class AbstractFlowPL extends FObjPL { private int _status = Status.AREA_FULL_NONE; Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/AbstractTableBodyPL.java =================================================================== --- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/AbstractTableBodyPL.java 2006-08-30 01:48:34 UTC (rev 7844) +++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/AbstractTableBodyPL.java 2006-08-30 14:36:27 UTC (rev 7845) @@ -46,6 +46,9 @@ import java.lang.ref.WeakReference; import java.util.ArrayList; +/** + * Abstract Pioneer Layout for all table body items. + */ public abstract class AbstractTableBodyPL extends FObjPL { // public AreaContainer areaContainer; Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/BlockContainerPL.java =================================================================== --- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/BlockContainerPL.java 2006-08-30 01:48:34 UTC (rev 7844) +++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/BlockContainerPL.java 2006-08-30 14:36:27 UTC (rev 7845) @@ -32,7 +32,7 @@ import org.axsl.foR.fo.RetrieveMarker; /** - * + * Pioneer Layout for {@link BlockContainer}. */ public class BlockContainerPL extends FObjPL { Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/BlockPL.java =================================================================== --- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/BlockPL.java 2006-08-30 01:48:34 UTC (rev 7844) +++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/BlockPL.java 2006-08-30 14:36:27 UTC (rev 7845) @@ -35,7 +35,7 @@ import org.axsl.fontR.FontConsumer; /** - * + * Pioneer Layout for {@link Block}. */ public class BlockPL extends FObjMixedPL { Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/ContinuedLabelPL.java =================================================================== --- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/ContinuedLabelPL.java 2006-08-30 01:48:34 UTC (rev 7844) +++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/ContinuedLabelPL.java 2006-08-30 14:36:27 UTC (rev 7845) @@ -32,7 +32,7 @@ import org.axsl.foR.fo.RetrieveMarker; /** - * + * Pioneer Layout for {@link ContinuedLabel}. */ public class ContinuedLabelPL extends FObjPL { Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/ExternalGraphicPL.java =================================================================== --- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/ExternalGraphicPL.java 2006-08-30 01:48:34 UTC (rev 7844) +++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/ExternalGraphicPL.java 2006-08-30 14:36:27 UTC (rev 7845) @@ -32,7 +32,7 @@ import org.axsl.foR.fo.RetrieveMarker; /** - * + * Pioneer Layout for {@link ExternalGraphic}. */ public class ExternalGraphicPL extends FObjPL { Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FONodePL.java =================================================================== --- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FONodePL.java 2006-08-30 01:48:34 UTC (rev 7844) +++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FONodePL.java 2006-08-30 14:36:27 UTC (rev 7845) @@ -44,7 +44,7 @@ import java.util.ArrayList; /** - * + * Abstract Pioneer Layout superclass for all {@link FONode} instances. */ public abstract class FONodePL implements org.axsl.foR.FONodeProxy { Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FOTextPL.java =================================================================== --- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FOTextPL.java 2006-08-30 01:48:34 UTC (rev 7844) +++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FOTextPL.java 2006-08-30 14:36:27 UTC (rev 7845) @@ -33,7 +33,7 @@ import org.axsl.foR.fo.RetrieveMarker; /** - * + * Pioneer Layout for {@link FOText}. */ public class FOTextPL extends FONodePL { Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FObjMixedPL.java =================================================================== --- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FObjMixedPL.java 2006-08-30 01:48:34 UTC (rev 7844) +++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FObjMixedPL.java 2006-08-30 14:36:27 UTC (rev 7845) @@ -33,7 +33,7 @@ import org.axsl.foR.fo.RetrieveMarker; /** - * + * Pioneer Layout for {@link FObjMixed}. */ public class FObjMixedPL extends FObjPL { Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FObjPL.java =================================================================== --- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FObjPL.java 2006-08-30 01:48:34 UTC (rev 7844) +++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FObjPL.java 2006-08-30 14:36:27 UTC (rev 7845) @@ -34,7 +34,7 @@ import java.util.List; /** - * + * Abstract superclass for Pioneer Layout for all {@link FObj} instances. */ public abstract class FObjPL extends FONodePL { Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FlowPL.java =================================================================== --- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FlowPL.java 2006-08-30 01:48:34 UTC (rev 7844) +++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FlowPL.java 2006-08-30 14:36:27 UTC (rev 7845) @@ -33,6 +33,9 @@ import java.util.List; +/** + * Pioneer Layout for {@link Flow}. + */ public class FlowPL extends AbstractFlowPL { public FlowPL(final Flow flow, final PioneerLS layout) { Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FootnoteBodyPL.java =================================================================== --- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FootnoteBodyPL.java 2006-08-30 01:48:34 UTC (rev 7844) +++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FootnoteBodyPL.java 2006-08-30 14:36:27 UTC (rev 7845) @@ -37,7 +37,7 @@ import org.axsl.foR.fo.StaticContent; /** - * + * Pioneer Layout for {@link FootnoteBody}. */ public class FootnoteBodyPL extends FObjPL { Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FootnotePL.java =================================================================== --- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FootnotePL.java 2006-08-30 01:48:34 UTC (rev 7844) +++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FootnotePL.java 2006-08-30 14:36:27 UTC (rev 7845) @@ -34,7 +34,7 @@ import org.axsl.foR.fo.RetrieveMarker; /** - * + * Pioneer Layout for {@link Footnote}. */ public class FootnotePL extends FObjPL { Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/InstreamForeignObjectPL.java =================================================================== --- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/InstreamForeignObjectPL.java 2006-08-30 01:48:34 UTC (rev 7844) +++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/InstreamForeignObjectPL.java 2006-08-30 14:36:27 UTC (rev 7845) @@ -32,6 +32,9 @@ import org.axsl.foR.fo.InstreamForeignObject; import org.axsl.foR.fo.RetrieveMarker; +/** + * Pioneer Layout for {@link InstreamForeignObject}. + */ public class InstreamForeignObjectPL extends FObjPL { public ForeignObjectArea areaCurrent; Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/LeaderPL.java =================================================================== --- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/LeaderPL.java 2006-08-30 01:48:34 UTC (rev 7844) +++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/LeaderPL.java 2006-08-30 14:36:27 UTC (rev 7845) @@ -32,7 +32,7 @@ import org.axsl.foR.fo.RetrieveMarker; /** - * Concrete class for FObj instances that do not need layout. + * Pioneer Layout for {@link Leader}. */ public class LeaderPL extends FObjPL { Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/ListBlockPL.java =================================================================== --- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/ListBlockPL.java 2006-08-30 01:48:34 UTC (rev 7844) +++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/ListBlockPL.java 2006-08-30 14:36:27 UTC (rev 7845) @@ -33,7 +33,7 @@ import org.axsl.foR.fo.RetrieveMarker; /** - * + * Pioneer Layout for {@link ListBlock}. */ public class ListBlockPL extends FObjPL { Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/ListItemBodyPL.java =================================================================== --- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/ListItemBodyPL.java 2006-08-30 01:48:34 UTC (rev 7844) +++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/ListItemBodyPL.java 2006-08-30 14:36:27 UTC (rev 7845) @@ -32,7 +32,7 @@ import org.axsl.foR.fo.RetrieveMarker; /** - * + * Pioneer Layout for {@link ListItemBody}. */ public class ListItemBodyPL extends FObjPL { Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/ListItemLabelPL.java =================================================================== --- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/ListItemLabelPL.java 2006-08-30 01:48:34 UTC (rev 7844) +++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/ListItemLabelPL.java 2006-08-30 14:36:27 UTC (rev 7845) @@ -32,7 +32,7 @@ import org.axsl.foR.fo.RetrieveMarker; /** - * + * Pioneer Layout for {@link ListItemLabel}. */ public class ListItemLabelPL extends FObjPL { Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/MarkerPL.java =================================================================== --- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/MarkerPL.java 2006-08-30 01:48:34 UTC (rev 7844) +++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/MarkerPL.java 2006-08-30 14:36:27 UTC (rev 7845) @@ -29,6 +29,9 @@ import org.axsl.areaW.Area; +/** + * Pioneer Layout for {@link Marker}. + */ public class MarkerPL extends FObjMixedPL { public MarkerPL(final Marker marker, final PioneerLS layout) { Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/PageNumberCitationPL.java =================================================================== --- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/PageNumberCitationPL.java 2006-08-30 01:48:34 UTC (rev 7844) +++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/PageNumberCitationPL.java 2006-08-30 14:36:27 UTC (rev 7845) @@ -32,7 +32,7 @@ import org.axsl.foR.fo.RetrieveMarker; /** - * + * Pioneer Layout for {@link PageNumberCitation}. */ public class PageNumberCitationPL extends FObjPL { Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/PageNumberPL.java =================================================================== --- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/PageNumberPL.java 2006-08-30 01:48:34 UTC (rev 7844) +++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/PageNumberPL.java 2006-08-30 14:36:27 UTC (rev 7845) @@ -32,7 +32,7 @@ import org.axsl.foR.fo.RetrieveMarker; /** - * + * Pioneer Layout for {@link PageNumber}. */ public class PageNumberPL extends FObjPL { Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/RetrieveMarkerPL.java =================================================================== --- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/RetrieveMarkerPL.java 2006-08-30 01:48:34 UTC (rev 7844) +++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/RetrieveMarkerPL.java 2006-08-30 14:36:27 UTC (rev 7845) @@ -32,7 +32,7 @@ import org.axsl.foR.fo.RetrieveMarker; /** - * + * Pioneer Layout for {@link RetrieveMarker}. */ public class RetrieveMarkerPL extends FObjPL { Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/RowCellArray.java =================================================================== --- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/RowCellArray.java 2006-08-30 01:48:34 UTC (rev 7844) +++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/RowCellArray.java 2006-08-30 14:36:27 UTC (rev 7845) @@ -27,7 +27,7 @@ import org.axsl.foR.fo.TableCell; /** - * + * An array of row cells for Pioneer Layout. */ public class RowCellArray { Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/RowSpanMgr.java =================================================================== --- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/RowSpanMgr.java 2006-08-30 01:48:34 UTC (rev 7844) +++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/RowSpanMgr.java 2006-08-30 14:36:27 UTC (rev 7845) @@ -26,7 +26,15 @@ import org.axsl.foR.fo.TableCell; +/** + * Manages layout of row spans. + */ + public class RowSpanMgr { + + /** + * Inner class storing information for one span item. + */ class SpanInfo { int cellHeight; int totalRowHeight; Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/StaticContentPL.java =================================================================== --- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/StaticContentPL.java 2006-08-30 01:48:34 UTC (rev 7844) +++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/StaticContentPL.java 2006-08-30 14:36:27 UTC (rev 7845) @@ -31,6 +31,9 @@ import org.axsl.foR.fo.RetrieveMarker; import org.axsl.foR.fo.StaticContent; +/** + * Pioneer Layout for {@link StaticContent}. + */ public class StaticContentPL extends AbstractFlowPL { public StaticContentPL(final StaticContent sc, final PioneerLS layout) { Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/Status.java =================================================================== --- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/Status.java 2006-08-30 01:48:34 UTC (rev 7844) +++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/Status.java 2006-08-30 14:36:27 UTC (rev 7845) @@ -27,7 +27,7 @@ import org.axsl.common.Constants; /** - * classes representating the status of laying out a formatting object + * Utility class representating the Pioneer Layout status of an FO. */ public abstract class Status { Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/TableBodyPL.java =================================================================== --- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/TableBodyPL.java 2006-08-30 01:48:34 UTC (rev 7844) +++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/TableBodyPL.java 2006-08-30 14:36:27 UTC (rev 7845) @@ -26,6 +26,9 @@ import org.axsl.foR.fo.TableBody; +/** + * Pioneer Layout for {@link TableBody}. + */ public class TableBodyPL extends AbstractTableBodyPL { public TableBodyPL(final TableBody body, final PioneerLS layout) { Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/TableCellPL.java =================================================================== --- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/TableCellPL.java 2006-08-30 01:48:34 UTC (rev 7844) +++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/TableCellPL.java 2006-08-30 14:36:27 UTC (rev 7845) @@ -34,6 +34,9 @@ import org.axsl.foR.fo.RetrieveMarker; import org.axsl.foR.fo.TableCell; +/** + * Pioneer Layout for {@link TableCell}. + */ public class TableCellPL extends FObjPL { public TableCellArea areaContainer; Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/TableFooterPL.java =================================================================== --- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/TableFooterPL.java 2006-08-30 01:48:34 UTC (rev 7844) +++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/TableFooterPL.java 2006-08-30 14:36:27 UTC (rev 7845) @@ -26,6 +26,9 @@ import org.axsl.foR.fo.TableFooter; +/** + * Pioneer Layout for {@link TableFooter}. + */ public class TableFooterPL extends AbstractTableBodyPL { public TableFooterPL(final TableFooter footer, final PioneerLS layout) { Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/TableHeaderPL.java =================================================================== --- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/TableHeaderPL.java 2006-08-30 01:48:34 UTC (rev 7844) +++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/TableHeaderPL.java 2006-08-30 14:36:27 UTC (rev 7845) @@ -26,6 +26,9 @@ import org.axsl.foR.fo.TableHeader; +/** + * Pioneer Layout for {@link TableHeader}. + */ public class TableHeaderPL extends AbstractTableBodyPL { public TableHeaderPL(final TableHeader header, final PioneerLS layout) { Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/TablePL.java =================================================================== --- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/TablePL.java 2006-08-30 01:48:34 UTC (rev 7844) +++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/TablePL.java 2006-08-30 14:36:27 UTC (rev 7845) @@ -40,7 +40,7 @@ import org.axsl.foR.fo.TableHeader; /** - * + * Pioneer Layout for {@link Table}. */ public class TablePL extends BlockPL { Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/TableRowPL.java =================================================================== --- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/TableRowPL.java 2006-08-30 01:48:34 UTC (rev 7844) +++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/TableRowPL.java 2006-08-30 14:36:27 UTC (rev 7845) @@ -36,6 +36,9 @@ import org.axsl.foR.fo.TableColumn; import org.axsl.foR.fo.TableRow; +/** + * Pioneer Layout for {@link TableRow}. + */ public class TableRowPL extends FObjPL { private RowSpanMgr rowSpanMgr = null; Modified: trunk/foray/foray-pretty/src/java/org/foray/pretty/FOrayPretty.java =================================================================== --- trunk/foray/foray-pretty/src/java/org/foray/pretty/FOrayPretty.java 2006-08-30 01:48:34 UTC (rev 7844) +++ trunk/foray/foray-pretty/src/java/org/foray/pretty/FOrayPretty.java 2006-08-30 14:36:27 UTC (rev 7845) @@ -585,6 +585,9 @@ return this.elementStack.size() - 1; } + /** + * Private inner class for the queue of unprocessed document pieces. + */ private class Queue { /** Collection of Strings that need to be written as soon as we know * enough of what comes after them to choose line breaks. This is needed 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 2006-08-30 01:48:34 UTC (rev 7844) +++ trunk/foray/foray-pretty/src/java/org/foray/pretty/dtd/DTDTokenizer.java 2006-08-30 14:36:27 UTC (rev 7845) @@ -26,6 +26,9 @@ import java.util.ArrayList; +/** + * Utility class for tokenizing a DTD. + */ public class DTDTokenizer { /** Modified: trunk/foray/foray-ps/src/java/org/foray/ps/PSColor.java =================================================================== --- trunk/foray/foray-ps/src/java/org/foray/ps/PSColor.java 2006-08-30 01:48:34 UTC (rev 7844) +++ trunk/foray/foray-ps/src/java/org/foray/ps/PSColor.java 2006-08-30 14:36:27 UTC (rev 7845) @@ -27,6 +27,9 @@ import java.awt.Color; import java.awt.color.ColorSpace; +/** + * Utility class for PostScript color conversions. + */ public class PSColor { /** Modified: trunk/foray/foray-ps/src/java/org/foray/ps/filter/ASCII85Filter.java =================================================================== --- trunk/foray/foray-ps/src/java/org/foray/ps/filter/ASCII85Filter.java 2006-08-30 01:48:34 UTC (rev 7844) +++ trunk/foray/foray-ps/src/java/org/foray/ps/filter/ASCII85Filter.java 2006-08-30 14:36:27 UTC (rev 7845) @@ -26,6 +26,9 @@ import java.io.ByteArrayOutputStream; +/** + * Acts as either an ASCII85Encode Filter or an ASCII85Decode filter. + */ public class ASCII85Filter extends PSFilter { private static final char ASCII85_ZERO = 'z'; private static final char ASCII85_START = '!'; Modified: trunk/foray/foray-ps/src/java/org/foray/ps/java2d/demo/DemoFrame.java =================================================================== --- trunk/foray/foray-ps/src/java/org/foray/ps/java2d/demo/DemoFrame.java 2006-08-30 01:48:34 UTC (rev 7844) +++ trunk/foray/foray-ps/src/java/org/foray/ps/java2d/demo/DemoFrame.java 2006-08-30 14:36:27 UTC (rev 7845) @@ -30,7 +30,7 @@ import java.awt.event.WindowEvent; /** - * @version $Id$ + * An AWT Frame for the demo. */ public class DemoFrame extends Frame { static final long serialVersionUID = 160698642002357180L; @@ -53,6 +53,9 @@ add("Center", bcpanel); } + /** + * Private inner class listening for window events. + */ private class WindowHandler extends WindowAdapter { public void windowClosing(final WindowEvent we) { System.exit(0); 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 2006-08-30 01:48:34 UTC (rev 7844) +++ trunk/foray/foray-render/src/java/org/foray/render/awt/AWTPrintRenderer.java 2006-08-30 14:36:27 UTC (rev 7845) @@ -35,6 +35,9 @@ import java.io.IOException; import java.util.ArrayList; +/** + * A specialized AWT Renderer that prints the document. + */ public class AWTPrintRenderer extends AWTRenderer { private static final int EVEN_AND_ALL = 0; 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 2006-08-30 01:48:34 UTC (rev 7844) +++ trunk/foray/foray-render/src/java/org/foray/render/awt/AWTRenderer.java 2006-08-30 14:36:27 UTC (rev 7845) @@ -93,11 +93,8 @@ * @author <a href="mailto:mar...@in...">Mark Lillywhite</a> */ -/* - * Mark Lillywhite(?) made the following comment: Did lots of - * cleaning up and made the class implement the new Renderer - * interface. This class could also do with a general audit, - * and I suspect it's not swing-thread-safe either. +/** + * A {@link Renderer} that displays the document using AWT. */ public class AWTRenderer extends Renderer implements Printable, Pageable { Modified: trunk/foray/foray-render/src/java/org/foray/render/awt/viewer/GoToPageDialog.java =================================================================== --- trunk/foray/foray-render/src/java/org/foray/render/awt/viewer/GoToPageDialog.java 2006-08-30 01:48:34 UTC (rev 7844) +++ trunk/foray/foray-render/src/java/org/foray/render/awt/viewer/GoToPageDialog.java 2006-08-30 14:36:27 UTC (rev 7845) @@ -47,7 +47,9 @@ * Stanislav Gorkhover: Sta...@jC... */ - +/** + * Dialog box allowing the user to go to a different page. + */ public class GoToPageDialog extends JDialog { static final long serialVersionUID = 663961335818273528L; Modified: trunk/foray/foray-render/src/java/org/foray/render/awt/viewer/IconToolBar.java =================================================================== --- trunk/foray/foray-render/src/java/org/foray/render/awt/viewer/IconToolBar.java 2006-08-30 01:48:34 UTC (rev 7844) +++ trunk/foray/foray-render/src/java/org/foray/render/awt/viewer/IconToolBar.java 2006-08-30 14:36:27 UTC (rev 7845) @@ -39,6 +39,9 @@ import javax.swing.JButton; import javax.swing.JToolBar; +/** + * The icon toolbar for the Viewer. + */ public class IconToolBar extends JToolBar { static final long serialVersionUID = 726305148932931753L; Modified: trunk/foray/foray-render/src/java/org/foray/render/awt/viewer/PreviewDialogAboutBox.java =================================================================== --- trunk/foray/foray-render/src/java/org/foray/render/awt/viewer/PreviewDialogAboutBox.java 2006-08-30 01:48:34 UTC (rev 7844) +++ trunk/foray/foray-render/src/java/org/foray/render/awt/viewer/PreviewDialogAboutBox.java 2006-08-30 14:36:27 UTC (rev 7845) @@ -50,7 +50,9 @@ import javax.swing.border.EmptyBorder; - +/** + * An "About" dialog box for the Viewer. + */ public class PreviewDialogAboutBox extends Dialog implements ActionListener { static final long serialVersionUID = 235027317547788598L; Modified: trunk/foray/foray-render/src/java/org/foray/render/awt/viewer/ProgressListener.java =================================================================== --- trunk/foray/foray-render/src/java/org/foray/render/awt/viewer/ProgressListener.java 2006-08-30 01:48:34 UTC (rev 7844) +++ trunk/foray/foray-render/src/java/org/foray/render/awt/viewer/ProgressListener.java 2006-08-30 14:36:27 UTC (rev 7845) @@ -31,10 +31,11 @@ * Stanislav Gorkhover: Sta...@jC... */ - +/** + * Listener for measuring the progress of rendering the document. + */ public interface ProgressListener { void progress(int percentage); void progress(String message); void progress(int percentage, String message); } - Modified: trunk/foray/foray-render/src/java/org/foray/render/pcl/PCLStream.java =================================================================== --- trunk/foray/foray-render/src/java/org/foray/render/pcl/PCLStream.java 2006-08-30 01:48:34 UTC (rev 7844) +++ trunk/foray/foray-render/src/java/org/foray/render/pcl/PCLStream.java 2006-08-30 14:36:27 UTC (rev 7845) @@ -27,6 +27,9 @@ import java.io.IOException; import java.io.OutputStream; +/** + * Specialized output stream used by {@link PCLRenderer}. + */ public class PCLStream { OutputStream out = null; boolean doOutput = true; Modified: trunk/foray/foray-render/src/java/org/foray/render/ps/PSStream.java =================================================================== --- trunk/foray/foray-render/src/java/org/foray/render/ps/PSStream.java 2006-08-30 01:48:34 UTC (rev 7844) +++ trunk/foray/foray-render/src/java/org/foray/render/ps/PSStream.java 2006-08-30 14:36:27 UTC (rev 7845) @@ -28,6 +28,9 @@ import java.io.IOException; import java.io.OutputStream; +/** + * Specialized output stream used by {@link PSRenderer}. + */ public class PSStream extends FilterOutputStream { public PSStream(final OutputStream out) { Modified: trunk/foray/foray-render/src/java/org/foray/render/svg/SVGRenderer.java =================================================================== --- trunk/foray/foray-render/src/java/org/foray/render/svg/SVGRenderer.java 2006-08-30 01:48:34 UTC (rev 7844) +++ trunk/foray/foray-render/src/java/org/foray/render/svg/SVGRenderer.java 2006-08-30 14:36:27 UTC (rev 7845) @@ -68,6 +68,9 @@ import java.util.HashMap; import java.util.Map; +/** + * A {@link Renderer} implementation that writes the document as SVG. + */ public class SVGRenderer extends Renderer { static final String svgNS = SVGDOMImplementation.SVG_NAMESPACE_URI; Document svgDocument; Modified: trunk/foray/foray-render/src/java/org/foray/render/txt/TXTStream.java =================================================================== --- trunk/foray/foray-render/src/java/org/foray/render/txt/TXTStream.java 2006-08-30 01:48:34 UTC (rev 7844) +++ trunk/foray/foray-render/src/java/org/foray/render/txt/TXTStream.java 2006-08-30 14:36:27 UTC (rev 7845) @@ -27,6 +27,9 @@ import java.io.IOException; import java.io.OutputStream; +/** + * {@link OutputStream} wrapper used by {@link TXTRenderer}. + */ public class TXTStream { OutputStream out = null; boolean doOutput = true; Modified: trunk/foray/foray-text/src/java/org/foray/text/line/LineBreaker.java =================================================================== --- trunk/foray/foray-text/src/java/org/foray/text/line/LineBreaker.java 2006-08-30 01:48:34 UTC (rev 7844) +++ trunk/foray/foray-text/src/java/org/foray/text/line/LineBreaker.java 2006-08-30 14:36:27 UTC (rev 7845) @@ -40,6 +40,9 @@ import java.util.ArrayList; +/** + * Abstract superclass for all line breakers. + */ public abstract class LineBreaker implements org.axsl.text.line.LineBreaker { /** The "parent" TextServer. */ This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
