Top Description Fields Constructors Methods
org.apache.pdfbox.pdmodel.graphics.shading

public Class PDShadingType1

extends PDShading
Class Inheritance
Imports
java.awt.Paint, java.awt.geom.AffineTransform, org.apache.pdfbox.cos.COSArray, .COSDictionary, .COSFloat, .COSName, org.apache.pdfbox.util.Matrix
Resources for a function based shading.

Field Summary

Modifier and TypeField and Description
private COSArray
domain

Inherited from org.apache.pdfbox.pdmodel.graphics.shading.PDShading:
SHADING_TYPE1SHADING_TYPE2SHADING_TYPE3SHADING_TYPE4SHADING_TYPE5SHADING_TYPE6SHADING_TYPE7

Constructor Summary

AccessConstructor and Description
public
PDShadingType1(COSDictionary
the dictionary for this shading
shadingDictionary)

Constructor using the given shading dictionary.

Method Summary

Modifier and TypeMethod and Description
public COSArray

Returns:

the domain values
getDomain()

This will get the optional Domain values of a function based shading.

public Matrix

Returns:

the matrix
getMatrix()

This will get the optional Matrix of a function based shading.

public int
getShadingType()

Implements abstract org.apache.pdfbox.pdmodel.graphics.shading.PDShading.getShadingType.

This will return the shading type.

public void
setDomain(COSArray
the domain array
newDomain)

Sets the optional Domain entry for the function based shading.

public void
setMatrix(AffineTransform
the transformation matrix
transform)

Sets the optional Matrix entry for the function based shading.

public Paint
toPaint(Matrix
the pattern matrix concatenated with that of the parent content stream, this matrix which maps the pattern's internal coordinate system to user space
matrix)

Implements abstract org.apache.pdfbox.pdmodel.graphics.shading.PDShading.toPaint.

Returns an AWT paint which corresponds to this shading

Inherited from org.apache.pdfbox.pdmodel.graphics.shading.PDShading:
createevalFunctionevalFunctiongetAntiAliasgetBackgroundgetBBoxgetBoundsgetColorSpacegetCOSObjectgetFunctiongetTypesetAntiAliassetBackgroundsetBBoxsetColorSpacesetFunctionsetFunctionsetShadingType

Field Detail

domainback to summary
private COSArray domain

Constructor Detail

PDShadingType1back to summary
public PDShadingType1(COSDictionary shadingDictionary)

Constructor using the given shading dictionary.

Parameters
shadingDictionary:COSDictionary

the dictionary for this shading

Method Detail

getDomainback to summary
public COSArray getDomain()

This will get the optional Domain values of a function based shading.

Returns:COSArray

the domain values

getMatrixback to summary
public Matrix getMatrix()

This will get the optional Matrix of a function based shading.

Returns:Matrix

the matrix

getShadingTypeback to summary
public int getShadingType()

Implements abstract org.apache.pdfbox.pdmodel.graphics.shading.PDShading.getShadingType.

Doc from org.apache.pdfbox.pdmodel.graphics.shading.PDShading.getShadingType.

This will return the shading type.

Returns:int

the shading typ

Annotations
@Override
setDomainback to summary
public void setDomain(COSArray newDomain)

Sets the optional Domain entry for the function based shading.

Parameters
newDomain:COSArray

the domain array

setMatrixback to summary
public void setMatrix(AffineTransform transform)

Sets the optional Matrix entry for the function based shading.

Parameters
transform:AffineTransform

the transformation matrix

toPaintback to summary
public Paint toPaint(Matrix matrix)

Implements abstract org.apache.pdfbox.pdmodel.graphics.shading.PDShading.toPaint.

Doc from org.apache.pdfbox.pdmodel.graphics.shading.PDShading.toPaint.

Returns an AWT paint which corresponds to this shading

Parameters
matrix:Matrix

the pattern matrix concatenated with that of the parent content stream, this matrix which maps the pattern's internal coordinate system to user space

Returns:Paint

an AWT Paint instance

Annotations
@Override