com.itextpdf.kernel.pdf.function

Class PdfFunction

java.lang.Object

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

com.itextpdf.kernel.pdf.function.PdfFunction

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

PdfFunction.Type0, PdfFunction.Type2, PdfFunction.Type3, PdfFunction.Type4

public class PdfFunction
extends PdfObjectWrapper<PdfObject>

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PdfFunction.Type0
static class	PdfFunction.Type2
static class	PdfFunction.Type3
static class	PdfFunction.Type4

Constructor Summary

Constructors

Constructor and Description
PdfFunction(PdfObject pdfObject)

Method Summary

Modifier and Type	Method and Description
boolean	checkCompatibilityWithColorSpace(PdfColorSpace alternateSpace)
void	flush() To manually flush a PdfObject behind this wrapper, you have to ensure that this object is added to the document, i.e.
int	getInputSize()
int	getOutputSize()
int	getType()
protected boolean	isWrappedObjectMustBeIndirect() Defines if the object behind this wrapper must be an indirect object in the resultant document.
static PdfFunction	makeFunction(PdfDictionary pdfObject)

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

ensureObjectIsAddedToDocument, ensureUnderlyingObjectHasIndirectReference, 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 Detail

PdfFunction

public PdfFunction(PdfObject pdfObject)

Method Detail

getType

public int getType()

checkCompatibilityWithColorSpace

public boolean checkCompatibilityWithColorSpace(PdfColorSpace alternateSpace)

getInputSize

public int getInputSize()

getOutputSize

public int getOutputSize()

flush

public void flush()

To manually flush a PdfObject behind this wrapper, you have to ensure that this object is added to the document, i.e. it has an indirect reference. Basically this means that before flushing you need to explicitly call PdfObjectWrapper.makeIndirect(PdfDocument). For example: wrapperInstance.makeIndirect(document).flush(); Note that not every wrapper require this, only those that have such warning in documentation.

Overrides:

flush in class PdfObjectWrapper<PdfObject>

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<PdfObject>

Returns:

true if in the resultant document the object behind the wrapper must be indirect, otherwise false.

makeFunction

public static PdfFunction makeFunction(PdfDictionary pdfObject)