Package com.lowagie.text.pdf.collection
Class PdfCollectionField
java.lang.Object
com.lowagie.text.pdf.PdfObject
com.lowagie.text.pdf.PdfDictionary
com.lowagie.text.pdf.collection.PdfCollectionField
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
A possible type of collection field.static final int
A possible type of collection field.static final int
A possible type of collection field.protected int
The type of the PDF collection field.static final int
A possible type of collection field.static final int
A possible type of collection field.static final int
A possible type of collection field.static final int
A possible type of collection field.static final int
A possible type of collection field.Fields inherited from class com.lowagie.text.pdf.PdfDictionary
CATALOG, FONT, hashMap, OUTLINES, PAGE, PAGES
Fields inherited from class com.lowagie.text.pdf.PdfObject
ARRAY, BOOLEAN, bytes, DICTIONARY, INDIRECT, indRef, NAME, NOTHING, NULL, STREAM, STRING, TEXT_PDFDOCENCODING, TEXT_UNICODE, type
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturns a PdfObject that can be used as the value of a Collection Item.boolean
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.lowagie.text.pdf.PdfDictionary
clear, contains, get, getAsArray, getAsBoolean, getAsDict, getAsIndirectObject, getAsName, getAsNumber, getAsStream, getAsString, getDirectObject, getKeys, getKeysAndValues, isCatalog, isFont, isOutlineTree, isPage, isPages, merge, mergeDifferent, put, putAll, putEx, remove, size, toPdf, toString
Methods inherited from class com.lowagie.text.pdf.PdfObject
canBeInObjStm, getBytes, getIndRef, isArray, isBoolean, isDictionary, isIndirect, isName, isNull, isNumber, isStream, isString, length, setContent, setIndRef, type
-
Field Details
-
TEXT
public static final int TEXTA possible type of collection field.- See Also:
-
DATE
public static final int DATEA possible type of collection field.- See Also:
-
NUMBER
public static final int NUMBERA possible type of collection field.- See Also:
-
FILENAME
public static final int FILENAMEA possible type of collection field.- See Also:
-
DESC
public static final int DESCA possible type of collection field.- See Also:
-
MODDATE
public static final int MODDATEA possible type of collection field.- See Also:
-
CREATIONDATE
public static final int CREATIONDATEA possible type of collection field.- See Also:
-
SIZE
public static final int SIZEA possible type of collection field.- See Also:
-
fieldType
protected int fieldTypeThe type of the PDF collection field.- Since:
- 2.1.2 (was called
type
previously)
-
-
Constructor Details
-
PdfCollectionField
Creates a PdfCollectionField.- Parameters:
name
- the field nametype
- 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
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.
-