org.apache.pdfbox.pdmodel.graphics.shading
Class PDShadingType1

java.lang.Object
  extended by org.apache.pdfbox.pdmodel.graphics.shading.PDShadingResources
      extended by org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType1
All Implemented Interfaces:
COSObjectable

public class PDShadingType1
extends PDShadingResources

This represents resources for a function based shading.

Version:
$Revision: 1.0 $

Field Summary
 
Fields inherited from class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingResources
SHADING_TYPE1, SHADING_TYPE2, SHADING_TYPE3, SHADING_TYPE4, SHADING_TYPE5, SHADING_TYPE6, SHADING_TYPE7
 
Constructor Summary
PDShadingType1(COSDictionary shadingDictionary)
          Constructor using the given shading dictionary.
 
Method Summary
 COSArray getDomain()
          This will get the optional Domain values of a function based shading.
 PDFunction getFunction()
          This will return the function used to convert the color values.
 Matrix getMatrix()
          This will get the optional Matrix of a function based shading.
 int getShadingType()
          This will return the shading type.
 void setDomain(COSArray newDomain)
          Sets the optional Domain entry for the function based shading.
 void setFunction(PDFunction newFunction)
          This will set the function for the color conversion.
 void setMatrix(java.awt.geom.AffineTransform transform)
          Sets the optional Matrix entry for the function based shading.
 
Methods inherited from class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingResources
create, getAntiAlias, getBackground, getBBox, getColorSpace, getCOSDictionary, getCOSObject, getType, setAntiAlias, setBackground, setBBox, setColorSpace, setShadingType
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PDShadingType1

public PDShadingType1(COSDictionary shadingDictionary)
Constructor using the given shading dictionary.

Parameters:
shadingDictionary - The dictionary for this shading.
Method Detail

getShadingType

public int getShadingType()
This will return the shading type.

Specified by:
getShadingType in class PDShadingResources
Returns:
The shading type

getMatrix

public Matrix getMatrix()
This will get the optional Matrix of a function based shading.

Returns:
the matrix

setMatrix

public void setMatrix(java.awt.geom.AffineTransform transform)
Sets the optional Matrix entry for the function based shading.

Parameters:
transform - the transformation matrix

getDomain

public COSArray getDomain()
This will get the optional Domain values of a function based shading.

Returns:
the domain values

setDomain

public void setDomain(COSArray newDomain)
Sets the optional Domain entry for the function based shading.

Parameters:
newDomain - the domain array

setFunction

public void setFunction(PDFunction newFunction)
This will set the function for the color conversion.

Parameters:
newFunction - The new function.

getFunction

public PDFunction getFunction()
                       throws java.io.IOException
This will return the function used to convert the color values.

Returns:
The function
Throws:
java.io.IOException - If we are unable to create the PDFunction object.