Class FdfWriter


  • public class FdfWriter
    extends Object
    Writes an FDF form.
    Author:
    Paulo Soares
    • Field Detail

      • COUNTER

        protected Counter COUNTER
    • Method Detail

      • getStatusMessage

        public String getStatusMessage()
      • setStatusMessage

        public void setStatusMessage​(String statusMessage)
      • removeField

        public boolean removeField​(String field)
        Removes the field value.
        Parameters:
        field - the field name
        Returns:
        true if the field was found and removed, false otherwise
      • getFields

        public HashMap<String,​Object> getFields()
        Gets all the fields. The map is keyed by the fully qualified field name and the values are PdfObject.
        Returns:
        a map with all the fields
      • getField

        public String getField​(String field)
        Gets the field value.
        Parameters:
        field - the field name
        Returns:
        the field value or null if not found
      • setFieldAsName

        public boolean setFieldAsName​(String field,
                                      String value)
        Sets the field value as a name.
        Parameters:
        field - the fully qualified field name
        value - the value
        Returns:
        true if the value was inserted, false if the name is incompatible with an existing field
      • setFieldAsString

        public boolean setFieldAsString​(String field,
                                        String value)
        Sets the field value as a string.
        Parameters:
        field - the fully qualified field name
        value - the value
        Returns:
        true if the value was inserted, false if the name is incompatible with an existing field
      • setFieldAsAction

        public boolean setFieldAsAction​(String field,
                                        PdfAction action)
        Sets the field value as a PDFAction. For example, this method allows setting a form submit button action using PdfAction.createSubmitForm(String, Object[], int). This method creates an A entry for the specified field in the underlying FDF file. Method contributed by Philippe Laflamme (plaflamme)
        Parameters:
        field - the fully qualified field name
        action - the field's action
        Returns:
        true if the value was inserted, false if the name is incompatible with an existing field
        Since:
        2.1.5
      • setFieldAsTemplate

        public boolean setFieldAsTemplate​(String field,
                                          PdfTemplate template)
      • setFieldAsImage

        public boolean setFieldAsImage​(String field,
                                       Image image)
      • setFieldAsJavascript

        public boolean setFieldAsJavascript​(String field,
                                            PdfName jsTrigName,
                                            String js)
      • createTemplate

        public PdfTemplate createTemplate​(float width,
                                          float height)
      • setFields

        public void setFields​(FdfReader fdf)
        Sets all the fields from this FdfReader
        Parameters:
        fdf - the FdfReader
      • setFields

        public void setFields​(PdfReader pdf)
        Sets all the fields from this PdfReader
        Parameters:
        pdf - the PdfReader
      • setFields

        public void setFields​(AcroFields af)
        Sets all the fields from this AcroFields
        Parameters:
        af - the AcroFields
      • getFile

        public String getFile()
        Gets the PDF file name associated with the FDF.
        Returns:
        the PDF file name associated with the FDF
      • setFile

        public void setFile​(String file)
        Sets the PDF file name associated with the FDF.
        Parameters:
        file - the PDF file name associated with the FDF
      • getCounter

        protected Counter getCounter()