Package com.tom_roush.pdfbox.pdmodel.interactive.form

Class PDRadioButton

  • All Implemented Interfaces:
    COSObjectable
    public final class PDRadioButton
extends PDButton
    Radio button fields contain a set of related buttons that can each be on or off.

    • Method Detail

      • setRadiosInUnison

        public void setRadiosInUnison​(boolean radiosInUnison)
        From the PDF Spec
        If set, a group of radio buttons within a radio button field that use the same value for the on state will turn on and off in unison; that is if one is checked, they are all checked. If clear, the buttons are mutually exclusive (the same behavior as HTML radio buttons).
        Parameters:
        radiosInUnison - The new flag for radiosInUnison.

      • isRadiosInUnison

        public boolean isRadiosInUnison()
        Returns:
        true If the flag is set for radios in unison.

      • getSelectedExportValues

        public List<String> getSelectedExportValues()
                                     throws IOException
        This will get the selected export values.

        A RadioButton might have an export value to allow field values which can not be encoded as PDFDocEncoding or for the same export value being assigned to multiple RadioButtons in a group.
        To define an export value the RadioButton must define options PDButton.setExportValues(List) which correspond to the individual items within the RadioButton.

        The method will either return the corresponding values from the options entry or in case there is no such entry the fields value

        Returns:
        the export value of the field.
        Throws:
        IOException - in case the fields value can not be retrieved

      • getValue

        public String getValue()
        Returns the selected value. May be empty if NoToggleToOff is set but there is no value selected.
        Returns:
        A non-null string.

      • getDefaultValue

        public String getDefaultValue()
        Returns the default value, if any.
        Returns:
        A non-null string.

      • getValueAsString

        public String getValueAsString()
        Description copied from class: PDField
        Returns a string representation of the "V" entry, or an empty string.
        Specified by:
        getValueAsString in class PDField
        Returns:
        A non-null string.

      • setValue

        public void setValue​(String value)
              throws IOException
        Sets the selected radio button, given its name.
        Parameters:
        value - Name of radio button to select
        Throws:
        IOException - if the value could not be set
        IllegalArgumentException - if the value is not a valid option.

      • setDefaultValue

        public void setDefaultValue​(String value)
        Sets the default value.
        Parameters:
        value - Name of radio button to select
        Throws:
        IOException - if the value could not be set
        IllegalArgumentException - if the value is not a valid option.

      • getOnValues

        public Set<String> getOnValues()
        Get the values to set individual radio buttons to the on state.

        The On value could be an arbitrary string as long as it is within the limitations of a PDF name object. The Off value shall always be 'Off'. If not set or not part of the normal appearance keys 'Off' is the default

        Returns:
        the value setting the check box to the On state. If an empty string is returned there is no appearance definition.