Package com.itextpdf.kernel.pdf.collection

Class PdfCollectionSchema

java.lang.Object

com.itextpdf.kernel.pdf.PdfObjectWrapper<PdfDictionary>

com.itextpdf.kernel.pdf.collection.PdfCollectionSchema

 public class PdfCollectionSchema extends PdfObjectWrapper<PdfDictionary> 
      

Constructor Summary

Constructors

Constructor	Description
PdfCollectionSchema()	Creates a Collection Schema dictionary.
PdfCollectionSchema(PdfDictionary pdfObject)

Method Summary

Modifier and Type	Method	Description
PdfCollectionSchema	addField(String name, PdfCollectionField field)	Adds a Collection field to the Schema.
PdfCollectionField	getField(String name)	Retrieves a Collection field from the Schema.
protected boolean	isWrappedObjectMustBeIndirect()	Defines if the object behind this wrapper must be an indirect object in the resultant document.

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

Constructor Details

PdfCollectionSchema

 public PdfCollectionSchema 
             (PdfDictionary pdfObject) 
            

PdfCollectionSchema

 public PdfCollectionSchema() 
            

Creates a Collection Schema dictionary.

Method Details

addField

 public PdfCollectionSchema addField 
             (String name, PdfCollectionField field) 
            

Adds a Collection field to the Schema.

Parameters:

name - the name of the collection field

field - a Collection Field

Returns:

this instance to support fluent interface

getField

 public PdfCollectionField getField 
             (String name) 
            

Retrieves a Collection field from the Schema.

Parameters:

name - is the name of the collection field

Returns:

a Collection field

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.