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

Class PDPushButton

  • All Implemented Interfaces:
    COSObjectable
    public class PDPushButton
extends PDButton
    A pushbutton is a purely interactive control that responds immediately to user input without retaining a permanent value.

    • Constructor Detail

      • PDPushButton

        public PDPushButton​(PDAcroForm acroForm)
        Parameters:
        acroForm - The acroform.
        See Also:
        PDField#PDfield(PDAcroForm)

    • Method Detail

      • getExportValues

        public List<String> getExportValues()
        Description copied from class: PDButton
        This will get the export values.

        The export values are defined in the field dictionaries /Opt key.

        The option values are used to define the export values for the field to

        • hold values in non-Latin writing systems as name objects, which represent the field value, are limited to PDFDocEncoding
        • allow radio buttons having the same export value to be handled independently

        Overrides:
        getExportValues in class PDButton
        Returns:
        List containing all possible export values. If there is no Opt entry an empty list will be returned.

      • setExportValues

        public void setExportValues​(List<String> values)
        Description copied from class: PDButton
        This will set the export values.
        Overrides:
        setExportValues in class PDButton
        Parameters:
        values - List containing all possible export values. Supplying null or an empty list will remove the Opt entry.
        See Also:
        PDButton.getExportValues()

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