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

public Class PDShadingType2

extends PDShading
Class Inheritance
Known Direct Subclasses
org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType3
Imports
java.awt.Paint, org.apache.pdfbox.cos.COSArray, .COSDictionary, .COSName, org.apache.pdfbox.util.Matrix
Resources for an axial shading.

Field Summary

Modifier and TypeField and Description
private COSArray
coords

private COSArray
domain

private COSArray
extend

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

Constructor Summary

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

Constructor using the given shading dictionary.

Method Summary

Modifier and TypeMethod and Description
public COSArray

Returns:

the coordinate values
getCoords()

This will get the Coords values for this shading.

public COSArray

Returns:

the domain values
getDomain()

This will get the optional Domain values for this shading.

public COSArray

Returns:

the extend values
getExtend()

This will get the optional Extend values for this shading.

public int
getShadingType()

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

This will return the shading type.

public void
setCoords(COSArray
the coordinates array
newCoords)

Sets the Coords entry for this shading.

public void
setDomain(COSArray
the domain array
newDomain)

Sets the optional Domain entry for this shading.

public void
setExtend(COSArray
the extend array
newExtend)

Sets the optional Extend entry for this 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

coordsback to summary
private COSArray coords
domainback to summary
private COSArray domain
extendback to summary
private COSArray extend

Constructor Detail

PDShadingType2back to summary
public PDShadingType2(COSDictionary shadingDictionary)

Constructor using the given shading dictionary.

Parameters
shadingDictionary:COSDictionary

the dictionary for this shading

Method Detail

getCoordsback to summary
public COSArray getCoords()

This will get the Coords values for this shading.

Returns:COSArray

the coordinate values

getDomainback to summary
public COSArray getDomain()

This will get the optional Domain values for this shading.

Returns:COSArray

the domain values

getExtendback to summary
public COSArray getExtend()

This will get the optional Extend values for this shading.

Returns:COSArray

the extend values

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
setCoordsback to summary
public void setCoords(COSArray newCoords)

Sets the Coords entry for this shading.

Parameters
newCoords:COSArray

the coordinates array

setDomainback to summary
public void setDomain(COSArray newDomain)

Sets the optional Domain entry for this shading.

Parameters
newDomain:COSArray

the domain array

setExtendback to summary
public void setExtend(COSArray newExtend)

Sets the optional Extend entry for this shading.

Parameters
newExtend:COSArray

the extend array

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