1 files changed, 218 insertions, 0 deletions
diff --git a/src/main/java/org/pdfbox/pdmodel/interactive/form/PDFieldFactory.java b/src/main/java/org/pdfbox/pdmodel/interactive/form/PDFieldFactory.java
new file mode 100644
index 0000000..c796714
--- /dev/null
+++ b/src/main/java/org/pdfbox/pdmodel/interactive/form/PDFieldFactory.java
@@ -0,0 +1,218 @@
+/**
+ * Copyright (c) 2003-2004, www.pdfbox.org
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ *    this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ * 3. Neither the name of pdfbox; nor the names of its
+ *    contributors may be used to endorse or promote products derived from this
+ *    software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * http://www.pdfbox.org
+ *
+ */
+package org.pdfbox.pdmodel.interactive.form;
+
+import org.pdfbox.cos.COSArray;
+import org.pdfbox.cos.COSDictionary;
+import org.pdfbox.cos.COSName;
+import org.pdfbox.pdmodel.interactive.annotation.PDAnnotationWidget;
+
+import java.io.IOException;
+
+import java.util.List;
+
+/**
+ * This is the Factory for creating and returning the correct
+ * field elements.
+ *
+ * @author sug
+ * @version $Revision: 1.8 $
+ */
+public class PDFieldFactory
+{
+    private static final int RADIO_BITMASK = 32768;
+    private static final int PUSHBUTTON_BITMASK = 65536;
+    private static final int RADIOS_IN_UNISON_BITMASK = 33554432;
+
+    private static final String FIELD_TYPE_BTN = "Btn";
+    private static final String FIELD_TYPE_TX = "Tx";
+    private static final String FIELD_TYPE_CH = "Ch";
+    private static final String FIELD_TYPE_SIG = "Sig";
+
+    /**
+     * Utility class so no constructor.
+     */
+    private PDFieldFactory()
+    {
+        //do nothing.
+    }
+
+    /**
+     * This method creates a COSField subclass from the given field.
+     * The field is a PDF Dictionary object that must represent a
+     * field element. - othewise null is returned
+     *
+     * @param acroForm The form that the field will be part of.
+     * @param field The dictionary representing a field element
+     *
+     * @return a subclass to COSField according to the kind of field passed to createField
+     * @throws IOException If there is an error determining the field type.
+     */
+    public static PDField createField( PDAcroForm acroForm, COSDictionary field) throws IOException
+    {
+        PDField pdField = new PDUnknownField( acroForm, field );
+        if( isButton(pdField) )
+        {
+            int flags = pdField.getFieldFlags();
+            //BJL, I have found that the radio flag bit is not always set
+            //and that sometimes there is just a kids dictionary.
+            //so, if there is a kids dictionary then it must be a radio button
+            //group.
+            COSArray kids = (COSArray)field.getDictionaryObject( COSName.getPDFName( "Kids" ) );
+            if( kids != null || isRadio(flags) )
+            {
+                pdField = new PDRadioCollection( acroForm, field );
+            }
+            else if( isPushButton( flags ) )
+            {
+                pdField = new PDPushButton( acroForm, field );
+            }
+            else
+            {
+                pdField = new PDCheckbox( acroForm, field );
+            }
+
+        }
+        else if (isChoiceField(pdField))
+        {
+            pdField = new PDChoiceField( acroForm, field );
+        }
+        else if (isTextbox(pdField))
+        {
+            pdField = new PDTextbox( acroForm, field );
+        }
+        else if( isSignature( pdField ) )
+        {
+            pdField = new PDSignature( acroForm, field );
+        }
+        else
+        {
+            //do nothing and return an unknown field type.
+        }
+        return pdField;
+    }
+
+    /**
+     * This method determines if the given
+     * field is a radiobutton collection.
+     *
+     * @param flags The field flags.
+     *
+     * @return the result of the determination
+     */
+    private static boolean isRadio( int flags )
+    {
+        return (flags & RADIO_BITMASK) > 0;
+    }
+
+    /**
+     * This method determines if the given
+     * field is a pushbutton.
+     *
+     * @param flags The field flags.
+     *
+     * @return the result of the determination
+     */
+    private static boolean isPushButton( int flags )
+    {
+        return (flags & PUSHBUTTON_BITMASK) > 0;
+    }
+
+    /**
+     * This method determines if the given field is a choicefield
+     * Choicefields are either listboxes or comboboxes.
+     *
+     * @param field the field to determine
+     * @return the result of the determination
+     */
+    private static boolean isChoiceField(PDField field) throws IOException
+    {
+        return FIELD_TYPE_CH.equals(field.findFieldType());
+    }
+
+    /**
+     * This method determines if the given field is a button.
+     *
+     * @param field the field to determine
+     * @return the result of the determination
+     * 
+     * @throws IOException If there is an error determining the field type.
+     */
+    private static boolean isButton(PDField field) throws IOException
+    {
+        String ft = field.findFieldType();
+        boolean retval = FIELD_TYPE_BTN.equals( ft );
+        List kids = field.getKids();
+        if( ft == null && kids != null && kids.size() > 0)
+        {
+            //sometimes if it is a button the type is only defined by one
+            //of the kids entries
+            Object obj = kids.get( 0 );
+            COSDictionary kidDict = null;
+            if( obj instanceof PDField )
+            {
+                kidDict = ((PDField)obj).getDictionary();
+            }
+            else if( obj instanceof PDAnnotationWidget )
+            {
+                kidDict = ((PDAnnotationWidget)obj).getDictionary();
+            }
+            else
+            {
+                throw new IOException( "Error:Unexpected type of kids field:" + obj );
+            }
+            retval = isButton( new PDUnknownField( field.getAcroForm(), kidDict ) );
+        }
+        return retval;
+    }
+
+   /**
+     * This method determines if the given field is a signature.
+     *
+     * @param field the field to determine
+     * @return the result of the determination
+     */
+    private static boolean isSignature(PDField field) throws IOException
+    {
+        return FIELD_TYPE_SIG.equals(field.findFieldType());
+    }
+
+    /**
+     * This method determines if the given field is a Textbox.
+     *
+     * @param field the field to determine
+     * @return the result of the determination
+     */
+    private static boolean isTextbox(PDField field) throws IOException
+    {
+        return FIELD_TYPE_TX.equals(field.findFieldType());
+    }
+}
+\ No newline at end of file