Package com.aowagie.text.pdf.collection
Class PdfCollectionField
- java.lang.Object
-
- com.aowagie.text.pdf.PdfObject
-
- com.aowagie.text.pdf.PdfDictionary
-
- com.aowagie.text.pdf.collection.PdfCollectionField
-
class PdfCollectionField extends PdfDictionary
-
-
Field Summary
Fields Modifier and Type Field Description static int
DATE
A possible type of collection field.protected int
fieldType
The type of the PDF collection field.static int
NUMBER
A possible type of collection field.private static int
TEXT
A possible type of collection field.-
Fields inherited from class com.aowagie.text.pdf.PdfDictionary
hashMap
-
-
Constructor Summary
Constructors Constructor Description PdfCollectionField()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PdfObject
getValue(java.lang.String v)
Returns a PdfObject that can be used as the value of a Collection Item.boolean
isCollectionItem()
Checks if the type of the field is suitable for a Collection Item.void
setEditable(boolean editable)
Indication if the field value should be editable in the viewer.void
setOrder(int i)
The relative order of the field name.void
setVisible(boolean visible)
Sets the initial visibility of the field.-
Methods inherited from class com.aowagie.text.pdf.PdfDictionary
get, getAsArray, getAsDict, getAsName, getAsNumber, getAsString, getDirectObject, getKeys, isCatalog, isFont, isOutlineTree, isPage, isPages, put, remove, size, toPdf, toString
-
Methods inherited from class com.aowagie.text.pdf.PdfObject
getBytes, getIndRef, isArray, isBoolean, isDictionary, isIndirect, isName, isNull, isNumber, isStream, isString, setContent, setIndRef, type
-
-
-
-
Field Detail
-
TEXT
private static final int TEXT
A possible type of collection field.- See Also:
- Constant Field Values
-
DATE
public static final int DATE
A possible type of collection field.- See Also:
- Constant Field Values
-
NUMBER
public static final int NUMBER
A possible type of collection field.- See Also:
- Constant Field Values
-
fieldType
protected int fieldType
The type of the PDF collection field.- Since:
- 2.1.2 (was called
type
previously)
-
-
Method Detail
-
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.
-
getValue
public PdfObject getValue(java.lang.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)
-
-