Package net.webpdf.parameter.schema.extraction.info

Class DocumentType.Form

  • Enclosing class:
    DocumentType
    public static class DocumentType.Form
extends Object

    Java class for anonymous complex type

    .

    The following schema fragment specifies the expected content contained within this class.

    
 <complexType>
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="field" type="{http://schema.webpdf.de/1.0/extraction/info}FieldType" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
       <attribute name="objectKey" type="{http://www.w3.org/2001/XMLSchema}string" default="" />
       <attribute name="formType" type="{http://schema.webpdf.de/1.0/extraction/info}FormsFormatType" default="none" />
       <attribute name="defaultAppearance" type="{http://www.w3.org/2001/XMLSchema}string" default="" />
       <attribute name="needAppearances" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
     </restriction>
   </complexContent>
 </complexType>

    • Field Detail

      • objectKey

        protected String objectKey
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The object ID of the form.</p>
 
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema"><b>Info:</b>
                                         A PDF object ID consists of two numbers, where the first number selects the object's number and the second the "generation" of the object. The object ID shall always be unique within the context of the document and can be used to select a specific object.
                                     </p>

      • formType

        protected FormsFormatType formType
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">When set to another value than "none", the document does contain a PDF form in the hereby given format.
                                         <ul><li>none = The document does not contain a form.</li><li>acroForm = The document contains a standard PDF Acroform.</li><li>staticXFA = The document contains a "XML Forms Architecture" form with a fixed layout (static).</li><li>dynamicXFA = The document contains a "XML Forms Architecture" form with an adaptable/interactive layout (dynamic).</li></ul></p>

      • defaultAppearance

        protected String defaultAppearance
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">If present, this contains the default appearance of the form's fields. This shall be a string containing graphics and text state operators for example defining text colors, sizes etc.</p>

      • needAppearances

        protected Boolean needAppearances
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">When set to "true" the displaying Application shall generate appearances for all widgets defining the document's form.</p>

    • Constructor Detail

      • Form

        public Form()

    • Method Detail

      • getField

        public List<FieldType> getField()
        Gets the value of the field property.

        This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the field property.

        For example, to add a new item, do as follows: 

         getField().add(newItem);

        Objects of the following type(s) are allowed in the list FieldType

        Returns:
        The value of the field property.

      • getObjectKey

        public String getObjectKey()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The object ID of the form.</p>
 
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema"><b>Info:</b>
                                         A PDF object ID consists of two numbers, where the first number selects the object's number and the second the "generation" of the object. The object ID shall always be unique within the context of the document and can be used to select a specific object.
                                     </p>
        Returns:
        possible object is String

      • setObjectKey

        public void setObjectKey​(String value)
        Sets the value of the objectKey property.
        Parameters:
        value - allowed object is String
        See Also:
        getObjectKey()

      • getFormType

        public FormsFormatType getFormType()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">When set to another value than "none", the document does contain a PDF form in the hereby given format.
                                         <ul><li>none = The document does not contain a form.</li><li>acroForm = The document contains a standard PDF Acroform.</li><li>staticXFA = The document contains a "XML Forms Architecture" form with a fixed layout (static).</li><li>dynamicXFA = The document contains a "XML Forms Architecture" form with an adaptable/interactive layout (dynamic).</li></ul></p>
        Returns:
        possible object is FormsFormatType

      • getDefaultAppearance

        public String getDefaultAppearance()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">If present, this contains the default appearance of the form's fields. This shall be a string containing graphics and text state operators for example defining text colors, sizes etc.</p>
        Returns:
        possible object is String

      • setDefaultAppearance

        public void setDefaultAppearance​(String value)
        Sets the value of the defaultAppearance property.
        Parameters:
        value - allowed object is String
        See Also:
        getDefaultAppearance()

      • isNeedAppearances

        public boolean isNeedAppearances()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">When set to "true" the displaying Application shall generate appearances for all widgets defining the document's form.</p>
        Returns:
        possible object is Boolean

      • setNeedAppearances

        public void setNeedAppearances​(Boolean value)
        Sets the value of the needAppearances property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isNeedAppearances()