Home » pdfbox-1.1.0-src » org.apache.pdfbox.pdmodel.common.function » [javadoc | source]
org.apache.pdfbox.pdmodel.common.function
abstract public class: PDStreamFunction [javadoc | source]
java.lang.Object
   org.apache.pdfbox.pdmodel.common.function.PDFunction
      org.apache.pdfbox.pdmodel.common.function.PDStreamFunction

All Implemented Interfaces:
    COSObjectable

Direct Known Subclasses:
    PDFunctionType4, PDFunctionType0

This class represents a function in a PDF document.
Constructor:
 public PDStreamFunction(PDStream functionDictionary) 
    Constructor.
    Parameters:
    functionDictionary - The prepopulated function dictionary.
 protected PDStreamFunction(PDDocument doc,
    int functionType) 
    Constructor to create a new blank function, should only be called by subclasses.
    Parameters:
    doc - The document that this function is part of.
    functionType - An integer describing the function type, only 0,2,3,4 are defined by the PDF sepc.
Method from org.apache.pdfbox.pdmodel.common.function.PDStreamFunction Summary:
getCOSObject,   getCOSStream,   getDomainForInput,   getNumberOfInputParameters,   getNumberOfOutputParameters,   getRangeForOutput,   setDomainForInput,   setRangeForOutput
Methods from org.apache.pdfbox.pdmodel.common.function.PDFunction:
Eval,   create,   getDomainForInput,   getNumberOfInputParameters,   getNumberOfOutputParameters,   getRangeForOutput,   setDomainForInput,   setRangeForOutput
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.pdfbox.pdmodel.common.function.PDStreamFunction Detail:
 public COSBase getCOSObject() 
    Convert this standard java object to a COS object.
 public COSStream getCOSStream() 
    This will get the underlying array value.
 public PDRange getDomainForInput(int n) 
    This will get the range for a certain input parameter. This is will never return null. If it is not present then the range 0 to 0 will be returned.
 public int getNumberOfInputParameters() 
    This will get the number of input parameters that have a domain specified.
 public int getNumberOfOutputParameters() 
    This will get the number of output parameters that have a range specified. A range for output parameters is optional so this may return zero for a function that does have output parameters, this will simply return the number that have the rnage specified.
 public PDRange getRangeForOutput(int n) 
    This will get the range for a certain output parameters. This is will never return null. If it is not present then the range 0 to 0 will be returned.
 public  void setDomainForInput(PDRange range,
    int n) 
    This will set the domain for the input values.
 public  void setRangeForOutput(PDRange range,
    int n) 
    This will set the a range for output parameter.