Class PdfCollectionField

java.lang.Object
com.lowagie.text.pdf.PdfObject
com.lowagie.text.pdf.PdfDictionary
com.lowagie.text.pdf.collection.PdfCollectionField

public class PdfCollectionField extends PdfDictionary
  • Field Details

    • TEXT

      public static final int TEXT
      A possible type of collection field.
      See Also:
    • DATE

      public static final int DATE
      A possible type of collection field.
      See Also:
    • NUMBER

      public static final int NUMBER
      A possible type of collection field.
      See Also:
    • FILENAME

      public static final int FILENAME
      A possible type of collection field.
      See Also:
    • DESC

      public static final int DESC
      A possible type of collection field.
      See Also:
    • MODDATE

      public static final int MODDATE
      A possible type of collection field.
      See Also:
    • CREATIONDATE

      public static final int CREATIONDATE
      A possible type of collection field.
      See Also:
    • SIZE

      public static final int SIZE
      A possible type of collection field.
      See Also:
    • fieldType

      protected int fieldType
      The type of the PDF collection field.
      Since:
      2.1.2 (was called type previously)
  • Constructor Details

    • PdfCollectionField

      public PdfCollectionField(String name, int type)
      Creates a PdfCollectionField.
      Parameters:
      name - the field name
      type - the field type
  • Method Details

    • setOrder

      public void setOrder(int i)
      The relative order of the field name. Fields are sorted in ascending order.
      Parameters:
      i - a number indicating the order of the field
    • setVisible

      public void setVisible(boolean visible)
      Sets the initial visibility of the field.
      Parameters:
      visible - the default is true (visible)
    • setEditable

      public void setEditable(boolean editable)
      Indication if the field value should be editable in the viewer.
      Parameters:
      editable - the default is false (not editable)
    • isCollectionItem

      public boolean isCollectionItem()
      Checks if the type of the field is suitable for a Collection Item.
      Returns:
      true if it is a Collection item, false otherwise
    • getValue

      public PdfObject getValue(String v)
      Returns a PdfObject that can be used as the value of a Collection Item.
      Parameters:
      v - value the value that has to be changed into a PdfObject (PdfString, PdfDate or PdfNumber)
      Returns:
      a PdfObject that can be used as the value of a Collection Item.