Overview Package Class Use Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.pdfbox.pdmodel.common.function

Class PDDictionaryFunction

Implemented Interfaces:
COSObjectable
Known Direct Subclasses:
PDFunctionType2, PDFunctionType3
public abstract class PDDictionaryFunction
extends PDFunction
This class represents a function in a PDF document.
Version:
$Revision: 1.3 $
Author:
Ben Litchfield

Constructor Summary

PDDictionaryFunction(int functionType)
Constructor to create a new blank function, should only be called by subclasses.
PDDictionaryFunction(COSDictionary functionDictionary)
Constructor.

Method Summary

COSDictionary
getCOSDictionary()
Get the underlying cos dictionary.
COSBase
getCOSObject()
PDRange
getDomainForInput(int n)
int
getNumberOfInputParameters()
int
getNumberOfOutputParameters()
PDRange
getRangeForOutput(int n)
void
setDomainForInput(PDRange range, int n)
void
setRangeForOutput(PDRange range, int n)

Methods inherited from class org.pdfbox.pdmodel.common.function.PDFunction

create, getDomainForInput, getNumberOfInputParameters, getNumberOfOutputParameters, getRangeForOutput, setDomainForInput, setRangeForOutput

Constructor Details

PDDictionaryFunction

protected PDDictionaryFunction(int functionType)
Constructor to create a new blank function, should only be called by subclasses.
Parameters:
functionType - An integer describing the function type, only 0,2,3,4 are defined by the PDF sepc.

PDDictionaryFunction

public PDDictionaryFunction(COSDictionary functionDictionary)
Constructor.
Parameters:
functionDictionary - The prepopulated function dictionary.

Method Details

getCOSDictionary

public COSDictionary getCOSDictionary()
Get the underlying cos dictionary.
Returns:
The underlying cos dictionary.

getCOSObject

public COSBase getCOSObject()
Specified by:
getCOSObject in interface COSObjectable

getDomainForInput

public PDRange getDomainForInput(int n)
Overrides:
getDomainForInput in interface PDFunction

getNumberOfInputParameters

public int getNumberOfInputParameters()
Overrides:
getNumberOfInputParameters in interface PDFunction

getNumberOfOutputParameters

public int getNumberOfOutputParameters()
Overrides:
getNumberOfOutputParameters in interface PDFunction

getRangeForOutput

public PDRange getRangeForOutput(int n)
Overrides:
getRangeForOutput in interface PDFunction

setDomainForInput

public void setDomainForInput(PDRange range,
                              int n)
Overrides:
setDomainForInput in interface PDFunction

setRangeForOutput

public void setRangeForOutput(PDRange range,
                              int n)
Overrides:
setRangeForOutput in interface PDFunction

Overview Package Class Use Tree Index Deprecated About