PdfCollectionField (iText 7 7.1.2 API)

java.lang.Object
- com.itextpdf.kernel.pdf.PdfObjectWrapper<PdfDictionary>
- - com.itextpdf.kernel.pdf.collection.PdfCollectionField

All Implemented Interfaces:: Serializable

public class PdfCollectionField
extends PdfObjectWrapper<PdfDictionary>

See Also:: Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CREATIONDATE` A possible type of collection field.
`static int`	`DATE` A possible type of collection field.
`static int`	`DESC` A possible type of collection field.
`static int`	`FILENAME` A possible type of collection field.
`static int`	`MODDATE` A possible type of collection field.
`static int`	`NUMBER` A possible type of collection field.
`static int`	`SIZE` A possible type of collection field.
`protected int`	`subType`
`static int`	`TEXT` A possible type of collection field.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`PdfCollectionField(PdfDictionary pdfObject)`
	`PdfCollectionField(String name, int subType)` Creates a PdfCollectionField.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PdfBoolean`	`getEditable()`
`PdfNumber`	`getOrder()`
`PdfObject`	`getValue(String value)`
`PdfBoolean`	`getVisibility()`
`protected boolean`	`isWrappedObjectMustBeIndirect()` Defines if the object behind this wrapper must be an indirect object in the resultant document.
`PdfCollectionField`	`setEditable(boolean editable)` Indication if the field value should be editable in the viewer.
`PdfCollectionField`	`setOrder(int order)` The relative order of the field name.
`PdfCollectionField`	`setVisibility(boolean visible)` Sets the initial visibility of the field.

Methods inherited from class com.itextpdf.kernel.pdf.PdfObjectWrapper
ensureObjectIsAddedToDocument, ensureUnderlyingObjectHasIndirectReference, flush, getPdfObject, isFlushed, makeIndirect, makeIndirect, markObjectAsIndirect, setForbidRelease, setModified, setPdfObject, unsetForbidRelease

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - TEXT
```
public 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
  - FILENAME
```
public static final int FILENAME
```
    A possible type of collection field.
    
    See Also:
    
    Constant Field Values
  - DESC
```
public static final int DESC
```
    A possible type of collection field.
    
    See Also:
    
    Constant Field Values
  - MODDATE
```
public static final int MODDATE
```
    A possible type of collection field.
    
    See Also:
    
    Constant Field Values
  - CREATIONDATE
```
public static final int CREATIONDATE
```
    A possible type of collection field.
    
    See Also:
    
    Constant Field Values
  - SIZE
```
public static final int SIZE
```
    A possible type of collection field.
    
    See Also:
    
    Constant Field Values
  - subType
```
protected int subType
```
- Constructor Detail
  - PdfCollectionField
```
protected PdfCollectionField(PdfDictionary pdfObject)
```
  - PdfCollectionField
```
public PdfCollectionField(String name,
                          int subType)
```
    Creates a PdfCollectionField.
    
    Parameters:
    
    name - the field name
    
    subType - the field subtype
- Method Detail
  - setOrder
```
public PdfCollectionField setOrder(int order)
```
    The relative order of the field name. Fields are sorted in ascending order.
    
    Parameters:
    
    order - a number indicating the order of the field
  - getOrder
```
public PdfNumber getOrder()
```
  - setVisibility
```
public PdfCollectionField setVisibility(boolean visible)
```
    Sets the initial visibility of the field.
    
    Parameters:
    
    visible -
  - getVisibility
```
public PdfBoolean getVisibility()
```
  - setEditable
```
public PdfCollectionField setEditable(boolean editable)
```
    Indication if the field value should be editable in the viewer.
    
    Parameters:
    
    editable -
  - getEditable
```
public PdfBoolean getEditable()
```
  - getValue
```
public PdfObject getValue(String value)
```
  - isWrappedObjectMustBeIndirect
```
protected boolean isWrappedObjectMustBeIndirect()
```
    Description copied from class: PdfObjectWrapper
    
    Defines if the object behind this wrapper must be an indirect object in the resultant document.
    
    If this method returns true it doesn't necessarily mean that object must be in the indirect state at any moment, but rather defines that when the object will be written to the document it will be transformed into indirect object if it's not indirect yet.
    
    Return value of this method shouldn't depend on any logic, it should return always true or false.
    
    Specified by:
    
    isWrappedObjectMustBeIndirect in class PdfObjectWrapper<PdfDictionary>
    
    Returns:
    
    true if in the resultant document the object behind the wrapper must be indirect, otherwise false.

Class PdfCollectionField

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.itextpdf.kernel.pdf.PdfObjectWrapper

Methods inherited from class java.lang.Object

Field Detail

TEXT

DATE

NUMBER

FILENAME

DESC

MODDATE

CREATIONDATE

SIZE

subType

Constructor Detail

PdfCollectionField

PdfCollectionField

Method Detail

setOrder

getOrder

setVisibility

getVisibility

setEditable

getEditable

getValue

isWrappedObjectMustBeIndirect