Class PDCheckBox

  • All Implemented Interfaces:
    COSObjectable

    public final class PDCheckBox
    extends PDButton
    A check box toggles between two states, on and off.
    • Constructor Detail

      • PDCheckBox

        PDCheckBox​(PDAcroForm acroForm,
                   COSDictionary field,
                   PDNonTerminalField parent)
        Constructor.
        Parameters:
        acroForm - The form that this field is part of.
        field - the PDF object to represent as a field.
        parent - the parent node of the node
    • Method Detail

      • isChecked

        public boolean isChecked()
        This will tell if this radio button is currently checked or not. This is equivalent to calling PDButton.getValue().
        Returns:
        true If this field is checked.
      • check

        public void check()
                   throws java.io.IOException
        Checks the check box.
        Throws:
        java.io.IOException - if the appearance couldn't be generated.
      • unCheck

        public void unCheck()
                     throws java.io.IOException
        Unchecks the check box.
        Throws:
        java.io.IOException - if the appearance couldn't be generated.
      • getOnValue

        public java.lang.String getOnValue()
        Get the value which sets the check box to the On state.

        The On value should be 'Yes' but other values are possible so we need to look for that. On the other hand 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.