com.itextpdf.kernel.pdf.colorspace

Class PdfShading.FunctionBased

java.lang.Object

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

com.itextpdf.kernel.pdf.colorspace.PdfShading

com.itextpdf.kernel.pdf.colorspace.PdfShading.FunctionBased

All Implemented Interfaces:

Serializable

Enclosing class:

PdfShading

public static class PdfShading.FunctionBased
extends PdfShading

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.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.itextpdf.kernel.pdf.colorspace.PdfShading

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

Constructor Summary

Constructors

Constructor and Description
FunctionBased(PdfColorSpace colorSpace, PdfFunction function) Creates the new instance of the class.
FunctionBased(PdfDictionary pdfDictionary) Deprecated. Intended only for private use. You should use PdfShading.makeShading(PdfDictionary) instead.
FunctionBased(PdfObject colorSpace, PdfFunction function) Creates the new instance of the class.

Method Summary

Modifier and Type	Method and Description
PdfArray	getDomain() Gets the PdfArray domain rectangle object that establishes an internal coordinate space for the shading that is independent of the target coordinate space in which it shall be painted.
float[]	getMatrix() Gets the array of floats that represents the transformation matrix that maps the domain rectangle into a corresponding figure in the target coordinate space.
void	setDomain(float xmin, float xmax, float ymin, float ymax) Sets the PdfArray domain rectangle object that establishes an internal coordinate space for the shading that is independent of the target coordinate space in which it shall be painted.
void	setDomain(PdfArray domain) Sets the PdfArray domain rectangle object that establishes an internal coordinate space for the shading that is independent of the target coordinate space in which it shall be painted.
void	setMatrix(float[] matrix) Sets the array of floats that represents the transformation matrix that maps the domain rectangle into a corresponding figure in the target coordinate space.
void	setMatrix(PdfArray matrix) Sets the array of floats that represents the transformation matrix that maps the domain rectangle into a corresponding figure in the target coordinate space.

Methods inherited from class com.itextpdf.kernel.pdf.colorspace.PdfShading

flush, getColorSpace, getFunction, getShadingType, isWrappedObjectMustBeIndirect, makeShading, setFunction, setFunction

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

FunctionBased

@Deprecated
public FunctionBased(PdfDictionary pdfDictionary)

Deprecated. Intended only for private use. You should use PdfShading.makeShading(PdfDictionary) instead.

Creates the new instance of the class from the existing PdfDictionary object.

Parameters:

pdfDictionary - PdfDictionary from which the instance is created.

FunctionBased

public FunctionBased(PdfColorSpace colorSpace,
                     PdfFunction function)

Creates the new instance of the class.

Parameters:

colorSpace - the PdfColorSpace object in which colour values shall be expressed.

function - the PdfFunction, that is used to calculate color transitions.

FunctionBased

public FunctionBased(PdfObject colorSpace,
                     PdfFunction function)

Creates the new instance of the class.

Parameters:

colorSpace - the PdfObject, that represents color space in which colour values shall be expressed.

function - the PdfFunction, that is used to calculate color transitions.

Method Detail

getDomain

public PdfArray getDomain()

Gets the PdfArray domain rectangle object that establishes an internal coordinate space for the shading that is independent of the target coordinate space in which it shall be painted.

Returns:

PdfArray domain rectangle.

setDomain

public void setDomain(float xmin,
                      float xmax,
                      float ymin,
                      float ymax)

Sets the PdfArray domain rectangle object that establishes an internal coordinate space for the shading that is independent of the target coordinate space in which it shall be painted.

Parameters:

xmin - the Xmin coordinate of rectangle.

xmax - the Xmax coordinate of rectangle.

ymin - the Ymin coordinate of rectangle.

ymax - the Ymax coordinate of rectangle.

setDomain

public void setDomain(PdfArray domain)

Sets the PdfArray domain rectangle object that establishes an internal coordinate space for the shading that is independent of the target coordinate space in which it shall be painted.

Parameters:

domain - the PdfArray domain rectangle object to be set.

getMatrix

public float[] getMatrix()

Gets the array of floats that represents the transformation matrix that maps the domain rectangle into a corresponding figure in the target coordinate space.

Returns:

the float[] of transformation matrix (identical matrix by default).

setMatrix

public void setMatrix(float[] matrix)

Sets the array of floats that represents the transformation matrix that maps the domain rectangle into a corresponding figure in the target coordinate space.

Parameters:

matrix - the float[] of transformation matrix to be set.

setMatrix

public void setMatrix(PdfArray matrix)

Sets the array of floats that represents the transformation matrix that maps the domain rectangle into a corresponding figure in the target coordinate space.

Parameters:

matrix - the PdfArray transformation matrix object to be set.