Package org.apache.pdfbox.pdmodel.fdf

Class FDFOptionElement

  • All Implemented Interfaces:
    COSObjectable
    public class FDFOptionElement
extends java.lang.Object
implements COSObjectable
    This represents an object that can be used in a Field's Opt entry to represent an available option and a default appearance string.
    Author:
    Ben Litchfield

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      COSArray getCOSArray()
      Convert this standard java object to a COS object.
      COSBase getCOSObject()
      Convert this standard java object to a COS object.
      java.lang.String getDefaultAppearanceString()
      This will get the string of default appearance string.
      java.lang.String getOption()
      This will get the string of one of the available options.
      void setDefaultAppearanceString​(java.lang.String da)
      This will set the default appearance string.
      void setOption​(java.lang.String opt)
      This will set the string for an available option.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • FDFOptionElement

        public FDFOptionElement()
        Default constructor.

      • FDFOptionElement

        public FDFOptionElement​(COSArray o)
        Constructor.
        Parameters:
        o - The option element.

    • Method Detail

      • getCOSObject

        public COSBase getCOSObject()
        Convert this standard java object to a COS object.
        Specified by:
        getCOSObject in interface COSObjectable
        Returns:
        The cos object that matches this Java object.

      • getCOSArray

        public COSArray getCOSArray()
        Convert this standard java object to a COS object.
        Returns:
        The cos object that matches this Java object.

      • getOption

        public java.lang.String getOption()
        This will get the string of one of the available options. A required element.
        Returns:
        An available option.

      • setOption

        public void setOption​(java.lang.String opt)
        This will set the string for an available option.
        Parameters:
        opt - One of the available options.

      • getDefaultAppearanceString

        public java.lang.String getDefaultAppearanceString()
        This will get the string of default appearance string. A required element.
        Returns:
        A default appearance string.

      • setDefaultAppearanceString

        public void setDefaultAppearanceString​(java.lang.String da)
        This will set the default appearance string.
        Parameters:
        da - The default appearance string.