org.pdfbox.pdmodel.common.function
Class PDFunction
java.lang.Object
org.pdfbox.pdmodel.common.function.PDFunction
- COSObjectable
public abstract class PDFunction
extends java.lang.Object
This class represents a function in a PDF document.
create
public static PDFunction create(COSBase function)
throws IOException
Create the correct PD Model function based on the COS base function.
function
- The COS function dictionary.
- The PDModel Function object.
getDomainForInput
public abstract 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.
n
- The parameter number to get the domain for.
- The domain range for this component.
getNumberOfInputParameters
public abstract int getNumberOfInputParameters()
This will get the number of input parameters that
have a domain specified.
- The number of input parameters that have a domain
specified.
getNumberOfOutputParameters
public abstract 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.
- The number of input parameters that have a range
specified.
getRangeForOutput
public abstract 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.
n
- The output parameter number to get the range for.
- The range for this component.
setDomainForInput
public abstract void setDomainForInput(PDRange range,
int n)
This will set the domain for the input values.
range
- The new range for the input.n
- The number of the input parameter to set the domain for.
setRangeForOutput
public abstract void setRangeForOutput(PDRange range,
int n)
This will set the a range for output parameter.
range
- The new range for the output parameter.n
- The ouput parameter number to set the range for.