Class PDActionSubmitForm

java.lang.Object
org.apache.pdfbox.pdmodel.interactive.action.PDAction
org.apache.pdfbox.pdmodel.interactive.action.PDActionSubmitForm
All Implemented Interfaces:
COSObjectable, PDDestinationOrAction

public class PDActionSubmitForm extends PDAction
This represents a Submit-Form action that can be executed in a PDF document.
  • Field Details

  • Constructor Details

    • PDActionSubmitForm

      public PDActionSubmitForm()
      Default Constructor
    • PDActionSubmitForm

      public PDActionSubmitForm(COSDictionary a)
      Constructor
      Parameters:
      a - the action dictionary
  • Method Details

    • getFile

      public PDFileSpecification getFile() throws IOException
      This will get the file in which the destination is located.
      Returns:
      The F entry of the specific Submit-From action dictionary.
      Throws:
      IOException - If there is an error creating the file spec.
    • setFile

      public void setFile(PDFileSpecification fs)
      This will set the file in which the destination is located.
      Parameters:
      fs - The file specification.
    • getFields

      public COSArray getFields()
      An array identifying which fields to include in the submission or which to exclude, depending on the setting of the Include/Exclude flag in the Flags entry
      Returns:
      the array of fields
    • setFields

      public void setFields(COSArray array)
      Parameters:
      array - the array of fields
    • getFlags

      public int getFlags()
      A set of flags specifying various characteristics of the action
      Returns:
      the flags
    • setFlags

      public void setFlags(int flags)
      Parameters:
      flags - the flags