Package com.snowtide.pdf.forms

Class AcroChoiceField

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean allowsMultipleChoices()
      Returns true if this choice field's widget allows multiple selections.
      Region bounds()  
      boolean canChangeValue()
      Always returns true.
      Object getDefaultValue()
      Returns the default value to which the field reverts when a reset-form action is executed, as specified in the /DV entry in this field's PDF dictionary.
      String getDisplayValue​(String exportValue)
      Returns the display value associated with the supplied export value.
      String getExportValue​(String displayValue)  
      String getFullName()
      Returns the fully-qualified name of this field, which should be unique within a PDF document form.
      String getLocalName()
      Returns the local name of the field, as specified in the /T entry in this field's PDF dictionary.
      String getMappingName()
      Returns the 'mapping name' of this field, as specified in the /TM entry in this field's PDF dictionary.
      String getName()
      Returns the canonical name of this field.
      Map getOptions()
      Returns a Map containing all of the options offered by this choice field, using export values (strings that can be returned by getValue()) as keys mapped to display values (strings that are returned by getDisplayValue(String), given a valid export value).
      Object getType()
      Returns the type of field, as specified in the /FT entry in this field's PDF dictionary.
      String getUIName()
      Returns the user-friendly name of this field, as specified in the /TU entry in this field's PDF dictionary.
      Object getValue()
      Returns the value of this field, as specified in the /V entry in this field's PDF dictionary.
      int getWidgetType()
      Returns either CHOICE_TYPE_COMBO (indicating that this choice widget is a dropdown, single-selection field), or CHOICE_TYPE_LIST, indicating that this choice widget is a multiple-row, possibly multiple-selection field).
      boolean hasValueChanged()
      Returns true only if this field's value has been changed since being loaded from the PDF document.
      boolean isEditable()
      Returns true if this field is user-editable, indicating that a user may set this field's value to a arbitrary character string.
      boolean isReadOnly()
      Returns true only if this field is designated as read-only.
      int pageNumber()
      This page number is 0-indexed, and may be used to retrieve a Page object representing the page's content using the Document#getPage(int) function.
      boolean setValue​(String value)
      Updates this choice field's value so that the option corresponding with the single specified String is selected.
      boolean setValue​(String[] values)
      Updates this choice field's value so that each of the options corresponding with the Strings in the specified array are selected.

    • Method Detail

      • setValue

        public boolean setValue​(String value)
                 throws IllegalArgumentException
        Updates this choice field's value so that the option corresponding with the single specified String is selected.
        Specified by:
        setValue in interface AcroFormField
        Returns:
        true if this field's value changes as a result of this call, false otherwise
        Throws:
        IllegalArgumentException - if the specified value is not an allowable value. To be allowable, the specified value must appear as a key in the Map returned by getExportValue(String), or, if this field is editable, then any non-null String value is allowable.
        Since:
        v2.1

      • setValue

        public boolean setValue​(String[] values)
                 throws IllegalArgumentException
        Updates this choice field's value so that each of the options corresponding with the Strings in the specified array are selected.
        Returns:
        true if this field's value changes as a result of this call, false otherwise
        Throws:
        IllegalArgumentException - if this field does not allow multiple choices or if any String in the provided array is not an allowable value. To be allowable, each String in the given array must be non-null, and must appear as a key in the Map returned by getExportValue(String).
        Since:
        v2.1

      • getDisplayValue

        public String getDisplayValue​(String exportValue)
        Returns the display value associated with the supplied export value.

      • getExportValue

        public String getExportValue​(String displayValue)

      • getOptions

        public Map getOptions()
        Returns a Map containing all of the options offered by this choice field, using export values (strings that can be returned by getValue()) as keys mapped to display values (strings that are returned by getDisplayValue(String), given a valid export value).

      • isEditable

        public boolean isEditable()
        Returns true if this field is user-editable, indicating that a user may set this field's value to a arbitrary character string. If this happens, it is likely that this field's value will not correspond to a display value via getDisplayValue(String).

      • getWidgetType

        public int getWidgetType()
        Returns either CHOICE_TYPE_COMBO (indicating that this choice widget is a dropdown, single-selection field), or CHOICE_TYPE_LIST, indicating that this choice widget is a multiple-row, possibly multiple-selection field).

      • allowsMultipleChoices

        public boolean allowsMultipleChoices()

        Returns true if this choice field's widget allows multiple selections. This will only be true if getWidgetType() returns CHOICE_TYPE_LIST.

        This is important in that if this choice field's widget allows multiple selections, and multiple options have been selected, then the getValue() function will return an array of the selected options' values, instead of a simple String.

      • pageNumber

        public int pageNumber()
        Description copied from interface: DocumentLocation
        This page number is 0-indexed, and may be used to retrieve a Page object representing the page's content using the Document.getPage(int) function.

        If a page number is not available for some reason, then this method will return -1.

        Specified by:
        pageNumber in interface DocumentLocation

      • isReadOnly

        public boolean isReadOnly()
        Description copied from interface: AcroFormField
        Returns true only if this field is designated as read-only. Note that this is just a hint, provided for the benefit of end-user tools. PDFxStream does not enforce the read-only state of a form field; i.e. it will allow a field's value to be set even if it is designated as read-only.
        Specified by:
        isReadOnly in interface AcroFormField

      • getDefaultValue

        public Object getDefaultValue()
        Description copied from interface: AcroFormField
        Returns the default value to which the field reverts when a reset-form action is executed, as specified in the /DV entry in this field's PDF dictionary. The type of the returned object will be the same as the type of object returned by the AcroFormField.getValue() function, and depends upon the type of this field.
        Specified by:
        getDefaultValue in interface AcroFormField

      • getFullName

        public String getFullName()
        Description copied from interface: AcroFormField

        Returns the fully-qualified name of this field, which should be unique within a PDF document form. Details of how full names are constructed are specified in Section 8.6.2 (Field Names) of the PDF Document Specification.

        It suffices to say here that form fields in an interactive AcroForm are defined in a hierarchical manner, and that their local names are used to derive a period-delimited full name that guarantees each name's uniqueness within the parent AcroForm.

        Specified by:
        getFullName in interface AcroFormField

      • getLocalName

        public String getLocalName()
        Description copied from interface: AcroFormField
        Returns the local name of the field, as specified in the /T entry in this field's PDF dictionary. This name is also used as the value returned by the FormField.getName() implementation.
        Specified by:
        getLocalName in interface AcroFormField

      • getMappingName

        public String getMappingName()
        Description copied from interface: AcroFormField
        Returns the 'mapping name' of this field, as specified in the /TM entry in this field's PDF dictionary. The mapping name is used to identify the field in exported form data formats. This function can return null if no mapping name is defined.
        Specified by:
        getMappingName in interface AcroFormField

      • getName

        public String getName()
        Description copied from interface: FormField
        Returns the canonical name of this field. Only one FormField instance with a particular name should be available from a Form instance.
        Specified by:
        getName in interface FormField

      • getType

        public Object getType()
        Description copied from interface: AcroFormField
        Returns the type of field, as specified in the /FT entry in this field's PDF dictionary. This is an indication of the subtype of this AcroFormField instance:
        • If the return value is FIELD_TYPE_BUTTON, then this AcroFormField is an instance of AcroButtonField
        • If the return value is FIELD_TYPE_TEXT, then this AcroFormField is an instance of AcroTextField
        • If the return value is FIELD_TYPE_CHOICE, then this AcroFormField is an instance of AcroChoiceField
        • If the return value is FIELD_TYPE_SIGNATURE, then this AcroFormField is an instance of AcroSignatureField
        • If the return value is FIELD_TYPE_OTHER, then this AcroFormField has no specific concrete implementation. This case is reserved for form fields with new type indicators that may be introduced by Adobe in the future.
        Specified by:
        getType in interface AcroFormField

      • hasValueChanged

        public boolean hasValueChanged()
        Description copied from interface: AcroFormField
        Returns true only if this field's value has been changed since being loaded from the PDF document.
        Specified by:
        hasValueChanged in interface AcroFormField

      • getUIName

        public String getUIName()
        Description copied from interface: AcroFormField

        Returns the user-friendly name of this field, as specified in the /TU entry in this field's PDF dictionary. This function can return null if no user-friendly field name is defined.

        Specified by:
        getUIName in interface AcroFormField
        Specified by:
        getUIName in interface FormField

      • getValue

        public Object getValue()
        Description copied from interface: AcroFormField
        Returns the value of this field, as specified in the /V entry in this field's PDF dictionary. The type of the returned object depends upon the type of this field.
        Specified by:
        getValue in interface AcroFormField
        Specified by:
        getValue in interface FormField