Package com.pd4ml.pdf.xfdf

Class XfdfExporter.Options

  • Enclosing class:
    XfdfExporter
    public static final class XfdfExporter.Options
extends java.lang.Object
    Export-time settings: the input password, and an optional type/ID subset to export.

    • Constructor Summary

      Constructors 
      Constructor Description
      Options()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      XfdfExporter.Options ids​(java.lang.String idsCsv)
      Restricts export to the annotations/fields whose ID is in the given comma-separated list -- an annotation's own /NM, or a field's fully-qualified (dot-joined) name.
      XfdfExporter.Options password​(java.lang.String password)
      Password to open the input, if encrypted (user or owner password; empty/omitted tries an empty password).
      XfdfExporter.Options types​(java.lang.String typesCsv)
      Restricts export to annotations/fields of the given type(s), a comma-separated list, e.g.

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • Options

        public Options()

    • Method Detail

      • password

        public XfdfExporter.Options password​(java.lang.String password)
        Password to open the input, if encrypted (user or owner password; empty/omitted tries an empty password).

      • types

        public XfdfExporter.Options types​(java.lang.String typesCsv)
        Restricts export to annotations/fields of the given type(s), a comma-separated list, e.g. "square,circle,highlight" or "tx,btn". An annotation matches by its XFDF element name (the lower-cased PDF /Subtype, e.g. "freetext", "stamp"); a field matches by its PDF /FT code ("Tx", "Btn", "Ch", "Sig" -- though a Sig field is never exported regardless, see FieldMapper's class docs). Matching is case-insensitive. The two vocabularies don't overlap, so a single list naturally picks from both categories at once: "square,tx" exports only Square annotations and text fields, nothing else. Pass null (the default) for no type restriction.

      • ids

        public XfdfExporter.Options ids​(java.lang.String idsCsv)
        Restricts export to the annotations/fields whose ID is in the given comma-separated list -- an annotation's own /NM, or a field's fully-qualified (dot-joined) name. Matching is exact and case-sensitive, since both are PDF identifiers, not free text. Pass null (the default) for no ID restriction. Combines with types(String) as an intersection (an item must satisfy both, when both are set).