Class PDTerminalField

    • Constructor Detail

      • PDTerminalField

        protected PDTerminalField​(PDAcroForm acroForm)
        Constructor.
        Parameters:
        acroForm - The form that this field is part of.
      • PDTerminalField

        PDTerminalField​(PDAcroForm acroForm,
                        COSDictionary field,
                        PDNonTerminalField parent)
        Constructor.
        Parameters:
        acroForm - The form that this field is part of.
        field - the PDF object to represent as a field.
        parent - the parent node of the node
    • Method Detail

      • setActions

        public void setActions​(PDFormFieldAdditionalActions actions)
        Set the actions of the field.
        Parameters:
        actions - The field actions.
      • getFieldFlags

        public int getFieldFlags()
        Description copied from class: PDField
        This will get the flags for this field.
        Specified by:
        getFieldFlags in class PDField
        Returns:
        flags The set of flags.
      • getFieldType

        public java.lang.String getFieldType()
        Description copied from class: PDField
        Get the FT entry of the field. This is a read only field and is set depending on the actual type. The field type is an inheritable attribute.
        Specified by:
        getFieldType in class PDField
        Returns:
        The Field type.
      • importFDF

        public void importFDF​(FDFField fdfField)
                       throws java.io.IOException
        Description copied from class: PDField
        This will import a fdf field from a fdf document.
        Overrides:
        importFDF in class PDField
        Parameters:
        fdfField - The fdf field to import.
        Throws:
        java.io.IOException - If there is an error importing the data for this field.
      • exportFDF

        FDFField exportFDF()
                    throws java.io.IOException
        Description copied from class: PDField
        Exports this field and its children as FDF.
        Specified by:
        exportFDF in class PDField
        Throws:
        java.io.IOException
      • getWidgets

        public java.util.List<PDAnnotationWidget> getWidgets()
        Returns the widget annotations associated with this field.
        Specified by:
        getWidgets in class PDField
        Returns:
        The list of widget annotations. Be aware that this list is not backed by the actual widget collection of the field, so adding or deleting has no effect on the PDF document until you call setWidgets() with the modified list.
      • setWidgets

        public void setWidgets​(java.util.List<PDAnnotationWidget> children)
        Sets the field's widget annotations.
        Parameters:
        children - The list of widget annotations.
      • getWidget

        @Deprecated
        public PDAnnotationWidget getWidget()
        Deprecated.
        Fields may have more than one widget, call getWidgets() instead.
        This will get the single associated widget that is part of this field. This occurs when the Widget is embedded in the fields dictionary. Sometimes there are multiple sub widgets associated with this field, in which case you want to use getWidgets(). If the kids entry is specified, then the first entry in that list will be returned.
        Returns:
        The widget that is associated with this field.
      • applyChange

        protected final void applyChange()
                                  throws java.io.IOException
        Applies a value change to the field. Generates appearances if required and raises events.
        Throws:
        java.io.IOException - if the appearance couldn't be generated
      • constructAppearances

        abstract void constructAppearances()
                                    throws java.io.IOException
        Constructs appearance streams and appearance dictionaries for all widget annotations. Subclasses should not call this method directly but via applyChange().
        Throws:
        java.io.IOException - if the appearance couldn't be generated