org.apache.fop.pdf
Class PDFFilter
java.lang.Object
org.apache.fop.pdf.PDFFilter
public abstract class PDFFilter
extends java.lang.Object
PDF Filter class.
This represents a PDF filter object.
Filter implementations should extend this class.
- Eric SCHAEFFER, Kelly A. Campbell
abstract OutputStream | applyFilter(OutputStream out) - Applies a filter to an OutputStream.
|
abstract String | getDecodeParms() - return a parameter dictionary for this filter, or null
|
abstract String | getName() - return a PDF string representation of the filter, e.g.
|
boolean | isASCIIFilter() - Returns true if the filter is an ASCII filter that isn't necessary
when encryption is active.
|
boolean | isApplied() - Check if this filter has been applied.
|
void | setApplied(boolean b) - Set the applied attribute to the given value.
|
applyFilter
public abstract OutputStream applyFilter(OutputStream out)
throws IOException
Applies a filter to an OutputStream.
out
- contents to be filtered
- OutputStream filtered contents
getDecodeParms
public abstract String getDecodeParms()
return a parameter dictionary for this filter, or null
- the decode params for the filter
getName
public abstract String getName()
return a PDF string representation of the filter, e.g. /FlateDecode
isASCIIFilter
public boolean isASCIIFilter()
Returns true if the filter is an ASCII filter that isn't necessary
when encryption is active.
- boolean True if this filter is an ASCII filter
isApplied
public boolean isApplied()
Check if this filter has been applied.
- true if this filter has been applied
setApplied
public void setApplied(boolean b)
Set the applied attribute to the given value. This attribute is
used to determine if this filter is just a placeholder for the
decodeparms and dictionary entries, or if the filter needs to
actually encode the data. For example if the raw data is copied
out of an image file in it's compressed format, then this
should be set to true and the filter options should be set to
those which the raw data was encoded with.
b
- set the applied value to this
Copyright 1999-2007 The Apache Software Foundation. All Rights Reserved.