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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PdfCollectionSchema
addField(java.lang.String name, PdfCollectionField field)
Adds a Collection field to the Schema.PdfCollectionField
getField(java.lang.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
-
-
-
-
Constructor Detail
-
PdfCollectionSchema
public PdfCollectionSchema(PdfDictionary pdfObject)
-
PdfCollectionSchema
public PdfCollectionSchema()
Creates a Collection Schema dictionary.
-
-
Method Detail
-
addField
public PdfCollectionSchema addField(java.lang.String name, PdfCollectionField field)
Adds a Collection field to the Schema.- Parameters:
name
- the name of the collection fieldfield
- a Collection Field- Returns:
- this instance to support fluent interface
-
getField
public PdfCollectionField getField(java.lang.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 classPdfObjectWrapper<PdfDictionary>
- Returns:
- true if in the resultant document the object behind the wrapper must be indirect, otherwise false.
-
-