[FOray-commit] SF.net SVN: foray: [8764] trunk/foray
Modular XSL-FO Implementation for Java.
Status: Alpha
Brought to you by:
victormote
Menu
▾
▴
[FOray-commit] SF.net SVN: foray: [8764] trunk/foray
|
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 StringBuffer();
Modified: trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFGoToRemote.java
===================================================================
--- trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFGoToRemote.java 2007-02-26 15:05:51 UTC (rev 8763)
+++ trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFGoToRemote.java 2007-02-26 16:09:30 UTC (rev 8764)
@@ -33,9 +33,7 @@
*/
public class PDFGoToRemote extends PDFAction {
- /**
- * the file specification
- */
+ /** The file specification. */
private PDFFileSpec pdfFileSpec;
private int pageReference = 0;
private String destination = null;
@@ -89,8 +87,7 @@
}
/**
- * return the action string which will reference this object
- *
+ * Return the action string which will reference this object.
* @return the action String
*/
public String getAction() {
@@ -98,9 +95,7 @@
}
/**
- * represent the object in PDF
- *
- * @return the PDF string
+ * {@inheritDoc}
*/
public String toPDF() {
String p = new String(this.pdfID() + EOL
Modified: trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFInfo.java
===================================================================
--- trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFInfo.java 2007-02-26 15:05:51 UTC (rev 8763)
+++ trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFInfo.java 2007-02-26 16:09:30 UTC (rev 8764)
@@ -118,9 +118,7 @@
}
/**
- * produce the PDF representation of the object
- *
- * @return the PDF
+ * {@inheritDoc}
*/
public String toPDF() {
if (this.isEmpty()) {
Modified: trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFLink.java
===================================================================
--- trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFLink.java 2007-02-26 15:05:51 UTC (rev 8763)
+++ trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFLink.java 2007-02-26 16:09:30 UTC (rev 8764)
@@ -49,7 +49,7 @@
private PDFColor color = null;
/**
- * Create a PDFLink object
+ * Create a PDFLink object.
* @param doc {@inheritDoc}
* @param rect The rectangle which outlines the link. All dimension in the
* rectangle should be expressed in 1/1000ths of a user space unit.
@@ -78,12 +78,15 @@
}
/**
+ * Returns the color for this link.
* @return Returns the color.
*/
public PDFColor getColor() {
return color;
}
+
/**
+ * Sets the color for this link.
* @param color The color to set.
*/
public void setColor(final PDFColor color) {
@@ -91,9 +94,7 @@
}
/**
- * produce the PDF representation of 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/PDFObject.java
===================================================================
--- trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFObject.java 2007-02-26 15:05:51 UTC (rev 8763)
+++ trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFObject.java 2007-02-26 16:09:30 UTC (rev 8764)
@@ -67,19 +67,13 @@
/** The String that should be used to end a line in log messages. */
public static final String MSG_EOL = System.getProperty("line.separator");
- /**
- * The parent PDFDocument.
- */
+ /** The parent PDFDocument. */
private PDFDocument document;
- /**
- * the object's number
- */
+ /** The object's number. */
private int number = -1;
- /**
- * the object's generation (0 in new documents)
- */
+ /** The object's generation (0 in new documents). */
private int generation = 0;
/**
@@ -102,22 +96,23 @@
}
/**
- * @return The PDF Object number
+ * Returns this object's number.
+ * @return The PDF Object number.
*/
public int getNumber() {
return this.number;
}
/**
- * @return The PDF Object number
+ * Returns this object's generation number.
+ * @return The PDF generation number.
*/
public int getGeneration() {
return this.generation;
}
/**
- * write the PDF represention of this object
- *
+ * Write the PDF represention of this object to a given output stream.
* @param stream the stream to write the PDF to
* @return the number of bytes written
*/
Modified: trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFOutline.java
===================================================================
--- trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFOutline.java 2007-02-26 15:05:51 UTC (rev 8763)
+++ trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFOutline.java 2007-02-26 16:09:30 UTC (rev 8764)
@@ -35,6 +35,7 @@
public class PDFOutline extends PDFOutlineParent {
/**
+ * Constructor.
* @param doc {@inheritDoc}
*/
public PDFOutline(final PDFDocument doc) {
@@ -47,7 +48,7 @@
}
/**
- * represent the object in PDF
+ * {@inheritDoc}
*/
protected String toPDF() {
final StringBuffer result = new StringBuffer();
Modified: trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFOutlineItem.java
===================================================================
--- trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFOutlineItem.java 2007-02-26 15:05:51 UTC (rev 8763)
+++ trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFOutlineItem.java 2007-02-26 16:09:30 UTC (rev 8764)
@@ -60,7 +60,7 @@
*/
private boolean bold = false;
- /** */
+ /** The color for this outline item. */
private PDFColor color = null;
/**
@@ -208,7 +208,7 @@
}
/**
- * represent the object in PDF
+ * {@inheritDoc}
*/
protected String toPDF() {
final StringBuffer result = new StringBuffer();
Modified: trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFOutlineParent.java
===================================================================
--- trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFOutlineParent.java 2007-02-26 15:05:51 UTC (rev 8763)
+++ trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFOutlineParent.java 2007-02-26 16:09:30 UTC (rev 8764)
@@ -44,6 +44,7 @@
private List<PDFOutlineItem> children = new ArrayList<PDFOutlineItem>();
/**
+ * Constructor.
* @param doc {@inheritDoc}
*/
public PDFOutlineParent(final PDFDocument doc) {
Modified: trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFPage.java
===================================================================
--- trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFPage.java 2007-02-26 15:05:51 UTC (rev 8763)
+++ trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFPage.java 2007-02-26 16:09:30 UTC (rev 8764)
@@ -47,29 +47,19 @@
private static final String PDF_FILE_EXTENSION = ".pdf";
- /**
- * the page's parent, a PDF reference object
- */
+ /** The page's parent, a PDF reference object. */
private String parent;
- /**
- * the page's /Resource object
- */
+ /** The page's /Resource object. */
private PDFResources resources;
- /**
- * the contents stream
- */
+ /** The page's content stream. */
private PDFContentStream contents;
- /**
- * the width of the page in points
- */
+ /** The width of the page in points. */
private int pagewidth;
- /**
- * the height of the page in points
- */
+ /** The height of the page in points. */
private int pageheight;
/** The list of annotation objects for this page. */
@@ -78,8 +68,7 @@
private PDFAnnotList annotList = null;
/**
- * create a /Page object
- *
+ * Create a /Page object.
* @param doc {@inheritDoc}
* @param resources the /Resources object
* @param pagewidth the page's width in points
@@ -103,8 +92,7 @@
}
/**
- * set this page's parent
- *
+ * Set this page's parent.
* @param parent the /Pages object that is this page's parent
*/
public void setParent(final PDFPages parent) {
@@ -112,8 +100,7 @@
}
/**
- * get this page's annotation list
- *
+ * Get this page's annotation list.
* @return annotList a PDFAnnotList list of annotations
*/
private PDFAnnotList getAnnotList() {
@@ -128,9 +115,7 @@
}
/**
- * represent this object as PDF
- *
- * @return the PDF string
+ * {@inheritDoc}
*/
public String toPDF() {
final StringBuffer sb = new StringBuffer();
Modified: trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFPages.java
===================================================================
--- trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFPages.java 2007-02-26 15:05:51 UTC (rev 8763)
+++ trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFPages.java 2007-02-26 16:09:30 UTC (rev 8764)
@@ -40,22 +40,16 @@
*/
public class PDFPages extends PDFObject {
- /**
- * the /Page objects
- */
+ /** The /Page objects. */
private List<String> kids = new ArrayList<String>();
/* TODO: This is a list of Strings. Shouldn't it be a list of PDFPage
* instances? */
- /**
- * the number of /Page objects
- */
+ /** The number of /Page objects. */
private int count = 0;
- // private PDFPages parent;
-
/**
- * create a /Pages object. NOTE: The PDFPages
+ * Create a /Pages object. NOTE: The PDFPages
* object must be created before the PDF document is
* generated, but it is not written to the stream immediately.
* It must aslo be allocated an object ID (so that the kids
@@ -80,8 +74,7 @@
}
/**
- * get the count of /Page objects
- *
+ * Get the count of /Page objects.
* @return the number of pages
*/
public int getCount() {
@@ -89,7 +82,7 @@
}
/**
- * increment the count of /Page objects
+ * Increment the count of /Page objects.
*/
public void incrementCount() {
this.count++;
@@ -97,9 +90,7 @@
}
/**
- * represent the object in PDF
- *
- * @return the PDF string
+ * {@inheritDoc}
*/
public String toPDF() {
StringBuffer p = new StringBuffer();
Modified: trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFPattern.java
===================================================================
--- trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFPattern.java 2007-02-26 15:05:51 UTC (rev 8763)
+++ trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFPattern.java 2007-02-26 16:09:30 UTC (rev 8764)
@@ -50,76 +50,51 @@
private static final int QTY_RADIAL_SHADING_COMPONENTS = 6;
- /**
- * The resources associated with this pattern
- */
- // Guts common to all function types
-
+ /** The resources associated with this pattern. */
private PDFResources resources = null;
- /**
- * Either one (1) for tiling, or two (2) for shading.
- */
- private int patternType = 2; // Default
+ /** Either one (1) for tiling, or two (2) for shading. (2) is the
+ * default. */
+ private int patternType = 2;
- /**
- * The number of the pattern.
- */
+ /** The number of the pattern. */
private int patternCount;
- /**
- * 1 for colored pattern, 2 for uncolored
- */
+ /** 1 for colored pattern, 2 for uncolored. */
private int paintType = 2;
- /**
- * 1 for constant spacing, 2 for no distortion, and 3 for fast rendering
- */
+ /** 1 for constant spacing, 2 for no distortion, and 3 for fast
+ * rendering. */
private int tilingType = 1;
- /**
- * List of Doubles representing the Bounding box rectangle
- */
+ /** List of Doubles representing the Bounding box rectangle. */
private List bBox = null;
- /**
- * Horizontal spacing
- */
+ /** Horizontal spacing. */
private double xStep = -1;
- /**
- * Vertical spacing
- */
+ /** Vertical spacing. */
private double yStep = -1;
- /**
- * The Shading object comprising the Type 2 pattern
- */
+ /** The Shading object comprising the Type 2 pattern. */
private PDFShading shading = null;
- /**
- * List of Integers represetning the Extended unique Identifier
- */
+ /** List of Integers represetning the Extended unique Identifier. */
private List xUID = null;
/**
* String representing the extended Graphics state.
* Probably will never be used like this.
*/
- private StringBuffer extGState =
- null; // eventually, need a PDFExtGSState object... but not now.
+ private StringBuffer extGState = null;
+ /* TODO: Add a PDFExtGSState. */
- /**
- * List of Doubles representing the Transformation matrix.
- */
+ /** List of Doubles representing the Transformation matrix. */
private List matrix = null;
- /**
- * The stream of a pattern
- */
+ /** The stream of a pattern. */
private StringBuffer patternDataStream = null;
-
/**
* Create a tiling pattern (type 1).
*
@@ -160,8 +135,7 @@
}
/**
- * Create a type 2 pattern (smooth shading)
- *
+ * Create a type 2 pattern (smooth shading).
* @param doc {@inheritDoc}
* @param thePatternType the type of the pattern, which is 2, smooth shading
* @param theShading the PDF Shading object that comprises this pattern
@@ -187,8 +161,7 @@
}
/**
- * Get the name of the pattern
- *
+ * Get the name of the pattern.
* @return String representing the name of the pattern.
*/
public String getName() {
Modified: trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFRectangle.java
===================================================================
--- trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFRectangle.java 2007-02-26 15:05:51 UTC (rev 8763)
+++ trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFRectangle.java 2007-02-26 16:09:30 UTC (rev 8764)
@@ -37,33 +37,24 @@
*/
public class PDFRectangle {
- /**
- * lower left x coordinate
- */
+ /** Lower left x coordinate. */
private int llx;
- /**
- * lower left y coordinate
- */
+ /** Lower left y coordinate. */
private int lly;
- /**
- * upper right x coordinate
- */
+ /** Upper right x coordinate. */
private int urx;
- /**
- * upper right y coordinate
- */
+ /** Upper right y coordinate. */
private int ury;
/**
- * create a rectangle giving the four separate values
- *
- * @param llx lower left x coordinate
- * @param lly lower left y coordinate
- * @param urx upper right x coordinate
- * @param ury upper right y coordinate
+ * Create a rectangle from its coordinates.
+ * @param llx Lower left x coordinate.
+ * @param lly Lower left y coordinate.
+ * @param urx Upper right x coordinate.
+ * @param ury Upper right y coordinate.
*/
public PDFRectangle(final int llx, final int lly, final int urx,
final int ury) {
@@ -89,8 +80,7 @@
}
/**
- * produce the PDF representation for the object
- *
+ * Produce the PDF representation for the object.
* @return the PDF
*/
public byte[] toPDF() {
Modified: trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFResources.java
===================================================================
--- trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFResources.java 2007-02-26 15:05:51 UTC (rev 8763)
+++ trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFResources.java 2007-02-26 16:09:30 UTC (rev 8764)
@@ -75,9 +75,7 @@
}
/**
- * represent the object in PDF
- *
- * @return the PDF
+ * {@inheritDoc}
*/
public String toPDF() {
final StringBuffer p = new StringBuffer();
Modified: trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFRoot.java
===================================================================
--- trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFRoot.java 2007-02-26 15:05:51 UTC (rev 8763)
+++ trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFRoot.java 2007-02-26 16:09:30 UTC (rev 8764)
@@ -29,23 +29,17 @@
package org.foray.pdf.object;
/**
- * class representing a Root (/Catalog) object
+ * The Root (/Catalog) object.
*/
public class PDFRoot extends PDFObject {
- /**
- * the /Pages object that is root of the Pages hierarchy
- */
+ /** The /Pages object that is root of the Pages hierarchy. */
private PDFPages rootPages;
- /**
- * Root outline object
- */
+ /** The root outline object. */
private PDFOutline outline;
- /**
- * Collection of destinations
- */
+ /** Collection of destinations. */
private PDFNameTree destinations;
/**
@@ -60,8 +54,7 @@
}
/**
- * add a /Page object to the root /Pages object
- *
+ * Add a /Page object to the root /Pages object.
* @param page the /Page object to add
*/
public void addPage(final PDFPage page) {
Modified: trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFShading.java
===================================================================
--- trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFShading.java 2007-02-26 15:05:51 UTC (rev 8763)
+++ trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFShading.java 2007-02-26 16:09:30 UTC (rev 8764)
@@ -105,9 +105,7 @@
*/
private List background = null;
- /**
- * Optional: A List specifying the clipping rectangle
- */
+ /** Optional list specifying the clipping rectangle. */
private List bBox = null;
/**
@@ -127,9 +125,7 @@
private List domain = null;
- /**
- * Optional for Type 1: A transformation matrix
- */
+ /** A transformation matrix, optional for Type 1. */
private List matrix = null;
/**
@@ -192,7 +188,7 @@
private int verticesPerRow = 0;
/**
- * Constructor for type function based shading
+ * Constructor for type function based shading.
*
* @param doc The parent PDF document.
* @param theShadingType The type of shading object, which should be 1 for
@@ -232,7 +228,7 @@
}
/**
- * Constructor for Type 2 and 3
+ * Constructor for Type 2 and 3.
*
* @param doc The parent PDF document.
* @param theShadingType 2 or 3 for axial or radial shading
@@ -272,7 +268,7 @@
}
/**
- * Constructor for Type 4,6, or 7
+ * Constructor for Type 4,6, or 7.
*
* @param doc The parent PDF document.
* @param theShadingType 4, 6, or 7 depending on whether it's
@@ -314,7 +310,7 @@
}
/**
- * Constructor for type 5
+ * Constructor for type 5.
*
* @param theShadingType 5 for lattice-Form Gouraud shaded-triangle mesh
* @param theColorSpace "DeviceRGB" or similar.
Modified: trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFStream.java
===================================================================
--- trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFStream.java 2007-02-26 15:05:51 UTC (rev 8763)
+++ trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFStream.java 2007-02-26 16:09:30 UTC (rev 8764)
@@ -51,14 +51,10 @@
*/
public class PDFStream extends PDFObject {
- /**
- * the stream of PDF commands
- */
+ /** The stream of PDF commands. */
private ByteArrayOutputStream streamData;
- /**
- * the filters that should be applied
- */
+ /** The filters that should be applied to this stream. */
private List<PSFilter> filters;
/**
@@ -88,9 +84,8 @@
}
/**
- * append data to the stream
- *
- * @param s the string of PDF to add
+ * Append data to the stream.
+ * @param s The string of PDF to add.
*/
public void add(final String s) {
try {
@@ -200,7 +195,7 @@
}
/**
- * Output just the stream data enclosed by stream/endstream markers
+ * Output just the stream data enclosed by stream/endstream markers.
*/
protected int outputStreamData(final OutputStream stream)
throws IOException {
Modified: trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFString.java
===================================================================
--- trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFString.java 2007-02-26 15:05:51 UTC (rev 8763)
+++ trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFString.java 2007-02-26 16:09:30 UTC (rev 8764)
@@ -44,9 +44,11 @@
public class PDFString extends PDFObject {
private static final int UNICODE_STRING_SIZE = 4;
+
/** The encapsulated String. */
private String theString;
- /** The Font that should be used to render this String */
+
+ /** The Font that should be used to render this String. */
private PDFFont font;
public PDFString(final PDFDocument doc, final String string,
@@ -80,8 +82,9 @@
}
/**
- * @param buffer
- * @param glyphIndex
+ * Add a character to the buffer.
+ * @param buffer The buffer to which the character should be added.
+ * @param glyphIndex The glyph index to be added.
*/
private void addCharToBuffer(final StringBuffer buffer,
final int glyphIndex) {
@@ -152,10 +155,9 @@
}
/**
- * Convert a char to a multibyte hex representation
- *
- * @param c character to be converted
- * @return the string representation of the character
+ * Convert a char to a multibyte hex representation.
+ * @param c The character to be converted.
+ * @return The string representation of the character.
*/
public static String getUnicodeString(final int c) {
StringBuffer buf = new StringBuffer(UNICODE_STRING_SIZE);
Modified: trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFUri.java
===================================================================
--- trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFUri.java 2007-02-26 15:05:51 UTC (rev 8763)
+++ trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFUri.java 2007-02-26 16:09:30 UTC (rev 8764)
@@ -29,7 +29,7 @@
package org.foray.pdf.object;
/**
- * class used to create a PDF Uri link
+ * A PDF Uri link.
*/
public class PDFUri extends PDFAction {
@@ -47,8 +47,7 @@
}
/**
- * returns the action ncecessary for a uri
- *
+ * Returns the action necessary for a uri.
* @return the action to place next to /A within a Link
*/
public String getAction() {
Modified: trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFWArray.java
===================================================================
--- trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFWArray.java 2007-02-26 15:05:51 UTC (rev 8763)
+++ trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFWArray.java 2007-02-26 16:09:30 UTC (rev 8764)
@@ -32,13 +32,11 @@
import java.util.ArrayList;
/**
- * class representing a <b>W</b> array for CID fonts.
+ * A <b>W</b> array for CID fonts.
*/
public class PDFWArray {
- /**
- * the metrics
- */
+ /** The array elements. */
private ArrayList entries;
public PDFWArray() {
@@ -117,7 +115,7 @@
}
/**
- * inner class for entries in the form "c [w ...]"
+ * Inner class for entries in the form "c [w ...]".
*/
private static class Entry {
private int start;
Modified: trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFXForm.java
===================================================================
--- trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFXForm.java 2007-02-26 15:05:51 UTC (rev 8763)
+++ trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFXForm.java 2007-02-26 16:09:30 UTC (rev 8764)
@@ -46,8 +46,9 @@
public class PDFXForm extends PDFXObject {
/**
- * @param doc
- * @param img
+ * Constructor.
+ * @param doc The parent document.
+ * @param img The form to encapsulate.
*/
public PDFXForm(final PDFDocument doc, final Graphic img,
final Rectangle2D.Float contentRectangle,
Modified: trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFXObject.java
===================================================================
--- trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFXObject.java 2007-02-26 15:05:51 UTC (rev 8763)
+++ trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFXObject.java 2007-02-26 16:09:30 UTC (rev 8764)
@@ -136,6 +136,7 @@
}
/**
+ * Returns the XObject name for this object.
* @return The name by which this XObject is recorded in the XObject
* subdictionary.
*/
@@ -144,7 +145,8 @@
}
/**
- * @return The subtype for the XObject.
+ * Returns the subtype for this XObject.
+ * @return The subtype for this XObject.
*/
protected abstract String xObjectSubtype();
@@ -155,6 +157,7 @@
throws GraphicException, IOException;
/**
+ * Returns the dictionary entries for this XObject.
* @return The dictonary entries specific to this type of XObject.
*/
protected abstract String xObjectDictionary();
@@ -217,9 +220,10 @@
}
/**
- * @param stream
+ * Writes this object to an output stream.
+ * @param stream The stream to which this object should be written.
* @return The number of bytes written ??
- * @throws IOException
+ * @throws IOException For I/O errors during output.
*/
protected int output(final OutputStream stream) throws IOException {
int length = 0;
@@ -264,7 +268,8 @@
}
/**
- * @param stream
+ * Write this object to an output stream.
+ * @param stream the stream to which this object should be written.
* @return The number of bytes written ??
* @throws IOException
*/
@@ -281,28 +286,32 @@
}
/**
- * @return Returns the graphic.
+ * Return the encapsulated graphic.
+ * @return The graphic.
*/
public Graphic getGraphic() {
return this.graphic;
}
/**
- * @return Returns the pdfStream.
+ * Returns the pdf stream.
+ * @return The pdfStream.
*/
public PDFStream getPdfStream() {
return this.pdfStream;
}
/**
- * @return Returns the clipRectangle.
+ * Returns the clip rectangle.
+ * @return The clipRectangle.
*/
public Rectangle2D.Float getClipRectangle() {
return this.clipRectangle;
}
/**
- * @return Returns the contentRectangle.
+ * Returns the content rectangle.
+ * @return The contentRectangle.
*/
public Rectangle2D.Float getContentRectangle() {
return this.contentRectangle;
Modified: trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFXReference.java
===================================================================
--- trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFXReference.java 2007-02-26 15:05:51 UTC (rev 8763)
+++ trunk/foray/foray-pdf/src/java/org/foray/pdf/object/PDFXReference.java 2007-02-26 16:09:30 UTC (rev 8764)
@@ -42,8 +42,9 @@
public class PDFXReference extends PDFXForm {
/**
- * @param doc
- * @param img
+ * Constructor.
+ * @param doc The parent document.
+ * @param img The encapsulated graphic.
*/
public PDFXReference(final PDFDocument doc, final Graphic img,
final Rectangle2D.Float contentRectangle,
Modified: trunk/foray/foray-pdf/src/java/org/foray/pdf/svg/batik/PDFDocumentGraphics2D.java
===================================================================
--- trunk/foray/foray-pdf/src/java/org/foray/pdf/svg/batik/PDFDocumentGraphics2D.java 2007-02-26 15:05:51 UTC (rev 8763)
+++ trunk/foray/foray-pdf/src/java/org/foray/pdf/svg/batik/PDFDocumentGraphics2D.java 2007-02-26 16:09:30 UTC (rev 8764)
@@ -91,7 +91,7 @@
}
/**
- * This constructor supports the create method
+ * This constructor supports the create method.
*/
public PDFDocumentGraphics2D(final PDFDocumentGraphics2D g) {
super(g);
Modified: trunk/foray/foray-pdf/src/java/org/foray/pdf/svg/batik/PDFGraphics2D.java
===================================================================
--- trunk/foray/foray-pdf/src/java/org/foray/pdf/svg/batik/PDFGraphics2D.java 2007-02-26 15:05:51 UTC (rev 8763)
+++ trunk/foray/foray-pdf/src/java/org/foray/pdf/svg/batik/PDFGraphics2D.java 2007-02-26 16:09:30 UTC (rev 8764)
@@ -108,34 +108,22 @@
public static final byte QTY_ELEMENTS_QUAD = 4;
public static final byte QTY_ELEMENTS_LINEAR = 2;
- /**
- * the PDF Document being created
- */
+ /** The PDF Document being created. */
private PDFDocument pdfDoc;
- /**
- * the current (internal) font
- */
+ /** The current (internal) font. */
private org.axsl.fontR.FontUse currentFont;
- /**
- * the current font size in millipoints
- */
+ /** The current font size in millipoints. */
private float currentFontSize;
- /**
- * the current stream to add PDF commands to
- */
+ /** The current stream to add PDF commands to. */
private StringWriter currentStream = new StringWriter();
- /**
- * the current colour for use in svg
- */
+ /** The current colour for use in svg. */
private PDFColor currentColour = new PDFColor(new Color(0, 0, 0));
- /**
- * the current annotation list to add annotations to
- */
+ /** The current annotation list to add annotations to. */
private PDFAnnotList currentAnnotList = null;
private org.axsl.fontR.FontUse overrideFont = null;
@@ -145,9 +133,7 @@
private FontConsumer fontConsumer;
- /**
- * Used to create proper font metrics
- */
+ /** Used to cre...
[truncated message content] |
