svn commit: r1854481 - in /pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form: PDButton.java PDChoice.java PDSignatureField.java PDTextField.java

[ti...@apache.org]

Author: tilman
Date: Wed Feb 27 18:56:42 2019
New Revision: 1854481

URL: http://svn.apache.org/viewvc?rev=1854481&view=rev
Log:
PDFBOX-4071: improve javadoc, see SO question 54862619

Modified:
    pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDButton.java
    pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDChoice.java
    pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDSignatureField.java
    pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDTextField.java

Modified: pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDButton.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDButton.java?rev=1854481&r1=1854480&r2=1854481&view=diff
==============================================================================
--- pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDButton.java (original)
+++ pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDButton.java Wed Feb 27 18:56:42 2019
@@ -145,8 +145,9 @@ public abstract class PDButton extends P
     }
 
     /**
-     * Sets the selected option given its name.
-     * 
+     * Sets the selected option given its name. It also tries to update the visual appearance,
+     * unless {@link PDAcroForm#getNeedAppearances()} is true.
+     *
      * @param value Name of option to select
      * @throws IOException if the value could not be set
      * @throws IllegalArgumentException if the value is not a valid option.

Modified: pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDChoice.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDChoice.java?rev=1854481&r1=1854480&r2=1854481&view=diff
==============================================================================
--- pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDChoice.java (original)
+++ pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDChoice.java Wed Feb 27 18:56:42 2019
@@ -369,7 +369,8 @@ public abstract class PDChoice extends P
     }
 
     /**
-     * Sets the selected value of this field.
+     * Sets the selected value of this field. It also tries to update the visual appearance, unless
+     * {@link PDAcroForm#getNeedAppearances()} is true.
      *
      * @param value The name of the selected item.
      * @throws IOException if the value could not be set

Modified: pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDSignatureField.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDSignatureField.java?rev=1854481&r1=1854480&r2=1854481&view=diff
==============================================================================
--- pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDSignatureField.java (original)
+++ pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDSignatureField.java Wed Feb 27 18:56:42 2019
@@ -126,15 +126,13 @@ public class PDSignatureField extends PD
         getCOSObject().setItem(COSName.V, value);
         applyChange();
     }
-    
+
     /**
-     * Sets the value of this field.
-     * 
-     * <b>This will throw an UnsupportedOperationException if used as the signature fields
-     * value can't be set using a String</b>
-     * 
+     * <b>This will throw an UnsupportedOperationException if used as the signature fields value
+     * can't be set using a String</b>
+     *
      * @param value the plain text value.
-     * 
+     *
      * @throws UnsupportedOperationException in all cases!
      */
     @Override

Modified: pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDTextField.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDTextField.java?rev=1854481&r1=1854480&r2=1854481&view=diff
==============================================================================
--- pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDTextField.java (original)
+++ pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDTextField.java Wed Feb 27 18:56:42 2019
@@ -206,8 +206,9 @@ public final class PDTextField extends P
     }
 
     /**
-     * Sets the plain text value of this field.
-     * 
+     * Sets the plain text value of this field. It also tries to update the visual appearance,
+     * unless {@link PDAcroForm#getNeedAppearances()} is true.
+     *
      * @param value Plain text
      * @throws IOException if the value could not be set
      */