You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pdfbox.apache.org by le...@apache.org on 2018/03/19 19:58:54 UTC
svn commit: r1827238 -
/pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/visible/PDFTemplateBuilder.java
Author: lehmi
Date: Mon Mar 19 19:58:54 2018
New Revision: 1827238
URL: http://svn.apache.org/viewvc?rev=1827238&view=rev
Log:
PDFBOX-4071: fix javadoc
Modified:
pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/visible/PDFTemplateBuilder.java
Modified: pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/visible/PDFTemplateBuilder.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/visible/PDFTemplateBuilder.java?rev=1827238&r1=1827237&r2=1827238&view=diff
==============================================================================
--- pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/visible/PDFTemplateBuilder.java (original)
+++ pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/visible/PDFTemplateBuilder.java Mon Mar 19 19:58:54 2018
@@ -40,7 +40,8 @@ public interface PDFTemplateBuilder
{
/**
* In order to create Affine Transform, using parameters.
- * @param params
+ *
+ * @param params parameter values
* @deprecated use {@link #createAffineTransform(java.awt.geom.AffineTransform) }
*/
@Deprecated
@@ -48,50 +49,50 @@ public interface PDFTemplateBuilder
/**
* In order to create Affine Transform, using parameters.
- * @param affineTransform
+ *
+ * @param affineTransform the transformation
*/
void createAffineTransform(AffineTransform affineTransform);
/**
* Creates specified size page.
*
- * @param properties
+ * @param properties property value
*/
void createPage(PDVisibleSignDesigner properties);
/**
* Creates template using page.
*
- * @param page
- * @throws IOException
+ * @param page the given page
+ * @throws IOException if something went wrong
*/
void createTemplate(PDPage page) throws IOException;
/**
* Creates Acro forms in the template.
*
- * @param template
+ * @param template the template document
*/
void createAcroForm(PDDocument template);
/**
* Creates signature fields.
*
- * @param acroForm
- * @throws IOException
+ * @param acroForm the acroform
+ * @throws IOException if something went wrong
*/
void createSignatureField(PDAcroForm acroForm) throws IOException;
/**
- * Creates the signature with the given name and assign it to the signature field parameter and
- * assign the page parameter to the widget.
+ * Creates the signature with the given name and assign it to the signature field parameter and assign the page
+ * parameter to the widget.
*
- * @param pdSignatureField
- * @param page
- * @param signerName the name of the person or authority signing the document. According to the
- * PDF specification, this value should be used only when it is not possible to extract the name
- * from the signature.
- * @throws IOException
+ * @param pdSignatureField signature filed
+ * @param page the given page
+ * @param signerName the name of the person or authority signing the document. According to the PDF specification,
+ * this value should be used only when it is not possible to extract the name from the signature.
+ * @throws IOException if something went wrong
*/
void createSignature(PDSignatureField pdSignatureField, PDPage page, String signerName)
throws IOException;
@@ -99,9 +100,9 @@ public interface PDFTemplateBuilder
/**
* Create AcroForm Dictionary.
*
- * @param acroForm
- * @param signatureField
- * @throws IOException
+ * @param acroForm the acroform
+ * @param signatureField the signature field
+ * @throws IOException if something went wrong
*/
void createAcroFormDictionary(PDAcroForm acroForm, PDSignatureField signatureField)
throws IOException;
@@ -109,9 +110,9 @@ public interface PDFTemplateBuilder
/**
* Creates SignatureRectangle.
*
- * @param signatureField
- * @param properties
- * @throws IOException
+ * @param signatureField the signature field
+ * @param properties properties
+ * @throws IOException if something went wrong
*/
void createSignatureRectangle(PDSignatureField signatureField,
PDVisibleSignDesigner properties) throws IOException;
@@ -123,18 +124,19 @@ public interface PDFTemplateBuilder
/**
* Creates signature image.
- * @param template
- * @param image
- * @throws IOException
+ *
+ * @param template template document
+ * @param image signature image
+ * @throws IOException if something went wrong
*/
void createSignatureImage(PDDocument template, BufferedImage image) throws IOException;
/**
- * An array of four numbers in the form coordinate system, giving the coordinates of the left,
- * bottom, right, and top edges, respectively, of the form XObjectâs bounding box. These
- * boundaries shall be used to clip the form XObject and to determine its size for caching.
+ * An array of four numbers in the form coordinate system, giving the coordinates of the left, bottom, right, and
+ * top edges, respectively, of the form XObjectâs bounding box. These boundaries shall be used to clip the form
+ * XObject and to determine its size for caching.
*
- * @param params
+ * @param params parameters
*
* @deprecated use {@link #createFormatterRectangle(int[]) createFormatterRectangle(int[])}
*/
@@ -142,17 +144,17 @@ public interface PDFTemplateBuilder
void createFormatterRectangle(byte[] params);
/**
- * An array of four numbers in the form coordinate system, giving the coordinates of the left,
- * bottom, right, and top edges, respectively, of the form XObjectâs bounding box. These
- * boundaries shall be used to clip the form XObject and to determine its size for caching.
+ * An array of four numbers in the form coordinate system, giving the coordinates of the left, bottom, right, and
+ * top edges, respectively, of the form XObjectâs bounding box. These boundaries shall be used to clip the form
+ * XObject and to determine its size for caching.
*
- * @param params
+ * @param params parameters
*/
void createFormatterRectangle(int[] params);
/**
*
- * @param template
+ * @param template template document
*/
void createHolderFormStream(PDDocument template);
@@ -164,9 +166,9 @@ public interface PDFTemplateBuilder
/**
* Creates Form
*
- * @param holderFormResources
- * @param holderFormStream
- * @param bbox
+ * @param holderFormResources holder form resources
+ * @param holderFormStream holder stream
+ * @param bbox bounding box
*/
void createHolderForm(PDResources holderFormResources, PDStream holderFormStream,
PDRectangle bbox);
@@ -174,16 +176,16 @@ public interface PDFTemplateBuilder
/**
* Creates appearance dictionary
*
- * @param holderForml
- * @param signatureField
- * @throws IOException
+ * @param holderForml holder XObject
+ * @param signatureField the signature field
+ * @throws IOException if something went wrong
*/
void createAppearanceDictionary(PDFormXObject holderForml,
PDSignatureField signatureField) throws IOException;
/**
*
- * @param template
+ * @param template template document
*/
void createInnerFormStream(PDDocument template);
@@ -194,23 +196,23 @@ public interface PDFTemplateBuilder
/**
*
- * @param innerFormResources
- * @param innerFormStream
- * @param bbox
+ * @param innerFormResources inner form resources
+ * @param innerFormStream inner form stream
+ * @param bbox bounding box
*/
void createInnerForm(PDResources innerFormResources, PDStream innerFormStream, PDRectangle bbox);
/**
*
- * @param innerForm
- * @param holderFormResources
+ * @param innerForm inner form XObject
+ * @param holderFormResources holder form resources
*/
void insertInnerFormToHolderResources(PDFormXObject innerForm,
PDResources holderFormResources);
/**
*
- * @param template
+ * @param template template document
*/
void createImageFormStream(PDDocument template);
@@ -222,13 +224,13 @@ public interface PDFTemplateBuilder
/**
* Creates Image form
*
- * @param imageFormResources
- * @param innerFormResource
- * @param imageFormStream
- * @param bbox
- * @param affineTransform
- * @param img
- * @throws IOException
+ * @param imageFormResources image form resources
+ * @param innerFormResource inner form resources
+ * @param imageFormStream image from stream
+ * @param bbox bounding box
+ * @param affineTransform transformation
+ * @param img ImageXObject
+ * @throws IOException if something went wrong
*/
void createImageForm(PDResources imageFormResources, PDResources innerFormResource,
PDStream imageFormStream, PDRectangle bbox, AffineTransform affineTransform,
@@ -237,9 +239,9 @@ public interface PDFTemplateBuilder
/**
* Creates the background layer form (n0).
*
- * @param innerFormResource
- * @param formatter
- * @throws IOException
+ * @param innerFormResource inner acroform resources
+ * @param formatter rectangle of the formatter
+ * @throws IOException if something went wrong
*/
void createBackgroundLayerForm(PDResources innerFormResource, PDRectangle formatter)
throws IOException;
@@ -247,12 +249,12 @@ public interface PDFTemplateBuilder
/**
* Inject procSetArray
*
- * @param innerForm
- * @param page
- * @param innerFormResources
- * @param imageFormResources
- * @param holderFormResources
- * @param procSet
+ * @param innerForm inner form
+ * @param page the given page
+ * @param innerFormResources inner form resources
+ * @param imageFormResources image form resources
+ * @param holderFormResources holder form resources
+ * @param procSet procset values
*/
void injectProcSetArray(PDFormXObject innerForm, PDPage page,
PDResources innerFormResources, PDResources imageFormResources,
@@ -261,14 +263,14 @@ public interface PDFTemplateBuilder
/**
* injects appearance streams
*
- * @param holderFormStream
- * @param innerFormStream
- * @param imageFormStream
- * @param imageFormName
- * @param imageName
- * @param innerFormName
- * @param properties
- * @throws IOException
+ * @param holderFormStream holder form stream
+ * @param innerFormStream inner form stream
+ * @param imageFormStream image form stream
+ * @param imageFormName image form name
+ * @param imageName image name
+ * @param innerFormName inner form name
+ * @param properties property values
+ * @throws IOException if something went wrong
*/
void injectAppearanceStreams(PDStream holderFormStream, PDStream innerFormStream,
PDStream imageFormStream, COSName imageFormName, COSName imageName,
@@ -277,16 +279,16 @@ public interface PDFTemplateBuilder
/**
* just to create visible signature
*
- * @param template
+ * @param template template document
*/
void createVisualSignature(PDDocument template);
/**
* adds Widget Dictionary
*
- * @param signatureField
- * @param holderFormResources
- * @throws IOException
+ * @param signatureField the signature field
+ * @param holderFormResources holder form resources
+ * @throws IOException if something went wrong
*/
void createWidgetDictionary(PDSignatureField signatureField,
PDResources holderFormResources) throws IOException;
@@ -300,8 +302,8 @@ public interface PDFTemplateBuilder
/**
* Closes template
*
- * @param template
- * @throws IOException
+ * @param template template document
+ * @throws IOException if something went wrong
*/
void closeTemplate(PDDocument template) throws IOException;
}