You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pdfbox.apache.org by ms...@apache.org on 2015/07/01 18:15:07 UTC
svn commit: r1688679 -
/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDCheckbox.java
Author: msahyoun
Date: Wed Jul 1 16:15:07 2015
New Revision: 1688679
URL: http://svn.apache.org/r1688679
Log:
PDFBOX-2849: update javadoc
Modified:
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDCheckbox.java
Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDCheckbox.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDCheckbox.java?rev=1688679&r1=1688678&r2=1688679&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDCheckbox.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDCheckbox.java Wed Jul 1 16:15:07 2015
@@ -115,6 +115,9 @@ public final class PDCheckbox extends PD
/**
* Sets the checked value of this field.
+ *
+ * <p>To retrive the potential On value use {@link #getOnValue()} or
+ * {@link #getOnValues()}. The Off value shall always be 'Off'</p>
*
* @param value matching the On or Off state of the checkbox.
* @throws IOException if the value could not be set
@@ -141,7 +144,8 @@ public final class PDCheckbox extends PD
/**
* Sets the default value.
*
- * @param value True if checked
+ * @see #setValue(String)
+ * @param value matching the On or Off state of the checkbox.
*/
public void setDefaultValue(String value)
{