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

Class FieldType

  • public class FieldType
extends Object
     <?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">Lists the properties of a PDF form field.</p>

    Java class for FieldType complex type

    .

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

    
 <complexType name="FieldType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="annotation" type="{http://schema.webpdf.de/1.0/extraction/info}AnnotationType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="signature" type="{http://schema.webpdf.de/1.0/extraction/info}SignatureType" minOccurs="0"/>
         <element name="value" type="{http://schema.webpdf.de/1.0/extraction/info}FormValueStyle" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
       <attribute name="objectKey" type="{http://www.w3.org/2001/XMLSchema}string" default="" />
       <attribute name="type" type="{http://www.w3.org/2001/XMLSchema}string" default="" />
       <attribute name="subType" type="{http://www.w3.org/2001/XMLSchema}string" default="" />
       <attribute name="name" type="{http://www.w3.org/2001/XMLSchema}string" default="" />
       <attribute name="mappingName" type="{http://www.w3.org/2001/XMLSchema}string" default="" />
       <attribute name="alternateName" type="{http://www.w3.org/2001/XMLSchema}string" default="" />
       <attribute name="fullyQualifiedName" type="{http://www.w3.org/2001/XMLSchema}string" default="" />
       <attribute name="noExport" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="readOnly" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="required" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="multiSelect" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="content" type="{http://www.w3.org/2001/XMLSchema}string" default="" />
       <attribute name="isRichText" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
     </restriction>
   </complexContent>
 </complexType>

    • Field Detail

      • annotation

        protected List<AnnotationType> annotation
         <?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">Selects the visible representation (widget annotation) for the form field.</p>

      • signature

        protected SignatureType signature
         <?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">Select the signature set for a signature form field.</p>

      • 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 field.
 
                         <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>

      • type

        protected String type
         <?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">Indicates the type of the form field.
                         <ul><li>Btn = Button</li><li>Tx = Textfield</li><li>Ch = Choicefield</li><li>Sig = Signaturefield</li></ul></p>

      • subType

        protected String subType
         <?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 implementation name of the the form field.</p>

      • name

        protected String name
         <?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 partial name of the form field.</p>

      • mappingName

        protected String mappingName
         <?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 mapping name of the form field.</p>

      • alternateName

        protected String alternateName
         <?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 alternate name of the form field.</p>

      • fullyQualifiedName

        protected String fullyQualifiedName
         <?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 fully qualified name of the form field.</p>

      • noExport

        protected Boolean noExport
         <?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 form field shall not be included in exports of the document's form data.</p>

      • readOnly

        protected Boolean readOnly
         <?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 form field's contents may be displayed but not altered.</p>

      • required

        protected Boolean required
         <?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 form field must be filled in.</p>

      • multiSelect

        protected Boolean multiSelect
         <?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 form field allows multiple items to be seleted.</p>

      • content

        protected String content
         <?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 textual content of the form field. A single string or a comma-separated list of string values for list types.</p>

      • isRichText

        protected Boolean isRichText
         <?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 field contains rich text formatted content.</p>

    • Constructor Detail

      • FieldType

        public FieldType()

    • Method Detail

      • getAnnotation

        public List<AnnotationType> getAnnotation()
         <?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">Selects the visible representation (widget annotation) for the form field.</p>
        Gets the value of the annotation 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 annotation property.

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

         getAnnotation().add(newItem);

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

        Returns:
        The value of the annotation property.

      • getSignature

        public SignatureType getSignature()
         <?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">Select the signature set for a signature form field.</p>
        Returns:
        possible object is SignatureType

      • getValue

        public List<FormValueStyle> getValue()
        Gets the value of the value 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 value property.

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

         getValue().add(newItem);

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

        Returns:
        The value of the value 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 field.
 
                         <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()

      • getType

        public String getType()
         <?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">Indicates the type of the form field.
                         <ul><li>Btn = Button</li><li>Tx = Textfield</li><li>Ch = Choicefield</li><li>Sig = Signaturefield</li></ul></p>
        Returns:
        possible object is String

      • setType

        public void setType​(String value)
        Sets the value of the type property.
        Parameters:
        value - allowed object is String
        See Also:
        getType()

      • getSubType

        public String getSubType()
         <?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 implementation name of the the form field.</p>
        Returns:
        possible object is String

      • setSubType

        public void setSubType​(String value)
        Sets the value of the subType property.
        Parameters:
        value - allowed object is String
        See Also:
        getSubType()

      • getName

        public String getName()
         <?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 partial name of the form field.</p>
        Returns:
        possible object is String

      • setName

        public void setName​(String value)
        Sets the value of the name property.
        Parameters:
        value - allowed object is String
        See Also:
        getName()

      • getMappingName

        public String getMappingName()
         <?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 mapping name of the form field.</p>
        Returns:
        possible object is String

      • setMappingName

        public void setMappingName​(String value)
        Sets the value of the mappingName property.
        Parameters:
        value - allowed object is String
        See Also:
        getMappingName()

      • getAlternateName

        public String getAlternateName()
         <?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 alternate name of the form field.</p>
        Returns:
        possible object is String

      • setAlternateName

        public void setAlternateName​(String value)
        Sets the value of the alternateName property.
        Parameters:
        value - allowed object is String
        See Also:
        getAlternateName()

      • getFullyQualifiedName

        public String getFullyQualifiedName()
         <?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 fully qualified name of the form field.</p>
        Returns:
        possible object is String

      • setFullyQualifiedName

        public void setFullyQualifiedName​(String value)
        Sets the value of the fullyQualifiedName property.
        Parameters:
        value - allowed object is String
        See Also:
        getFullyQualifiedName()

      • isNoExport

        public boolean isNoExport()
         <?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 form field shall not be included in exports of the document's form data.</p>
        Returns:
        possible object is Boolean

      • setNoExport

        public void setNoExport​(Boolean value)
        Sets the value of the noExport property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isNoExport()

      • isReadOnly

        public boolean isReadOnly()
         <?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 form field's contents may be displayed but not altered.</p>
        Returns:
        possible object is Boolean

      • setReadOnly

        public void setReadOnly​(Boolean value)
        Sets the value of the readOnly property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isReadOnly()

      • isRequired

        public boolean isRequired()
         <?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 form field must be filled in.</p>
        Returns:
        possible object is Boolean

      • setRequired

        public void setRequired​(Boolean value)
        Sets the value of the required property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isRequired()

      • isMultiSelect

        public boolean isMultiSelect()
         <?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 form field allows multiple items to be seleted.</p>
        Returns:
        possible object is Boolean

      • setMultiSelect

        public void setMultiSelect​(Boolean value)
        Sets the value of the multiSelect property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isMultiSelect()

      • getContent

        public String getContent()
         <?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 textual content of the form field. A single string or a comma-separated list of string values for list types.</p>
        Returns:
        possible object is String

      • setContent

        public void setContent​(String value)
        Sets the value of the content property.
        Parameters:
        value - allowed object is String
        See Also:
        getContent()

      • isIsRichText

        public boolean isIsRichText()
         <?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 field contains rich text formatted content.</p>
        Returns:
        possible object is Boolean

      • setIsRichText

        public void setIsRichText​(Boolean value)
        Sets the value of the isRichText property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isIsRichText()