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

java.lang.Object
  extended by org.apache.pdfbox.pdmodel.graphics.shading.PDShadingResources
      extended by org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType2
All Implemented Interfaces:
COSObjectable
Direct Known Subclasses:
PDShadingType3

public class PDShadingType2
extends PDShadingResources

This represents resources for an axial 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
PDShadingType2(COSDictionary shadingDictionary)
          Constructor using the given shading dictionary.
 
Method Summary
 COSArray getCoords()
          This will get the Coords values for this shading.
 COSArray getDomain()
          This will get the optional Domain values for this shading.
 COSArray getExtend()
          This will get the optional Extend values for this shading.
 PDFunction getFunction()
          This will return the function used to convert the color values.
 int getShadingType()
          This will return the shading type.
 void setCoords(COSArray newCoords)
          Sets the Coords entry for this shading.
 void setDomain(COSArray newDomain)
          Sets the optional Domain entry for this shading.
 void setExtend(COSArray newExtend)
          Sets the optional Extend entry for this shading.
 void setFunction(PDFunction newFunction)
          This will set the function for the color conversion.
 
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

PDShadingType2

public PDShadingType2(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

getExtend

public COSArray getExtend()
This will get the optional Extend values for this shading.

Returns:
the extend values

setExtend

public void setExtend(COSArray newExtend)
Sets the optional Extend entry for this shading.

Parameters:
newExtend - the extend array

getDomain

public COSArray getDomain()
This will get the optional Domain values for this shading.

Returns:
the domain values

setDomain

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

Parameters:
newDomain - the domain array

getCoords

public COSArray getCoords()
This will get the Coords values for this shading.

Returns:
the coords values

setCoords

public void setCoords(COSArray newCoords)
Sets the Coords entry for this shading.

Parameters:
newCoords - the coords 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 IOException
This will return the function used to convert the color values.

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