Package net.webpdf.wsclient.openapi

Class MetadataField

  • public class MetadataField
extends Object
    Lists the properties of a PDF form field.

    • Constructor Detail

      • MetadataField

        public MetadataField()

    • Method Detail

      • getAlternateName

        @Nullable
public @Nullable String getAlternateName()
        The alternate name of the form field.
        Returns:
        alternateName

      • setAlternateName

        public void setAlternateName​(String alternateName)

      • getAnnotation

        @Nullable
public @Nullable List<MetadataAnnotation> getAnnotation()
        Selects the visible representation (widget annotation) for the form field.
        Returns:
        annotation

      • getContent

        @Nullable
public @Nullable String getContent()
        The textual content of the form field. A single string or a comma-separated list of string values for list types.
        Returns:
        content

      • setContent

        public void setContent​(String content)

      • getFullyQualifiedName

        @Nullable
public @Nullable String getFullyQualifiedName()
        The fully qualified name of the form field.
        Returns:
        fullyQualifiedName

      • setFullyQualifiedName

        public void setFullyQualifiedName​(String fullyQualifiedName)

      • getIsRichText

        @Nullable
public @Nullable Boolean getIsRichText()
        When set to true, the field contains rich text formatted content.
        Returns:
        isRichText

      • setIsRichText

        public void setIsRichText​(Boolean isRichText)

      • getMappingName

        @Nullable
public @Nullable String getMappingName()
        The mapping name of the form field.
        Returns:
        mappingName

      • setMappingName

        public void setMappingName​(String mappingName)

      • getMultiSelect

        @Nullable
public @Nullable Boolean getMultiSelect()
        When set to true, the form field allows multiple items to be seleted.
        Returns:
        multiSelect

      • setMultiSelect

        public void setMultiSelect​(Boolean multiSelect)

      • getName

        @Nullable
public @Nullable String getName()
        The partial name of the form field.
        Returns:
        name

      • setName

        public void setName​(String name)

      • getNoExport

        @Nullable
public @Nullable Boolean getNoExport()
        When set to true, the form field shall not be included in exports of the document's form data.
        Returns:
        noExport

      • setNoExport

        public void setNoExport​(Boolean noExport)

      • getObjectKey

        @Nullable
public @Nullable String getObjectKey()
        The object ID of the form field. **Info:** 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.
        Returns:
        objectKey

      • setObjectKey

        public void setObjectKey​(String objectKey)

      • getReadOnly

        @Nullable
public @Nullable Boolean getReadOnly()
        When set to true, the form field's contents may be displayed but not altered.
        Returns:
        readOnly

      • setReadOnly

        public void setReadOnly​(Boolean readOnly)

      • getRequired

        @Nullable
public @Nullable Boolean getRequired()
        When set to true, the form field must be filled in.
        Returns:
        required

      • setRequired

        public void setRequired​(Boolean required)

      • getSignature

        @Nullable
public @Nullable MetadataSignature getSignature()
        Get signature
        Returns:
        signature

      • getSubType

        @Nullable
public @Nullable String getSubType()
        The implementation name of the the form field.
        Returns:
        subType

      • setSubType

        public void setSubType​(String subType)

      • getType

        @Nullable
public @Nullable String getType()
        Indicates the type of the form field. * Btn = Button * Tx = Textfield * Ch = Choicefield * Sig = Signaturefield
        Returns:
        type

      • setType

        public void setType​(String type)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object