Mailing-List: contact commits-help@pdfbox.apache.org; run by ezmlm
Precedence: bulk
Reply-To: dev@pdfbox.apache.org
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Subject: svn commit: r1771184 -
 /pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/encryption/AccessPermission.java
Date: Thu, 24 Nov 2016 16:38:34 -0000
To: commits@pdfbox.apache.org
From: tilman@apache.org
Message-Id: <20161124163834.1D8D83A0252@svn01-us-west.apache.org>
archived-at: Thu, 24 Nov 2016 16:38:41 -0000

Author: tilman
Date: Thu Nov 24 16:38:33 2016
New Revision: 1771184

URL: http://svn.apache.org/viewvc?rev=1771184&view=rev
Log:
PDFBOX-3590: improve javadoc

Modified:
    pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/encryption/AccessPermission.java

Modified: pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/encryption/AccessPermission.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/encryption/AccessPermission.java?rev=1771184&r1=1771183&r2=1771184&view=diff
==============================================================================
--- pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/encryption/AccessPermission.java (original)
+++ pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/encryption/AccessPermission.java Thu Nov 24 16:38:33 2016
@@ -209,7 +209,8 @@ public class AccessPermission
 
     /**
      * Set if the user can print.
-     * This method will have no effect if the object is in read only mode
+     * <p>
+     * This method will have no effect if the object is in read only mode.
      *
      * @param allowPrinting A boolean determining if the user can print.
      */
@@ -233,7 +234,8 @@ public class AccessPermission
 
     /**
      * Set if the user can modify the document.
-     * This method will have no effect if the object is in read only mode
+     * <p>
+     * This method will have no effect if the object is in read only mode.
      *
      * @param allowModifications A boolean determining if the user can modify the document.
      */
@@ -258,7 +260,8 @@ public class AccessPermission
 
     /**
      * Set if the user can extract content from the document.
-     * This method will have no effect if the object is in read only mode
+     * <p>
+     * This method will have no effect if the object is in read only mode.
      *
      * @param allowExtraction A boolean determining if the user can extract content
      *                        from the document.
@@ -272,7 +275,11 @@ public class AccessPermission
     }
 
     /**
-     * This will tell if the user can add/modify text annotations, fill in interactive forms fields.
+     * This will tell if the user can add or modify text annotations and fill in interactive forms
+     * fields and, if {@link #canModify() canModify()} returns true, create or modify interactive
+     * form fields (including signature fields). Note that if
+     * {@link #canFillInForm() canFillInForm()} returns true, it is still possible to fill in
+     * interactive forms (including signature fields) even if this method here returns false.
      *
      * @return true If supplied with the user password they are allowed to modify annotations.
      */
@@ -282,10 +289,15 @@ public class AccessPermission
     }
 
     /**
-     * Set if the user can modify annotations.
-     * This method will have no effect if the object is in read only mode
+     * Set if the user can add or modify text annotations and fill in interactive forms fields and,
+     * if {@link #canModify() canModify()} returns true, create or modify interactive form fields
+     * (including signature fields). Note that if {@link #canFillInForm() canFillInForm()} returns
+     * true, it is still possible to fill in interactive forms (including signature fields) even the
+     * parameter here is false.
+     * <p>
+     * This method will have no effect if the object is in read only mode.
      *
-     * @param allowAnnotationModification A boolean determining if the user can modify annotations.
+     * @param allowAnnotationModification A boolean determining the new setting.
      */
     public void setCanModifyAnnotations( boolean allowAnnotationModification )
     {
@@ -296,7 +308,8 @@ public class AccessPermission
     }
 
     /**
-     * This will tell if the user can fill in interactive forms.
+     * This will tell if the user can fill in interactive form fields (including signature fields)
+     * even if {@link #canModifyAnnotations() canModifyAnnotations()} returns false.
      *
      * @return true If supplied with the user password they are allowed to fill in form fields.
      */
@@ -306,8 +319,12 @@ public class AccessPermission
     }
 
     /**
-     * Set if the user can fill in interactive forms.
-     * This method will have no effect if the object is in read only mode
+     * Set if the user can fill in interactive form fields (including signature fields) even if
+     * {@link #canModifyAnnotations() canModifyAnnotations()} returns false. Therefore, if you want
+     * to prevent a user from filling in interactive form fields, you need to call
+     * {@link #setCanModifyAnnotations(boolean) setCanModifyAnnotations(false)} as well.
+     *<p>
+     * This method will have no effect if the object is in read only mode.
      *
      * @param allowFillingInForm A boolean determining if the user can fill in interactive forms.
      */
@@ -333,7 +350,8 @@ public class AccessPermission
 
     /**
      * Set if the user can extract content from the document for accessibility purposes.
-     * This method will have no effect if the object is in read only mode
+     * <p>
+     * This method will have no effect if the object is in read only mode.
      *
      * @param allowExtraction A boolean determining if the user can extract content
      *                        from the document.
@@ -359,7 +377,8 @@ public class AccessPermission
 
     /**
      * Set if the user can insert/rotate/delete pages.
-     * This method will have no effect if the object is in read only mode
+     * <p>
+     * This method will have no effect if the object is in read only mode.
      *
      * @param allowAssembly A boolean determining if the user can assemble the document.
      */
@@ -384,7 +403,8 @@ public class AccessPermission
 
     /**
      * Set if the user can print the document in a degraded format.
-     * This method will have no effect if the object is in read only mode
+     * <p>
+     * This method will have no effect if the object is in read only mode.
      *
      * @param allowAssembly A boolean determining if the user can print the
      *        document in a degraded format.