Package com.itextpdf.kernel.pdf.colorspace.shading

Class AbstractPdfShadingBlend

java.lang.Object

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

com.itextpdf.kernel.pdf.colorspace.shading.AbstractPdfShading

com.itextpdf.kernel.pdf.colorspace.shading.AbstractPdfShadingBlend

Direct Known Subclasses:

PdfAxialShading, PdfRadialShading

public abstract class AbstractPdfShadingBlend
extends AbstractPdfShading

The PdfShadingBlend class which extends AbstractPdfShading and represents shadings which are based on a blend, with Coords, Domain and Extend fields in the PDF object.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractPdfShadingBlend(PdfDictionary pdfObject)	Constructor for PdfShadingBlend object using a PdfDictionary.
protected	AbstractPdfShadingBlend(PdfDictionary pdfObject, int shadingType, PdfColorSpace cs)	Constructor for PdfShadingBlend object using PdfDictionary, shading type and colorspace value.

Method Summary

Modifier and Type	Method	Description
PdfArray	getCoords()	Gets the coords PdfArray object.
PdfArray	getDomain()	Gets the PdfArray of two float [t0, t1] that represent the limiting values of a parametric variable t, that becomes an input of color function(s).
PdfArray	getExtend()	Gets the PdfArray of two boolean that specified whether to extend the shading beyond the starting and ending points of the axis, respectively.
void	setCoords(PdfArray coords)	Sets the Coords object with the PdfArray, that specified the starting and the endings coordinates of thew axis, expressed in the shading's target coordinate space.
void	setDomain(float t0, float t1)	Sets the Domain with the array of two float [t0, t1] that represent the limiting values of a parametric variable t, that becomes an input of color function(s).
void	setDomain(PdfArray domain)	Sets the Domain with the PdfArray of two float [t0, t1] that represent the limiting values of a parametric variable t, that becomes an input of color function(s).
void	setExtend(boolean extendStart, boolean extendEnd)	Sets the Extend object with the two boolean value.
void	setExtend(PdfArray extend)	Sets the Extend object with the PdfArray of two boolean.

Methods inherited from class com.itextpdf.kernel.pdf.colorspace.shading.AbstractPdfShading

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

AbstractPdfShadingBlend

protected AbstractPdfShadingBlend(PdfDictionary pdfObject)

Constructor for PdfShadingBlend object using a PdfDictionary.

Parameters:

pdfObject - input PdfDictionary

AbstractPdfShadingBlend

protected AbstractPdfShadingBlend(PdfDictionary pdfObject,
                                  int shadingType,
                                  PdfColorSpace cs)

Constructor for PdfShadingBlend object using PdfDictionary, shading type and colorspace value.

Parameters:

pdfObject - input PdfDictionary

shadingType - shading type

cs - color space

Method Detail

getCoords

public PdfArray getCoords()

Gets the coords PdfArray object.

Returns:

the PdfArray coords object

setCoords

public final void setCoords(PdfArray coords)

Sets the Coords object with the PdfArray, that specified the starting and the endings coordinates of thew axis, expressed in the shading's target coordinate space.

Parameters:

coords - the Chords PdfArray to be set

getDomain

public PdfArray getDomain()

Gets the PdfArray of two float [t0, t1] that represent the limiting values of a parametric variable t, that becomes an input of color function(s).

Returns:

the PdfArray of Domain object ([0.0 1.0] by default)

setDomain

public final void setDomain(float t0,
                            float t1)

Sets the Domain with the array of two float [t0, t1] that represent the limiting values of a parametric variable t, that becomes an input of color function(s).

Parameters:

t0 - first limit of variable t

t1 - second limit of variable t

setDomain

public final void setDomain(PdfArray domain)

Sets the Domain with the PdfArray of two float [t0, t1] that represent the limiting values of a parametric variable t, that becomes an input of color function(s).

Parameters:

domain - the PdfArray that represents domain

getExtend

public PdfArray getExtend()

Gets the PdfArray of two boolean that specified whether to extend the shading beyond the starting and ending points of the axis, respectively.

Returns:

the PdfArray of Extended object ([false false] by default)

setExtend

public final void setExtend(boolean extendStart,
                            boolean extendEnd)

Sets the Extend object with the two boolean value.

Parameters:

extendStart - if true will extend shading beyond the starting point of Coords

extendEnd - if true will extend shading beyond the ending point of Coords

setExtend

public final void setExtend(PdfArray extend)

Sets the Extend object with the PdfArray of two boolean. If first is true shading will extend beyond the starting point of Coords. If second is true shading will extend beyond the ending point of Coords.

Parameters:

extend - the PdfArray representing Extend object