com.itextpdf.kernel.pdf.colorspace

Class PdfShading.Axial

java.lang.Object

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

com.itextpdf.kernel.pdf.colorspace.PdfShading

com.itextpdf.kernel.pdf.colorspace.PdfShading.Axial

All Implemented Interfaces:

Serializable

Enclosing class:

PdfShading

public static class PdfShading.Axial
extends PdfShading

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.

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
Axial(PdfColorSpace cs, float x0, float y0, float[] color0, float x1, float y1, float[] color1) Creates the new instance of the class.
Axial(PdfColorSpace cs, float x0, float y0, float[] color0, float x1, float y1, float[] color1, boolean[] extend) Creates the new instance of the class.
Axial(PdfColorSpace cs, PdfArray coords, PdfFunction function) Creates the new instance of the class.
Axial(PdfDictionary pdfDictionary) Deprecated. Intended only for private use. You should use PdfShading.makeShading(PdfDictionary) instead.

Method Summary

Modifier and Type	Method and Description
PdfArray	getCoords() Gets the Coords object - a PdfArray of four numbers [x0 y0 x1 y1] that specified the starting and the endings coordinates of thew axis, expressed in the shading's target coordinate space.
float[]	getDomain() Gets 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).
boolean[]	getExtend() Gets the array of two boolean that specified whether to extend the shading beyond the starting and ending points of the axis, respectively.
void	setCoords(float x0, float y0, float x1, float y1) Sets the Choords object with the four params expressed in the shading's target coordinate space.
void	setCoords(PdfArray coords) Sets the Choords object with the PdfArray of four numbers [x0 y0 x1 y1], 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	setExtend(boolean extendStart, boolean extendEnd) Sets the Extend object with the two boolean value.

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

Axial

@Deprecated
public Axial(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.

Axial

public Axial(PdfColorSpace cs,
             float x0,
             float y0,
             float[] color0,
             float x1,
             float y1,
             float[] color1)

Creates the new instance of the class.

Parameters:

cs - the PdfColorSpace object in which colour values shall be expressed. The special Pattern space isn't excepted.

x0 - the start coordinate of X axis expressed in the shading's target coordinate space.

y0 - the start coordinate of Y axis expressed in the shading's target coordinate space.

color0 - the float[] that represents the color in the start point.

x1 - the end coordinate of X axis expressed in the shading's target coordinate space.

y1 - the end coordinate of Y axis expressed in the shading's target coordinate space.

color1 - the float[] that represents the color in the end point.

Axial

public Axial(PdfColorSpace cs,
             float x0,
             float y0,
             float[] color0,
             float x1,
             float y1,
             float[] color1,
             boolean[] extend)

Creates the new instance of the class.

Parameters:

cs - the PdfColorSpace object in which colour values shall be expressed. The special Pattern space isn't excepted.

x0 - the start coordinate of X axis expressed in the shading's target coordinate space.

y0 - the start coordinate of Y axis expressed in the shading's target coordinate space.

color0 - the float[] that represents the color in the start point.

x1 - the end coordinate of X axis expressed in the shading's target coordinate space.

y1 - the end coordinate of Y axis expressed in the shading's target coordinate space.

color1 - the float[] that represents the color in the end point.

extend - the array of two booleans that specified whether to extend the shading beyond the starting and ending points of the axis, respectively.

Axial

public Axial(PdfColorSpace cs,
             PdfArray coords,
             PdfFunction function)

Creates the new instance of the class.

Parameters:

cs - the PdfColorSpace object in which colour values shall be expressed. The special Pattern space isn't excepted.

coords - the PdfArray of four number four numbers [x0 y0 x1 y1] that specified the starting and the endings coordinates of thew axis, expressed in the shading's target coordinate space.

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

Method Detail

getCoords

public PdfArray getCoords()

Gets the Coords object - a PdfArray of four numbers [x0 y0 x1 y1] that specified the starting and the endings coordinates of thew axis, expressed in the shading's target coordinate space.

Returns:

the PdfArray Coords object.

setCoords

public void setCoords(float x0,
                      float y0,
                      float x1,
                      float y1)

Sets the Choords object with the four params expressed in the shading's target coordinate space.

Parameters:

x0 - the start coordinate of X axis to be set.

y0 - the start coordinate of Y axis to be set.

x1 - the end coordinate of X axis to be set.

y1 - the end coordinate of Y axis to be set.

setCoords

public void setCoords(PdfArray coords)

Sets the Choords object with the PdfArray of four numbers [x0 y0 x1 y1], 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 float[] getDomain()

Gets 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).

Returns:

float[] of Domain object ([0.0 1.0] by default)

setDomain

public 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

getExtend

public boolean[] getExtend()

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

Returns:

boolean[] of Extended object ([false false] by default)

setExtend

public 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