Package com.itextpdf.kernel.pdf.colorspace

Class PdfShading

java.lang.Object

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

com.itextpdf.kernel.pdf.colorspace.PdfShading

Direct Known Subclasses:

PdfShading.Axial, PdfShading.CoonsPatchMesh, PdfShading.FreeFormGouraudShadedTriangleMesh, PdfShading.FunctionBased, PdfShading.LatticeFormGouraudShadedTriangleMesh, PdfShading.Radial, PdfShading.TensorProductPatchMesh

 public abstract class PdfShading extends PdfObjectWrapper<PdfDictionary> 
      

The abstract PdfShading class that represents the Shading Dictionary PDF object.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PdfShading.Axial	The class that extends PdfShading class and is in charge of Shading Dictionary with axial type, that define a colour blend that varies along a linear axis between two endpoints and extends indefinitely perpendicular to that axis.
static class	PdfShading.CoonsPatchMesh	The class that extends PdfShading class and is in charge of Shading Dictionary with Coons Patch mesh type.
static class	PdfShading.FreeFormGouraudShadedTriangleMesh	The class that extends PdfShading class and is in charge of Shading Dictionary with free-form Gouraud-shaded triangle mesh type.
static class	PdfShading.FunctionBased	The class that extends PdfShading class and is in charge of Shading Dictionary with function-based type, that defines color at every point in the domain by a specified mathematical function.
static class	PdfShading.LatticeFormGouraudShadedTriangleMesh	The class that extends PdfShading class and is in charge of Shading Dictionary with lattice-form Gouraud-shaded triangle mesh type.
static class	PdfShading.Radial	The class that extends PdfShading class and is in charge of Shading Dictionary with radial type, that define a colour blend that varies between two circles.
static class	PdfShading.TensorProductPatchMesh	The class that extends PdfShading class and is in charge of Shading Dictionary with Tensor-Product Patch mesh type.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PdfShading(PdfDictionary pdfObject)	Creates the PdfShading object from the existing PdfDictionary.
protected	PdfShading(PdfDictionary pdfObject, int type, PdfColorSpace colorSpace)	Creates the PdfShading object from the existing PdfDictionary, using provided type and colorspace.

Method Summary

Modifier and Type	Method	Description
void	flush()	To manually flush a PdfObject behind this wrapper, you have to ensure that this object is added to the document, i.e.
PdfObject	getColorSpace()	Gets the color space in which colour values shall be expressed.
PdfObject	getFunction()	Gets the function PdfObject that represents color transitions across the shading geometry.
int	getShadingType()	Gets the shading type.
protected boolean	isWrappedObjectMustBeIndirect()	Defines if the object behind this wrapper must be an indirect object in the resultant document.
static PdfShading	makeShading(PdfDictionary shadingDictionary)	Creates the PdfShading object from the existing PdfDictionary with corresponding type.
void	setFunction(PdfFunction function)	Sets the function that represents color transitions across the shading geometry as one object.
void	setFunction(PdfFunction[] functions)	Sets the function object that represents color transitions across the shading geometry as an array of functions.

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 Details

PdfShading

 protected PdfShading 
             (PdfDictionary pdfObject) 
            

Creates the PdfShading object from the existing PdfDictionary.

Parameters:

pdfObject - PdfDictionary from which the PdfShading object will be created.

PdfShading

 protected PdfShading 
             (PdfDictionary pdfObject, int type, PdfColorSpace colorSpace) 
            

Creates the PdfShading object from the existing PdfDictionary, using provided type and colorspace.

Parameters:

pdfObject - PdfDictionary from which the PdfShading object will be created.

type - type with which this PdfShading object will be created.

colorSpace - PdfColorSpace with which this PdfShading object will be created.

Method Details

makeShading

 public static PdfShading makeShading 
             (PdfDictionary shadingDictionary) 
            

Creates the PdfShading object from the existing PdfDictionary with corresponding type.

Parameters:

shadingDictionary - PdfDictionary from which the PdfShading object will be created.

Returns:

Created PdfShading object.

getShadingType

 public int getShadingType() 
            

Gets the shading type.

Returns:

int value of PdfName.ShadingType.

getColorSpace

 public PdfObject getColorSpace() 
            

Gets the color space in which colour values shall be expressed.

Returns:

PdfObject Color space

getFunction

 public PdfObject getFunction() 
            

Gets the function PdfObject that represents color transitions across the shading geometry.

Returns:

PdfObject Function

setFunction

 public void setFunction 
             (PdfFunction function) 
            

Sets the function that represents color transitions across the shading geometry as one object.

Parameters:

function - The PdfFunction to set.

setFunction

 public void setFunction 
             (PdfFunction[] functions) 
            

Sets the function object that represents color transitions across the shading geometry as an array of functions.

Parameters:

functions - The array of PdfFunction to be set.

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

isWrappedObjectMustBeIndirect

 protected boolean isWrappedObjectMustBeIndirect() 
            

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.