Home » pdfbox-1.1.0-src » org.apache.pdfbox.pdmodel.graphics » [javadoc | source]
org.apache.pdfbox.pdmodel.graphics
public class: PDShading [javadoc | source]
java.lang.Object
   org.apache.pdfbox.pdmodel.graphics.PDShading

All Implemented Interfaces:
    COSObjectable

This class represents a Shading Pattern color space. See section 4.6.3 of the PDF 1.7 specification.
Field Summary
public static final  String NAME    The name of this object. 
Constructor:
 public PDShading() 
 public PDShading(COSName name,
    COSDictionary shading) 
    Constructor.
    Parameters:
    shading - The shading dictionary.
Method from org.apache.pdfbox.pdmodel.graphics.PDShading Summary:
getAntiAlias,   getCOSObject,   getColorSpace,   getCoords,   getDomain,   getExtend,   getFunction,   getName,   getShadingName,   getShadingType,   toString
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.pdfbox.pdmodel.graphics.PDShading Detail:
 public boolean getAntiAlias() 
    This will return a boolean flag indicating whether to antialias the shading pattern.
 public COSBase getCOSObject() 
    Convert this standard java object to a COS object.
 public PDColorSpace getColorSpace() throws IOException 
    This will return the Color Space. Required in all Shading Dictionaries.
 public COSArray getCoords() 
    Returns the coordinate array used by several of the gradient types. Interpretation depends on the ShadingType.
 public COSArray getDomain() 
    Returns the Domain array used by several of the gradient types. Interpretation depends on the ShadingType.
 public COSArray getExtend() 
    Returns the Extend array used by several of the gradient types. Interpretation depends on the ShadingType. Default is {false, false}.
 public PDFunction getFunction() throws IOException 
    Returns the function used by several of the gradient types. Interpretation depends on the ShadingType.
 public String getName() 
    This will return the name of the object.
 public COSName getShadingName() 
    This will return the name of this particular shading dictionary
 public int getShadingType() 
    This will return the ShadingType -- an integer between 1 and 7 that specifies the gradient type. Required in all Shading Dictionaries.
 public String toString() 
    {@inheritDoc}