From: arved Date: Tue, 30 Jan 2001 03:11:42 +0000 (+0000) Subject: PDF package HTML X-Git-Tag: fop-0_17_0~59 X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=80701b92f4ab10912206e41d36c4fa3a2aa289a0;p=xmlgraphics-fop.git PDF package HTML git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@194002 13f79535-47bb-0310-9956-ffa450edef68 --- diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/ASCII85Filter.html b/docs/design/contrib/pdf/org/apache/fop/pdf/ASCII85Filter.html new file mode 100755 index 000000000..5472cdeb9 --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/ASCII85Filter.html @@ -0,0 +1,4 @@ +

org.apache.fop.pdf
Class ASCII85Filter

org.apache.fop.pdf.PDFFilter
+  |
+  +--org.apache.fop.pdf.ASCII85Filter
+
public class ASCII85Filter
extends PDFFilter

Method Summary
 byte[]encode(byte[] data)
           
 StringgetDecodeParms()
           
 StringgetName()
           

Methods inherited from class org.apache.fop.pdf.PDFFilter
isApplied, setApplied

Method Detail

encode

public byte[] encode(byte[] data)

getDecodeParms

public String getDecodeParms()

getName

public String getName()

Association Links

to Class java.lang.String

\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/ASCIIHexFilter.html b/docs/design/contrib/pdf/org/apache/fop/pdf/ASCIIHexFilter.html new file mode 100755 index 000000000..2a0050dbf --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/ASCIIHexFilter.html @@ -0,0 +1,4 @@ +

org.apache.fop.pdf
Class ASCIIHexFilter

org.apache.fop.pdf.PDFFilter
+  |
+  +--org.apache.fop.pdf.ASCIIHexFilter
+
public class ASCIIHexFilter
extends PDFFilter

Method Summary
 byte[]encode(byte[] data)
           
 StringgetDecodeParms()
           
 StringgetName()
           

Methods inherited from class org.apache.fop.pdf.PDFFilter
isApplied, setApplied

Method Detail

encode

public byte[] encode(byte[] data)

getDecodeParms

public String getDecodeParms()

getName

public String getName()

Association Links

to Class java.lang.String

\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/FlateFilter.html b/docs/design/contrib/pdf/org/apache/fop/pdf/FlateFilter.html new file mode 100755 index 000000000..5e3523d34 --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/FlateFilter.html @@ -0,0 +1,11 @@ +

org.apache.fop.pdf
Class FlateFilter

org.apache.fop.pdf.PDFFilter
+  |
+  +--org.apache.fop.pdf.FlateFilter
+
public class FlateFilter
extends PDFFilter

A filter to deflate a stream. Note that the attributes for +prediction, colors, bitsPerComponent, and columns are not supported +when this filter is used to handle the data compression. They are +only valid for externally encoded data such as that from a graphics +file.

Field Summary
 final static intPREDICTION_NONE
           
 final static intPREDICTION_PNG_AVG
           
 final static intPREDICTION_PNG_NONE
           
 final static intPREDICTION_PNG_OPT
           
 final static intPREDICTION_PNG_PAETH
           
 final static intPREDICTION_PNG_SUB
           
 final static intPREDICTION_PNG_UP
           
 final static intPREDICTION_TIFF2
           

Method Summary
 byte[]encode(byte[] data)
          Encode the given data and return it.
 intgetBitsPerComponent()
           
 intgetColors()
           
 intgetColumns()
           
 StringgetDecodeParms()
           
 StringgetName()
           
 intgetPredictor()
           
 voidsetBitsPerComponent(int bits)
           
 voidsetColors(int colors)
           
 voidsetColumns(int columns)
           
 voidsetPredictor(int predictor)
           

Methods inherited from class org.apache.fop.pdf.PDFFilter
isApplied, setApplied

Field Detail

PREDICTION_NONE

public final static int PREDICTION_NONE

PREDICTION_PNG_AVG

public final static int PREDICTION_PNG_AVG

PREDICTION_PNG_NONE

public final static int PREDICTION_PNG_NONE

PREDICTION_PNG_OPT

public final static int PREDICTION_PNG_OPT

PREDICTION_PNG_PAETH

public final static int PREDICTION_PNG_PAETH

PREDICTION_PNG_SUB

public final static int PREDICTION_PNG_SUB

PREDICTION_PNG_UP

public final static int PREDICTION_PNG_UP

PREDICTION_TIFF2

public final static int PREDICTION_TIFF2
Method Detail

encode

public byte[] encode(byte[] data)
Encode the given data and return it. Note: a side effect of +this method is that it resets the prediction to the default +because these attributes are not supported. So the DecodeParms +should be retrieved after calling this method.

getBitsPerComponent

public int getBitsPerComponent()

getColors

public int getColors()

getColumns

public int getColumns()

getDecodeParms

public String getDecodeParms()

getName

public String getName()

getPredictor

public int getPredictor()

setBitsPerComponent

public void setBitsPerComponent(int bits)
                          throws PDFFilterException

setColors

public void setColors(int colors)
                throws PDFFilterException

setColumns

public void setColumns(int columns)
                 throws PDFFilterException

setPredictor

public void setPredictor(int predictor)
                   throws PDFFilterException
\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFAction.html b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFAction.html new file mode 100755 index 000000000..50b84e5dc --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFAction.html @@ -0,0 +1,15 @@ +

org.apache.fop.pdf
Class PDFAction

org.apache.fop.pdf.PDFObject
+  |
+  +--org.apache.fop.pdf.PDFAction
+
Direct Known Subclasses:
PDFGoToRemote, PDFInternalLink, PDFUri
public abstract class PDFAction
extends PDFObject

class representing an action object.

Constructor Summary
PDFAction(int number)
          create an Action object.
PDFAction()
          empty constructor for PDFAction.

Method Summary
 abstract StringgetAction()
          represent the action to call +this method should be implemented to return the action which gets +called by the Link Object.
 abstract byte[]toPDF()
          represent the object in PDF +this method should be implemented to return the PDF which is to be +generated by the Action object

Methods inherited from class org.apache.fop.pdf.PDFObject
getNumber, referencePDF

Constructor Detail

PDFAction

public PDFAction(int number)
create an Action object. +this constructor is used for passing on the object number to the PDFObject
Parameters:
number - the object's number

PDFAction

public PDFAction()
empty constructor for PDFAction. +this constructor is used when there is no additional object being created
Method Detail

getAction

public abstract String getAction()
represent the action to call +this method should be implemented to return the action which gets +called by the Link Object. This could be a reference to another object +or the specific destination of the link
Returns: the action to place next to /A within a Link

toPDF

public abstract byte[] toPDF()
represent the object in PDF +this method should be implemented to return the PDF which is to be +generated by the Action object
Returns: the PDF string
\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFAnnotList.html b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFAnnotList.html new file mode 100755 index 000000000..bdc92951b --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFAnnotList.html @@ -0,0 +1,7 @@ +

org.apache.fop.pdf
Class PDFAnnotList

org.apache.fop.pdf.PDFObject
+  |
+  +--org.apache.fop.pdf.PDFAnnotList
+
public class PDFAnnotList
extends PDFObject

class representing an object which is a list of annotations. + +This PDF object is a list of references to /Annot objects. So far we +are dealing only with links.

Constructor Summary
PDFAnnotList(int number)
          create a /Annots object.

Method Summary
 voidaddLink(PDFLink link)
          add an /Annot object of /Subtype /Link.
 intgetCount()
          get the count of /Annot objects
 byte[]toPDF()
          represent the object in PDF

Methods inherited from class org.apache.fop.pdf.PDFObject
getNumber, referencePDF

Constructor Detail

PDFAnnotList

public PDFAnnotList(int number)
create a /Annots object.
Parameters:
number - the object's number
Method Detail

addLink

public void addLink(PDFLink link)
add an /Annot object of /Subtype /Link.
Parameters:
link - the PDFLink to add.

getCount

public int getCount()
get the count of /Annot objects
Returns: the number of links

toPDF

public byte[] toPDF()
represent the object in PDF
Returns: the PDF string

Association Links

to Class java.util.Vector

the /Annot objects
\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFArray.html b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFArray.html new file mode 100755 index 000000000..a838e8ca9 --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFArray.html @@ -0,0 +1,4 @@ +

org.apache.fop.pdf
Class PDFArray

org.apache.fop.pdf.PDFObject
+  |
+  +--org.apache.fop.pdf.PDFArray
+
public class PDFArray
extends PDFObject

class representing an array object

Constructor Summary
PDFArray(int number, int[] values)
          create the array object

Method Summary
 byte[]toPDF()
          produce the PDF representation for the object

Methods inherited from class org.apache.fop.pdf.PDFObject
getNumber, referencePDF

Constructor Detail

PDFArray

public PDFArray(int number, int[] values)
create the array object
Parameters:
number - the object's number
values - the actual array wrapped by this object
Method Detail

toPDF

public byte[] toPDF()
produce the PDF representation for the object
Returns: the PDF
\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFColor.html b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFColor.html new file mode 100755 index 000000000..88658ba8e --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFColor.html @@ -0,0 +1,6 @@ +

org.apache.fop.pdf
Class PDFColor

org.apache.fop.pdf.PDFObject
+  |
+  +--org.apache.fop.pdf.PDFPathPaint
+        |
+        +--org.apache.fop.pdf.PDFColor
+
public class PDFColor
extends PDFPathPaint

Constructor Summary
PDFColor(org.apache.fop.datatypes.ColorType theColor)
           
PDFColor(double theRed, double theGreen, double theBlue)
           
PDFColor(int theRed, int theGreen, int theBlue)
           
PDFColor(double theCyan, double theMagenta, double theYellow, double theBlack)
           

Method Summary
 doubleblack()
           
 doubleblue()
           
 intblue255()
           
 doublecyan()
           
 StringgetColorSpaceOut(boolean fillNotStroke)
           
 VectorgetVector()
           
 doublegreen()
           
 intgreen255()
           
 doublemagenta()
           
 doublered()
           
 intred255()
           
 voidsetColorSpace(int theColorSpace)
           
 (package private) byte[]toPDF()
           
 doubleyellow()
           

Methods inherited from class org.apache.fop.pdf.PDFPathPaint
getColorSpace

Methods inherited from class org.apache.fop.pdf.PDFObject
getNumber, referencePDF

Constructor Detail

PDFColor

public PDFColor(org.apache.fop.datatypes.ColorType theColor)

PDFColor

public PDFColor(double theRed, double theGreen, double theBlue)

PDFColor

public PDFColor(int theRed, int theGreen, int theBlue)

PDFColor

public PDFColor(double theCyan, double theMagenta, double theYellow, double theBlack)
Method Detail

black

public double black()

blue

public double blue()

blue255

public int blue255()

cyan

public double cyan()

getColorSpaceOut

public String getColorSpaceOut(boolean fillNotStroke)

getVector

public Vector getVector()

green

public double green()

green255

public int green255()

magenta

public double magenta()

red

public double red()

red255

public int red255()

setColorSpace

public void setColorSpace(int theColorSpace)

toPDF

byte[] toPDF()

yellow

public double yellow()

Association Links

to Class org.apache.fop.pdf.PDFNumber

\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFDocument.html b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFDocument.html new file mode 100755 index 000000000..866a4c57b --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFDocument.html @@ -0,0 +1,118 @@ +

org.apache.fop.pdf
Class PDFDocument

public class PDFDocument

class representing a PDF document. + +The document is built up by calling various methods and then finally +output to given filehandle using output method. + +A PDF document consists of a series of numbered objects preceded by a +header and followed by an xref table and trailer. The xref table +allows for quick access to objects by listing their character +positions within the document. For this reason the PDF document must +keep track of the character position of each object. The document +also keeps direct track of the /Root, /Info and /Resources objects.

Constructor Summary
PDFDocument()
          creates an empty PDF document

Method Summary
 intaddImage(FopImage img)
           
 PDFPatterncreateGradient(boolean radial, ColorSpace theColorspace, Vector theColors, Vector theBounds, Vector theCoords)
           
 intgetColorSpace()
           
 PDFResourcesgetResources()
          get the /Resources object for the document
 PDFAnnotListmakeAnnotList()
          make an annotation list object
 PDFArraymakeArray(int[] values)
          make an Array object (ex.
 PDFEncodingmakeEncoding(String encodingName)
          make a /Encoding object
 PDFFontmakeFont(String fontname, String basefont, String encoding, FontMetric metrics, FontDescriptor descriptor)
          make a Type1 /Font object
 PDFFontDescriptormakeFontDescriptor(FontDescriptor desc)
          make a /FontDescriptor object for a CID font
 PDFFunctionmakeFunction(int theFunctionType, Vector theDomain, Vector theRange, Vector theSize, int theBitsPerSample, int theOrder, Vector theEncode, Vector theDecode, StringBuffer theFunctionDataStream, Vector theFilter)
          Make a Type 0 sampled function
 PDFFunctionmakeFunction(int theFunctionType, Vector theDomain, Vector theRange, Vector theCZero, Vector theCOne, double theInterpolationExponentN)
          make a type Exponential interpolation function +(for shading usually)
 PDFFunctionmakeFunction(int theFunctionType, Vector theDomain, Vector theRange, Vector theFunctions, Vector theBounds, Vector theEncode)
          Make a Type 3 Stitching function
 PDFFunctionmakeFunction(int theNumber, int theFunctionType, Vector theDomain, Vector theRange, StringBuffer theFunctionDataStream)
          make a postscript calculator function
 PDFLinkmakeLink(Rectangle rect, String destination, int linkType)
          make a link object
 PDFPagemakePage(PDFResources resources, PDFStream contents, int pagewidth, int pageheight, Page currentPage)
          make a /Page object
 PDFPatternmakePattern(int thePatternType, PDFResources theResources, int thePaintType, int theTilingType, Vector theBBox, double theXStep, double theYStep, Vector theMatrix, Vector theXUID, StringBuffer thePatternDataStream)
          Make a tiling pattern
 PDFPatternmakePattern(int thePatternType, PDFShading theShading, Vector theXUID, StringBuffer theExtGState, Vector theMatrix)
          Make a smooth shading pattern
 PDFShadingmakeShading(int theShadingType, ColorSpace theColorSpace, Vector theBackground, Vector theBBox, boolean theAntiAlias, Vector theDomain, Vector theMatrix, PDFFunction theFunction)
          make a function based shading object
 PDFShadingmakeShading(int theShadingType, ColorSpace theColorSpace, Vector theBackground, Vector theBBox, boolean theAntiAlias, Vector theCoords, Vector theDomain, PDFFunction theFunction, Vector theExtend)
          Make an axial or radial shading object.
 PDFShadingmakeShading(int theShadingType, ColorSpace theColorSpace, Vector theBackground, Vector theBBox, boolean theAntiAlias, int theBitsPerCoordinate, int theBitsPerComponent, int theBitsPerFlag, Vector theDecode, PDFFunction theFunction)
          Make a free-form gouraud shaded triangle mesh, coons patch mesh, or tensor patch mesh +shading object
 PDFShadingmakeShading(int theShadingType, ColorSpace theColorSpace, Vector theBackground, Vector theBBox, boolean theAntiAlias, int theBitsPerCoordinate, int theBitsPerComponent, Vector theDecode, int theVerticesPerRow, PDFFunction theFunction)
          make a Lattice-Form Gouraud mesh shading object
 PDFStreammakeStream()
          make a stream object
 voidoutput(OutputStream stream)
          write the entire document out
 voidsetColorSpace(int theColorspace)
           
 voidsetIDReferences(IDReferences idReferences)
           
 voidsetProducer(String producer)
          set the producer of the document

Constructor Detail

PDFDocument

public PDFDocument()
creates an empty PDF document
Method Detail

addImage

public int addImage(FopImage img)

createGradient

public PDFPattern createGradient(boolean radial, ColorSpace theColorspace, Vector theColors, Vector theBounds, Vector theCoords)

getColorSpace

public int getColorSpace()

getResources

public PDFResources getResources()
get the /Resources object for the document
Returns: the /Resources object

makeAnnotList

public PDFAnnotList makeAnnotList()
make an annotation list object
Returns: the annotation list object created

makeArray

public PDFArray makeArray(int[] values)
make an Array object (ex. Widths array for a font)

makeEncoding

public PDFEncoding makeEncoding(String encodingName)
make a /Encoding object
Parameters:
encodingName - character encoding scheme name
Returns: the created /Encoding object

makeFont

public PDFFont makeFont(String fontname, String basefont, String encoding, FontMetric metrics, FontDescriptor descriptor)
make a Type1 /Font object
Parameters:
fontname - internal name to use for this font (eg "F1")
basefont - name of the base font (eg "Helvetica")
encoding - character encoding scheme used by the font
metrics - additional information about the font
descriptor - additional information about the font
Returns: the created /Font object

makeFontDescriptor

public PDFFontDescriptor makeFontDescriptor(FontDescriptor desc)
make a /FontDescriptor object for a CID font

makeFunction

public PDFFunction makeFunction(int theFunctionType, Vector theDomain, Vector theRange, Vector theSize, int theBitsPerSample, int theOrder, Vector theEncode, Vector theDecode, StringBuffer theFunctionDataStream, Vector theFilter)
Make a Type 0 sampled function
Parameters:
theDomain - Vector objects of Double objects. +This is the domain of the function. +See page 264 of the PDF 1.3 Spec.
theRange - Vector objects of Double objects. +This is the Range of the function. +See page 264 of the PDF 1.3 Spec.
theSize - A Vector object of Integer objects. +This is the number of samples in each input dimension. +I can't imagine there being more or less than two input dimensions, +so maybe this should be an array of length 2. + +See page 265 of the PDF 1.3 Spec.
theBitsPerSample - An int specifying the number of bits user to represent each sample value. +Limited to 1,2,4,8,12,16,24 or 32. +See page 265 of the 1.3 PDF Spec.
theOrder - The order of interpolation between samples. Default is 1 (one). Limited +to 1 (one) or 3, which means linear or cubic-spline interpolation. + +This attribute is optional. + +See page 265 in the PDF 1.3 spec.
theEncode - Vector objects of Double objects. +This is the linear mapping of input values intop the domain +of the function's sample table. Default is hard to represent in +ascii, but basically [0 (Size0 1) 0 (Size1 1)...]. +This attribute is optional. + +See page 265 in the PDF 1.3 spec.
theDecode - Vector objects of Double objects. +This is a linear mapping of sample values into the range. +The default is just the range. + +This attribute is optional. +Read about it on page 265 of the PDF 1.3 spec.
theFunctionDataStream - The sample values that specify the function are provided in a stream. + +This is optional, but is almost always used. + +Page 265 of the PDF 1.3 spec has more.
theFilter - This is a vector of String objects which are the various filters that +have are to be applied to the stream to make sense of it. Order matters, +so watch out. + +This is not documented in the Function section of the PDF 1.3 spec, +it was deduced from samples that this is sometimes used, even if we may never +use it in FOP. It is added for completeness sake.
theNumber - The object number of this PDF object.
theFunctionType - This is the type of function (0,2,3, or 4). +It should be 0 as this is the constructor for sampled functions.

makeFunction

public PDFFunction makeFunction(int theFunctionType, Vector theDomain, Vector theRange, Vector theCZero, Vector theCOne, double theInterpolationExponentN)
make a type Exponential interpolation function +(for shading usually)
Parameters:
theDomain - Vector objects of Double objects. +This is the domain of the function. +See page 264 of the PDF 1.3 Spec.
theRange - Vector of Doubles that is the Range of the function. +See page 264 of the PDF 1.3 Spec.
theCZero - This is a vector of Double objects which defines the function result +when x=0. + +This attribute is optional. +It's described on page 268 of the PDF 1.3 spec.
theCOne - This is a vector of Double objects which defines the function result +when x=1. + +This attribute is optional. +It's described on page 268 of the PDF 1.3 spec.
theInterpolationExponentN - This is the inerpolation exponent. + +This attribute is required. +PDF Spec page 268
theFunctionType - The type of the function, which should be 2.

makeFunction

public PDFFunction makeFunction(int theFunctionType, Vector theDomain, Vector theRange, Vector theFunctions, Vector theBounds, Vector theEncode)
Make a Type 3 Stitching function
Parameters:
theDomain - Vector objects of Double objects. +This is the domain of the function. +See page 264 of the PDF 1.3 Spec.
theRange - Vector objects of Double objects. +This is the Range of the function. +See page 264 of the PDF 1.3 Spec.
theFunctions - A Vector of the PDFFunction objects that the stitching function stitches. + +This attributed is required. +It is described on page 269 of the PDF spec.
theBounds - This is a vector of Doubles representing the numbers that, +in conjunction with Domain define the intervals to which each function from +the 'functions' object applies. It must be in order of increasing magnitude, +and each must be within Domain. + +It basically sets how much of the gradient each function handles. + +This attributed is required. +It's described on page 269 of the PDF 1.3 spec.
theEncode - Vector objects of Double objects. +This is the linear mapping of input values intop the domain +of the function's sample table. Default is hard to represent in +ascii, but basically [0 (Size0 1) 0 (Size1 1)...]. +This attribute is required. + +See page 270 in the PDF 1.3 spec.
theFunctionType - This is the function type. It should be 3, +for a stitching function.

makeFunction

public PDFFunction makeFunction(int theNumber, int theFunctionType, Vector theDomain, Vector theRange, StringBuffer theFunctionDataStream)
make a postscript calculator function
Parameters:
theNumber
theFunctionType
theDomain
theRange
theFunctionDataStream

makeLink

public PDFLink makeLink(Rectangle rect, String destination, int linkType)
make a link object
Parameters:
rect - the clickable rectangle
destination - the destination file
linkType - the link type
Returns: the PDFLink object created

makePage

public PDFPage makePage(PDFResources resources, PDFStream contents, int pagewidth, int pageheight, Page currentPage)
make a /Page object
Parameters:
resources - resources object to use
contents - stream object with content
pagewidth - width of the page in points
pageheight - height of the page in points
Returns: the created /Page object

makePattern

public PDFPattern makePattern(int thePatternType, PDFResources theResources, int thePaintType, int theTilingType, Vector theBBox, double theXStep, double theYStep, Vector theMatrix, Vector theXUID, StringBuffer thePatternDataStream)
Make a tiling pattern
Parameters:
thePatternType - the type of pattern, which is 1 for tiling.
theResources - the resources associated with this pattern
thePaintType - 1 or 2, colored or uncolored.
theTilingType - 1, 2, or 3, constant spacing, no distortion, or faster tiling
theBBox - Vector of Doubles: The pattern cell bounding box
theXStep - horizontal spacing
theYStep - vertical spacing
theMatrix - Optional Vector of Doubles transformation matrix
theXUID - Optional vector of Integers that uniquely identify the pattern
thePatternDataStream - The stream of pattern data to be tiled.

makePattern

public PDFPattern makePattern(int thePatternType, PDFShading theShading, Vector theXUID, StringBuffer theExtGState, Vector theMatrix)
Make a smooth shading pattern
Parameters:
thePatternType - the type of the pattern, which is 2, smooth shading
theShading - the PDF Shading object that comprises this pattern
theXUID - optional:the extended unique Identifier if used.
theExtGState - optional: the extended graphics state, if used.
theMatrix - Optional:Vector of Doubles that specify the matrix.

makeShading

public PDFShading makeShading(int theShadingType, ColorSpace theColorSpace, Vector theBackground, Vector theBBox, boolean theAntiAlias, Vector theDomain, Vector theMatrix, PDFFunction theFunction)
make a function based shading object
Parameters:
theShadingType - The type of shading object, which should be 1 for function +based shading.
theColorSpace - The colorspace is 'DeviceRGB' or something similar.
theBackground - An array of color components appropriate to the +colorspace key specifying a single color value. +This key is used by the f operator buy ignored by the sh operator.
theBBox - Vector of double's representing a rectangle +in the coordinate space that is current at the +time of shading is imaged. Temporary clipping +boundary.
theAntiAlias - Whether or not to anti-alias.
theDomain - Optional vector of Doubles specifying the domain.
theMatrix - Vector of Doubles specifying the matrix. +If it's a pattern, then the matrix maps it to pattern space. +If it's a shading, then it maps it to current user space. +It's optional, the default is the identity matrix
theFunction - The PDF Function that maps an (x,y) location to a color

makeShading

public PDFShading makeShading(int theShadingType, ColorSpace theColorSpace, Vector theBackground, Vector theBBox, boolean theAntiAlias, Vector theCoords, Vector theDomain, PDFFunction theFunction, Vector theExtend)
Make an axial or radial shading object.
Parameters:
theShadingType - 2 or 3 for axial or radial shading
theColorSpace - "DeviceRGB" or similar.
theBackground - theBackground An array of color components appropriate to the +colorspace key specifying a single color value. +This key is used by the f operator buy ignored by the sh operator.
theBBox - Vector of double's representing a rectangle +in the coordinate space that is current at the +time of shading is imaged. Temporary clipping +boundary.
theAntiAlias - Default is false
theCoords - Vector of four (type 2) or 6 (type 3) Double
theDomain - Vector of Doubles specifying the domain
theFunction - the Stitching (PDFfunction type 3) function, even if it's stitching a single function
theExtend - Vector of Booleans of whether to extend teh start and end colors past the start and end points +The default is [false, false]

makeShading

public PDFShading makeShading(int theShadingType, ColorSpace theColorSpace, Vector theBackground, Vector theBBox, boolean theAntiAlias, int theBitsPerCoordinate, int theBitsPerComponent, int theBitsPerFlag, Vector theDecode, PDFFunction theFunction)
Make a free-form gouraud shaded triangle mesh, coons patch mesh, or tensor patch mesh +shading object
Parameters:
theShadingType - 4, 6, or 7 depending on whether it's +Free-form gouraud-shaded triangle meshes, coons patch meshes, +or tensor product patch meshes, respectively.
theColorSpace - "DeviceRGB" or similar.
theBackground - theBackground An array of color components appropriate to the +colorspace key specifying a single color value. +This key is used by the f operator buy ignored by the sh operator.
theBBox - Vector of double's representing a rectangle +in the coordinate space that is current at the +time of shading is imaged. Temporary clipping +boundary.
theAntiAlias - Default is false
theBitsPerCoordinate - 1,2,4,8,12,16,24 or 32.
theBitsPerComponent - 1,2,4,8,12, and 16
theBitsPerFlag - 2,4,8.
theDecode - Vector of Doubles see PDF 1.3 spec pages 303 to 312.
theFunction - the PDFFunction

makeShading

public PDFShading makeShading(int theShadingType, ColorSpace theColorSpace, Vector theBackground, Vector theBBox, boolean theAntiAlias, int theBitsPerCoordinate, int theBitsPerComponent, Vector theDecode, int theVerticesPerRow, PDFFunction theFunction)
make a Lattice-Form Gouraud mesh shading object
Parameters:
theShadingType - 5 for lattice-Form Gouraud shaded-triangle mesh +without spaces. "Shading1" or "Sh1" are good examples.
theColorSpace - "DeviceRGB" or similar.
theBackground - theBackground An array of color components appropriate to the +colorspace key specifying a single color value. +This key is used by the f operator buy ignored by the sh operator.
theBBox - Vector of double's representing a rectangle +in the coordinate space that is current at the +time of shading is imaged. Temporary clipping +boundary.
theAntiAlias - Default is false
theBitsPerCoordinate - 1,2,4,8,12,16, 24, or 32
theBitsPerComponent - 1,2,4,8,12,24,32
theDecode - Vector of Doubles. See page 305 in PDF 1.3 spec.
theVerticesPerRow - number of vertices in each "row" of the lattice.
theFunction - The PDFFunction that's mapped on to this shape

makeStream

public PDFStream makeStream()
make a stream object
Returns: the stream object created

output

public void output(OutputStream stream)
             throws java.io.IOException
write the entire document out
Parameters:
writer - the OutputStream to output the document to

setColorSpace

public void setColorSpace(int theColorspace)

setIDReferences

public void setIDReferences(IDReferences idReferences)

setProducer

public void setProducer(String producer)
set the producer of the document
Parameters:
producer - string indicating application producing the PDF

Association Links

to Class java.lang.String

the version of PDF supported

to Class java.util.Vector

the character position of each object

to Class java.util.Vector

the objects themselves

to Class org.apache.fop.pdf.PDFRoot

the /Root object

to Class org.apache.fop.pdf.PDFInfo

the /Info object

to Class org.apache.fop.pdf.PDFResources

the /Resources object

to Class org.apache.fop.datatypes.IDReferences

the documents idReferences

to Class org.apache.fop.datatypes.ColorSpace

the colorspace (0=RGB, 1=CMYK) *

to Class java.util.Vector

the XObjects

to Class java.util.Hashtable

the XObjects Map. +Should be modified (works only for image subtype)
\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFEncoding.html b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFEncoding.html new file mode 100755 index 000000000..c394b20a3 --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFEncoding.html @@ -0,0 +1,13 @@ +

org.apache.fop.pdf
Class PDFEncoding

org.apache.fop.pdf.PDFObject
+  |
+  +--org.apache.fop.pdf.PDFEncoding
+
public class PDFEncoding
extends PDFObject

class representing an /Encoding object. + +A small object expressing the base encoding name and +the differences from the base encoding. + +The three base encodings are given by their name. + +Encodings are specified on page 213 and onwards of the PDF 1.3 spec.

Field Summary
 final static StringMacExpertEncoding
          the name for the standard encoding scheme
 final static StringMacRomanEncoding
          the name for the standard encoding scheme
 final static StringWinAnsiEncoding
          the name for the standard encoding scheme

Constructor Summary
PDFEncoding(int number, String basename)
          create the /Encoding object

Method Summary
 voidaddDifferences(int code, Vector sequence)
          add differences to the encoding
 byte[]toPDF()
          produce the PDF representation for the object

Methods inherited from class org.apache.fop.pdf.PDFObject
getNumber, referencePDF

Field Detail

MacExpertEncoding

public final static String MacExpertEncoding
the name for the standard encoding scheme

MacRomanEncoding

public final static String MacRomanEncoding
the name for the standard encoding scheme

WinAnsiEncoding

public final static String WinAnsiEncoding
the name for the standard encoding scheme
Constructor Detail

PDFEncoding

public PDFEncoding(int number, String basename)
create the /Encoding object
Parameters:
number - the object's number
basename - the name of the character encoding schema
Method Detail

addDifferences

public void addDifferences(int code, Vector sequence)
add differences to the encoding
Parameters:
code - the first index of the sequence to be changed
sequence - the sequence of glyph names (as String)

toPDF

public byte[] toPDF()
produce the PDF representation for the object
Returns: the PDF

Association Links

to Class java.lang.String

the name for the standard encoding scheme

to Class java.lang.String

the name for the standard encoding scheme

to Class java.lang.String

the name for the standard encoding scheme

to Class java.lang.String

the name for the base encoding. +One of the three base encoding scheme names or +the default font's base encoding if null.

to Class java.util.Hashtable

the differences from the base encoding
\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFFileSpec.html b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFFileSpec.html new file mode 100755 index 000000000..479ae060a --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFFileSpec.html @@ -0,0 +1,4 @@ +

org.apache.fop.pdf
Class PDFFileSpec

org.apache.fop.pdf.PDFObject
+  |
+  +--org.apache.fop.pdf.PDFFileSpec
+
public class PDFFileSpec
extends PDFObject

class representing a /FileSpec object.

Constructor Summary
PDFFileSpec(int number, String filename)
          create a /FileSpec object.

Method Summary
 byte[]toPDF()
          represent the object in PDF

Methods inherited from class org.apache.fop.pdf.PDFObject
getNumber, referencePDF

Constructor Detail

PDFFileSpec

public PDFFileSpec(int number, String filename)
create a /FileSpec object.
Parameters:
number - the object's number
filename - the filename represented by this object
Method Detail

toPDF

public byte[] toPDF()
represent the object in PDF
Returns: the PDF string

Association Links

to Class java.lang.String

the filename
\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFFilter.html b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFFilter.html new file mode 100755 index 000000000..1f3c11b8a --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFFilter.html @@ -0,0 +1,7 @@ +

org.apache.fop.pdf
Class PDFFilter

Direct Known Subclasses:
ASCII85Filter, ASCIIHexFilter, FlateFilter
public abstract class PDFFilter

Method Summary
 abstract byte[]encode(byte[] data)
          encode the given data with the filter
 abstract StringgetDecodeParms()
          return a parameter dictionary for this filter, or null
 abstract StringgetName()
          return a PDF string representation of the filter, e.g.
 booleanisApplied()
           
 voidsetApplied(boolean b)
          Set the applied attribute to the given value.

Method Detail

encode

public abstract byte[] encode(byte[] data)
encode the given data with the filter

getDecodeParms

public abstract String getDecodeParms()
return a parameter dictionary for this filter, or null

getName

public abstract String getName()
return a PDF string representation of the filter, e.g. /FlateDecode

isApplied

public boolean isApplied()

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.
\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFFilterException.html b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFFilterException.html new file mode 100755 index 000000000..6fb6d9306 --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFFilterException.html @@ -0,0 +1,8 @@ +

org.apache.fop.pdf
Class PDFFilterException

java.lang.Object
+  |
+  +--java.lang.Throwable
+        |
+        +--java.lang.Exception
+              |
+              +--org.apache.fop.pdf.PDFFilterException
+
public class PDFFilterException
extends Exception

Constructor Summary
PDFFilterException()
           
PDFFilterException(String message)
           

Methods inherited from class java.lang.Throwable
getMessage, getLocalizedMessage, toString, printStackTrace, printStackTrace, printStackTrace, fillInStackTrace

Methods inherited from class java.lang.Object
getClass, hashCode, equals, notify, notifyAll, wait, wait, wait

Constructor Detail

PDFFilterException

public PDFFilterException()

PDFFilterException

public PDFFilterException(String message)
\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFFont.html b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFFont.html new file mode 100755 index 000000000..c07d29aa6 --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFFont.html @@ -0,0 +1,12 @@ +

org.apache.fop.pdf
Class PDFFont

org.apache.fop.pdf.PDFObject
+  |
+  +--org.apache.fop.pdf.PDFFont
+
Direct Known Subclasses:
PDFFontNonBase14
public class PDFFont
extends PDFObject

class representing a /Font object. + +A more complete object expressing the base font name and encoding of a +font along with an internal name for the font used within +streams of content. + +Fonts are specified on page 198 and onwards of the PDF 1.3 spec.

Field Summary
 final static byteMMTYPE1
          font subtype to be used as parameter to createFont()
 final static byteTRUETYPE
          font subtype to be used as parameter to createFont()
 final static byteTYPE0
          font subtype to be used as parameter to createFont()
 final static byteTYPE1
          font subtype to be used as parameter to createFont()
 final static byteTYPE3
          font subtype to be used as parameter to createFont()

Constructor Summary
PDFFont(int number, String fontname, byte subtype, String basefont, Object encoding)
          create the /Font object

Method Summary
 static PDFFontcreateFont(int number, String fontname, byte subtype, String basefont, Object encoding)
          factory method with the basic parameters
 static PDFFontcreateFont(int number, String fontname, byte subtype, String basefont, Object encoding, int firstChar, int lastChar, PDFArray widths, PDFFontDescriptor descriptor)
          factory method with the extended parameters +for Type1, MMType1 and TrueType
 StringgetName()
          get the internal name used for this font
 byte[]toPDF()
          produce the PDF representation for the object

Methods inherited from class org.apache.fop.pdf.PDFObject
getNumber, referencePDF

Field Detail

MMTYPE1

public final static byte MMTYPE1
font subtype to be used as parameter to createFont()

TRUETYPE

public final static byte TRUETYPE
font subtype to be used as parameter to createFont()

TYPE0

public final static byte TYPE0
font subtype to be used as parameter to createFont()

TYPE1

public final static byte TYPE1
font subtype to be used as parameter to createFont()

TYPE3

public final static byte TYPE3
font subtype to be used as parameter to createFont()
Constructor Detail

PDFFont

public PDFFont(int number, String fontname, byte subtype, String basefont, Object encoding)
create the /Font object
Parameters:
number - the object's number
fontname - the internal name for the font
subtype - the font's subtype
basefont - the base font name
encoding - the character encoding schema used by the font
mapping - the Unicode mapping mechanism
Method Detail

createFont

public static PDFFont createFont(int number, String fontname, byte subtype, String basefont, Object encoding)
factory method with the basic parameters
Parameters:
number - the object's number
fontname - the internal name for the font
subtype - the font's subtype
basefont - the base font name
encoding - the character encoding schema used by the font

createFont

public static PDFFont createFont(int number, String fontname, byte subtype, String basefont, Object encoding, int firstChar, int lastChar, PDFArray widths, PDFFontDescriptor descriptor)
factory method with the extended parameters +for Type1, MMType1 and TrueType
Parameters:
number - the object's number
fontname - the internal name for the font
subtype - the font's subtype
basefont - the base font name
encoding - the character encoding schema used by the font
firstChar - the first character code in the font
lastChar - the last character code in the font
widths - an array of size (lastChar - firstChar +1)
descriptor - the descriptor for other font's metrics

getName

public String getName()
get the internal name used for this font
Returns: the internal name

toPDF

public byte[] toPDF()
produce the PDF representation for the object
Returns: the PDF

Association Links

to Class java.lang.String

font subtype names as output in the PDF

to Class java.lang.String

the internal name for the font (eg "F1")

to Class java.lang.String

the base font name (eg "Helvetica")
\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFFontDescriptor.html b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFFontDescriptor.html new file mode 100755 index 000000000..427a0bbac --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFFontDescriptor.html @@ -0,0 +1,6 @@ +

org.apache.fop.pdf
Class PDFFontDescriptor

org.apache.fop.pdf.PDFObject
+  |
+  +--org.apache.fop.pdf.PDFFontDescriptor
+
public class PDFFontDescriptor
extends PDFObject

class representing a font descriptor. + +Font descriptors are specified on page 222 and onwards of the PDF 1.3 spec.

Constructor Summary
PDFFontDescriptor(int number, String basefont, int ascent, int descent, int capHeight, int flags, PDFRectangle fontBBox, int italicAngle, int stemV)
          create the /FontDescriptor object

Method Summary
 voidsetFontFile(byte subtype, PDFStream fontfile)
          set the optional font file stream
 voidsetMetrics(int avgWidth, int maxWidth, int missingWidth, int leading, int stemH, int xHeight)
          set the optional metrics
 byte[]toPDF()
          produce the PDF representation for the object

Methods inherited from class org.apache.fop.pdf.PDFObject
getNumber, referencePDF

Constructor Detail

PDFFontDescriptor

public PDFFontDescriptor(int number, String basefont, int ascent, int descent, int capHeight, int flags, PDFRectangle fontBBox, int italicAngle, int stemV)
create the /FontDescriptor object
Parameters:
number - the object's number
ascent - the maximum height above the baseline
descent - the maximum depth below the baseline
capHeight - height of the capital letters
flags - various characteristics of the font
fontBBox - the bounding box for the described font
basefont - the base font name
italicAngle - the angle of the vertical dominant strokes
stemV - the width of the dominant vertical stems of glyphs
Method Detail

setFontFile

public void setFontFile(byte subtype, PDFStream fontfile)
set the optional font file stream
Parameters:
subtype - the font type defined in the font stream
fontfile - the stream containing an embedded font

setMetrics

public void setMetrics(int avgWidth, int maxWidth, int missingWidth, int leading, int stemH, int xHeight)
set the optional metrics

toPDF

public byte[] toPDF()
produce the PDF representation for the object
Returns: the PDF

Association Links

to Class org.apache.fop.pdf.PDFRectangle

to Class java.lang.String

to Class org.apache.fop.pdf.PDFStream

\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFFontNonBase14.html b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFFontNonBase14.html new file mode 100755 index 000000000..4313afd0e --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFFontNonBase14.html @@ -0,0 +1,7 @@ +

org.apache.fop.pdf
Class PDFFontNonBase14

org.apache.fop.pdf.PDFObject
+  |
+  +--org.apache.fop.pdf.PDFFont
+        |
+        +--org.apache.fop.pdf.PDFFontNonBase14
+
Direct Known Subclasses:
PDFFontType1
public abstract class PDFFontNonBase14
extends PDFFont

A common ancestor for Type1, TrueType, MMType1 and Type3 fonts +(all except base 14 fonts).

Fields inherited from class org.apache.fop.pdf.PDFFont
MMTYPE1, TRUETYPE, TYPE0, TYPE1, TYPE3

Constructor Summary
PDFFontNonBase14(int number, String fontname, byte subtype, String basefont, Object encoding)
          create the /Font object

Method Summary
 voidsetDescriptor(PDFFontDescriptor descriptor)
          set the font descriptor (unused for the Type3 fonts)
 voidsetWidthMetrics(int firstChar, int lastChar, PDFArray widths)
          set the width metrics for the font

Methods inherited from class org.apache.fop.pdf.PDFFont
createFont, createFont, getName, toPDF

Methods inherited from class org.apache.fop.pdf.PDFObject
getNumber, referencePDF

Constructor Detail

PDFFontNonBase14

public PDFFontNonBase14(int number, String fontname, byte subtype, String basefont, Object encoding)
create the /Font object
Parameters:
number - the object's number
fontname - the internal name for the font
subtype - the font's subtype
basefont - the base font name
encoding - the character encoding schema used by the font
mapping - the Unicode mapping mechanism
Method Detail

setDescriptor

public void setDescriptor(PDFFontDescriptor descriptor)
set the font descriptor (unused for the Type3 fonts)
Parameters:
descriptor - the descriptor for other font's metrics

setWidthMetrics

public void setWidthMetrics(int firstChar, int lastChar, PDFArray widths)
set the width metrics for the font
Parameters:
firstChar - the first character code in the font
lastChar - the last character code in the font
widths - an array of size (lastChar - firstChar +1)

Association Links

to Class org.apache.fop.pdf.PDFArray

widths of characters from firstChar to lastChar

to Class org.apache.fop.pdf.PDFFontDescriptor

descriptor of font metrics
\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFFontType1.html b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFFontType1.html new file mode 100755 index 000000000..2a0e5f9f0 --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFFontType1.html @@ -0,0 +1,14 @@ +

org.apache.fop.pdf
Class PDFFontType1

org.apache.fop.pdf.PDFObject
+  |
+  +--org.apache.fop.pdf.PDFFont
+        |
+        +--org.apache.fop.pdf.PDFFontNonBase14
+              |
+              +--org.apache.fop.pdf.PDFFontType1
+
public class PDFFontType1
extends PDFFontNonBase14

class representing a Type1 or MMType1 font (not necessary for the base 14). + +Type1 fonts are specified on page 201 and onwards of the PDF 1.3 spec. +MMType1 fonts are specified on page 205 and onwards of the PDF 1.3 spec. + +In fact everything already done in the superclass. +Must only define the not default constructor.

Fields inherited from class org.apache.fop.pdf.PDFFont
MMTYPE1, TRUETYPE, TYPE0, TYPE1, TYPE3

Constructor Summary
PDFFontType1(int number, String fontname, byte subtype, String basefont, Object encoding)
          create the /Font object

Methods inherited from class org.apache.fop.pdf.PDFFontNonBase14
setDescriptor, setWidthMetrics

Methods inherited from class org.apache.fop.pdf.PDFFont
createFont, createFont, getName, toPDF

Methods inherited from class org.apache.fop.pdf.PDFObject
getNumber, referencePDF

Constructor Detail

PDFFontType1

public PDFFontType1(int number, String fontname, byte subtype, String basefont, Object encoding)
create the /Font object
Parameters:
number - the object's number
fontname - the internal name for the font
subtype - the font's subtype (PDFFont.TYPE1 or PDFFont.MMTYPE1)
basefont - the base font name
encoding - the character encoding schema used by the font
mapping - the Unicode mapping mechanism
\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFFunction.html b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFFunction.html new file mode 100755 index 000000000..144aea14c --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFFunction.html @@ -0,0 +1,123 @@ +

org.apache.fop.pdf
Class PDFFunction

org.apache.fop.pdf.PDFObject
+  |
+  +--org.apache.fop.pdf.PDFFunction
+
public class PDFFunction
extends PDFObject

class representing a PDF Function. + +PDF Functions represent parameterized mathematical formulas and sampled representations with +arbitrary resolution. Functions are used in two areas: device-dependent +rasterization information for halftoning and transfer +functions, and color specification for smooth shading (a PDF 1.3 feature). + +All PDF Functions have a FunctionType (0,2,3, or 4), a Domain, and a Range.

Constructor Summary
PDFFunction(int theNumber, int theFunctionType, Vector theDomain, Vector theRange, Vector theSize, int theBitsPerSample, int theOrder, Vector theEncode, Vector theDecode, StringBuffer theFunctionDataStream, Vector theFilter)
          create an complete Function object of Type 0, A Sampled function.
PDFFunction(int theNumber, int theFunctionType, Vector theDomain, Vector theRange, Vector theCZero, Vector theCOne, double theInterpolationExponentN)
          create an complete Function object of Type 2, an Exponential Interpolation function.
PDFFunction(int theNumber, int theFunctionType, Vector theDomain, Vector theRange, Vector theFunctions, Vector theBounds, Vector theEncode)
          create an complete Function object of Type 3, a Stitching function.
PDFFunction(int theNumber, int theFunctionType, Vector theDomain, Vector theRange, StringBuffer theFunctionDataStream)
          create an complete Function object of Type 4, a postscript calculator function.

Method Summary
 byte[]toPDF()
          represent as PDF.

Methods inherited from class org.apache.fop.pdf.PDFObject
getNumber, referencePDF

Constructor Detail

PDFFunction

public PDFFunction(int theNumber, int theFunctionType, Vector theDomain, Vector theRange, Vector theSize, int theBitsPerSample, int theOrder, Vector theEncode, Vector theDecode, StringBuffer theFunctionDataStream, Vector theFilter)
create an complete Function object of Type 0, A Sampled function. + +Use null for an optional object parameter if you choose not to use it. +For optional int parameters, pass the default.
Parameters:
theDomain - Vector objects of Double objects. +This is the domain of the function. +See page 264 of the PDF 1.3 Spec.
theRange - Vector objects of Double objects. +This is the Range of the function. +See page 264 of the PDF 1.3 Spec.
theSize - A Vector object of Integer objects. +This is the number of samples in each input dimension. +I can't imagine there being more or less than two input dimensions, +so maybe this should be an array of length 2. + +See page 265 of the PDF 1.3 Spec.
theBitsPerSample - An int specifying the number of bits user to represent each sample value. +Limited to 1,2,4,8,12,16,24 or 32. +See page 265 of the 1.3 PDF Spec.
theOrder - The order of interpolation between samples. Default is 1 (one). Limited +to 1 (one) or 3, which means linear or cubic-spline interpolation. + +This attribute is optional. + +See page 265 in the PDF 1.3 spec.
theEncode - Vector objects of Double objects. +This is the linear mapping of input values intop the domain +of the function's sample table. Default is hard to represent in +ascii, but basically [0 (Size0 1) 0 (Size1 1)...]. +This attribute is optional. + +See page 265 in the PDF 1.3 spec.
theDecode - Vector objects of Double objects. +This is a linear mapping of sample values into the range. +The default is just the range. + +This attribute is optional. +Read about it on page 265 of the PDF 1.3 spec.
theFunctionDataStream - The sample values that specify the function are provided in a stream. + +This is optional, but is almost always used. + +Page 265 of the PDF 1.3 spec has more.
theFilter - This is a vector of String objects which are the various filters that +have are to be applied to the stream to make sense of it. Order matters, +so watch out. + +This is not documented in the Function section of the PDF 1.3 spec, +it was deduced from samples that this is sometimes used, even if we may never +use it in FOP. It is added for completeness sake.
theNumber - The object number of this PDF object.
theFunctionType - This is the type of function (0,2,3, or 4). +It should be 0 as this is the constructor for sampled functions.

PDFFunction

public PDFFunction(int theNumber, int theFunctionType, Vector theDomain, Vector theRange, Vector theCZero, Vector theCOne, double theInterpolationExponentN)
create an complete Function object of Type 2, an Exponential Interpolation function. + +Use null for an optional object parameter if you choose not to use it. +For optional int parameters, pass the default.
Parameters:
theNumber - the object's number
theDomain - Vector objects of Double objects. +This is the domain of the function. +See page 264 of the PDF 1.3 Spec.
theRange - Vector of Doubles that is the Range of the function. +See page 264 of the PDF 1.3 Spec.
theCZero - This is a vector of Double objects which defines the function result +when x=0. + +This attribute is optional. +It's described on page 268 of the PDF 1.3 spec.
theCOne - This is a vector of Double objects which defines the function result +when x=1. + +This attribute is optional. +It's described on page 268 of the PDF 1.3 spec.
theInterpolationExponentN - This is the inerpolation exponent. + +This attribute is required. +PDF Spec page 268
theFunctionType - The type of the function, which should be 2.

PDFFunction

public PDFFunction(int theNumber, int theFunctionType, Vector theDomain, Vector theRange, Vector theFunctions, Vector theBounds, Vector theEncode)
create an complete Function object of Type 3, a Stitching function. + +Use null for an optional object parameter if you choose not to use it. +For optional int parameters, pass the default.
Parameters:
theNumber - the object's number
theDomain - Vector objects of Double objects. +This is the domain of the function. +See page 264 of the PDF 1.3 Spec.
theRange - Vector objects of Double objects. +This is the Range of the function. +See page 264 of the PDF 1.3 Spec.
theFunctions - A Vector of the PDFFunction objects that the stitching function stitches. + +This attributed is required. +It is described on page 269 of the PDF spec.
theBounds - This is a vector of Doubles representing the numbers that, +in conjunction with Domain define the intervals to which each function from +the 'functions' object applies. It must be in order of increasing magnitude, +and each must be within Domain. + +It basically sets how much of the gradient each function handles. + +This attributed is required. +It's described on page 269 of the PDF 1.3 spec.
theEncode - Vector objects of Double objects. +This is the linear mapping of input values intop the domain +of the function's sample table. Default is hard to represent in +ascii, but basically [0 (Size0 1) 0 (Size1 1)...]. +This attribute is required. + +See page 270 in the PDF 1.3 spec.
theFunctionType - This is the function type. It should be 3, +for a stitching function.

PDFFunction

public PDFFunction(int theNumber, int theFunctionType, Vector theDomain, Vector theRange, StringBuffer theFunctionDataStream)
create an complete Function object of Type 4, a postscript calculator function. + +Use null for an optional object parameter if you choose not to use it. +For optional int parameters, pass the default.
Parameters:
theDomain - Vector object of Double objects. +This is the domain of the function. +See page 264 of the PDF 1.3 Spec.
theRange - Vector object of Double objects. +This is the Range of the function. +See page 264 of the PDF 1.3 Spec.
theFunctionDataStream - This is a stream of arithmetic, boolean, and stack operators and boolean constants. +I end up enclosing it in the '{' and '}' braces for you, so don't do it +yourself. + +This attribute is required. +It's described on page 269 of the PDF 1.3 spec.
theNumber - The object number of this PDF object.
theFunctionType - The type of function which should be 4, as this is +a Postscript calculator function
Method Detail

toPDF

public byte[] toPDF()
represent as PDF. Whatever the FunctionType is, the correct +representation spits out. The sets of required and optional +attributes are different for each type, but if a required +attribute's object was constructed as null, then no error +is raised. Instead, the malformed PDF that was requested +by the construction is dutifully output. +This policy should be reviewed.
Returns: the PDF string.

Association Links

to Class java.util.Vector

Required: 2 * m Array of Double numbers which are possible inputs to the function

to Class java.util.Vector

Required: 2 * n Array of Double numbers which are possible outputs to the function

to Class java.util.Vector

Required: Array containing the Integer size of the Domain and Range, respectively. +Note: This is really more like two seperate integers, sizeDomain, and sizeRange, +but since they're expressed as an array in PDF, my implementation reflects that.

to Class java.util.Vector

Optional for Type 0: A 2 * m array of Doubles which provides a linear mapping of input values to the domain. + +Required for Type 3: A 2 * k array of Doubles that, taken in pairs, map each subset of the domain defined by Domain and the Bounds array to the domain of the corresponding function. +Should be two values per function, usually (0,1), as in [0 1 0 1] for 2 functions.

to Class java.util.Vector

Optinoal for Type 0: A 2 * n array of Doubles which provides a linear mapping of sample values to the range. Defaults to Range.

to Class java.lang.StringBuffer

Required For Type 4: Postscript Calculator function composed of arithmetic, boolean, and stack operators + boolean constants

to Class java.util.Vector

Required (?) For Type 0: A vector of Strings for the various filters to be used to decode the stream. +These are how the string is compressed. Flate, LZW, etc.

to Class java.util.Vector

Required For Type 2: An Array of n Doubles defining the function result when x=0. Default is [0].

to Class java.util.Vector

Required For Type 2: An Array of n Doubles defining the function result when x=1. Default is [1].

to Class java.util.Vector

Required for Type 3: An vector of PDFFunctions which form an array of k single input functions making up the stitching function.

to Class java.util.Vector

Optional for Type 3: An array of (k-1) Doubles that, in combination with Domain, define the intervals to which each function from the Functions array apply. Bounds elements must be in order of increasing magnitude, and each value must be within the value of Domain. +k is the number of functions. +If you pass null, it will output (1/k) in an array of k-1 elements. +This makes each function responsible for an equal amount of the stitching function. +It makes the gradient even.

to Class org.apache.fop.pdf.PDFNumber

\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFGoTo.html b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFGoTo.html new file mode 100755 index 000000000..ffb39a8f4 --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFGoTo.html @@ -0,0 +1,5 @@ +

org.apache.fop.pdf
Class PDFGoTo

org.apache.fop.pdf.PDFObject
+  |
+  +--org.apache.fop.pdf.PDFGoTo
+
public class PDFGoTo
extends PDFObject

class representing a /GoTo object.

Constructor Summary
PDFGoTo(int number, String pageReference)
          create a /GoTo object.

Method Summary
 voidsetPageReference(String pageReference)
          Sets page reference after object has been created
 voidsetXPosition(int xPosition)
          Sets the x Position to jump to
 voidsetYPosition(int yPosition)
          Sets the Y position to jump to
 byte[]toPDF()
          represent the object in PDF

Methods inherited from class org.apache.fop.pdf.PDFObject
getNumber, referencePDF

Constructor Detail

PDFGoTo

public PDFGoTo(int number, String pageReference)
create a /GoTo object.
Parameters:
number - the object's number
pageReference - the pageReference represented by this object
Method Detail

setPageReference

public void setPageReference(String pageReference)
Sets page reference after object has been created
Parameters:
pageReference +the - new page reference to use

setXPosition

public void setXPosition(int xPosition)
Sets the x Position to jump to
Parameters:
xPosition - x position

setYPosition

public void setYPosition(int yPosition)
Sets the Y position to jump to
Parameters:
yPosition - y position

toPDF

public byte[] toPDF()
represent the object in PDF
Returns: the PDF string

Association Links

to Class java.lang.String

the pageReference
\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFGoToRemote.html b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFGoToRemote.html new file mode 100755 index 000000000..264bc2d8e --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFGoToRemote.html @@ -0,0 +1,6 @@ +

org.apache.fop.pdf
Class PDFGoToRemote

org.apache.fop.pdf.PDFObject
+  |
+  +--org.apache.fop.pdf.PDFAction
+        |
+        +--org.apache.fop.pdf.PDFGoToRemote
+
public class PDFGoToRemote
extends PDFAction

class representing a /GoToR object.

Constructor Summary
PDFGoToRemote(int number, PDFFileSpec pdfFileSpec)
          create an GoToR object.

Method Summary
 StringgetAction()
          return the action string which will reference this object
 byte[]toPDF()
          represent the object in PDF

Methods inherited from class org.apache.fop.pdf.PDFObject
getNumber, referencePDF

Constructor Detail

PDFGoToRemote

public PDFGoToRemote(int number, PDFFileSpec pdfFileSpec)
create an GoToR object.
Parameters:
number - the object's number
fileSpec - the fileSpec associated with the action
Method Detail

getAction

public String getAction()
return the action string which will reference this object
Returns: the action String

toPDF

public byte[] toPDF()
represent the object in PDF
Returns: the PDF string

Association Links

to Class org.apache.fop.pdf.PDFFileSpec

the file specification
\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFInfo.html b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFInfo.html new file mode 100755 index 000000000..5372526b7 --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFInfo.html @@ -0,0 +1,4 @@ +

org.apache.fop.pdf
Class PDFInfo

org.apache.fop.pdf.PDFObject
+  |
+  +--org.apache.fop.pdf.PDFInfo
+
public class PDFInfo
extends PDFObject

class representing an /Info object

Constructor Summary
PDFInfo(int number)
          create an Info object

Method Summary
 voidsetProducer(String producer)
          set the producer string
 byte[]toPDF()
          produce the PDF representation of the object

Methods inherited from class org.apache.fop.pdf.PDFObject
getNumber, referencePDF

Constructor Detail

PDFInfo

public PDFInfo(int number)
create an Info object
Parameters:
number - the object's number
Method Detail

setProducer

public void setProducer(String producer)
set the producer string
Parameters:
producer - the producer string

toPDF

public byte[] toPDF()
produce the PDF representation of the object
Returns: the PDF

Association Links

to Class java.lang.String

the application producing the PDF
\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFInternalLink.html b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFInternalLink.html new file mode 100755 index 000000000..6abb2756d --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFInternalLink.html @@ -0,0 +1,6 @@ +

org.apache.fop.pdf
Class PDFInternalLink

org.apache.fop.pdf.PDFObject
+  |
+  +--org.apache.fop.pdf.PDFAction
+        |
+        +--org.apache.fop.pdf.PDFInternalLink
+
public class PDFInternalLink
extends PDFAction

class used to create a PDF internal link

Field Summary
 (package private) StringgoToReference
           

Constructor Summary
PDFInternalLink(String goToReference)
          create an internal link instance.

Method Summary
 StringgetAction()
          returns the action ncecessary for an internal link
 byte[]toPDF()
          there is nothing to return for the toPDF method, as it should not be called

Methods inherited from class org.apache.fop.pdf.PDFObject
getNumber, referencePDF

Field Detail

goToReference

String goToReference
Constructor Detail

PDFInternalLink

public PDFInternalLink(String goToReference)
create an internal link instance.
Parameters:
goToReference - the GoTo Reference to which the link should point
Method Detail

getAction

public String getAction()
returns the action ncecessary for an internal link
Returns: the action to place next to /A within a Link

toPDF

public byte[] toPDF()
there is nothing to return for the toPDF method, as it should not be called
Returns: an empty string

Association Links

to Class java.lang.String

\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFLink.html b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFLink.html new file mode 100755 index 000000000..232ba4db4 --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFLink.html @@ -0,0 +1,4 @@ +

org.apache.fop.pdf
Class PDFLink

org.apache.fop.pdf.PDFObject
+  |
+  +--org.apache.fop.pdf.PDFLink
+
public class PDFLink
extends PDFObject

class representing an /Annot object of /Subtype /Link

Field Summary
 (package private) PDFActionaction
           
 (package private) floatbrx
           
 (package private) floatbry
           
 (package private) Stringcolor
           
 (package private) floatulx
           
 (package private) floatuly
           

Constructor Summary
PDFLink(int number, Rectangle r)
          create objects associated with a link annotation (GoToR)

Method Summary
 voidsetAction(PDFAction action)
           
 byte[]toPDF()
          produce the PDF representation of the object

Methods inherited from class org.apache.fop.pdf.PDFObject
getNumber, referencePDF

Field Detail

action

PDFAction action

brx

float brx

bry

float bry

color

String color

ulx

float ulx

uly

float uly
Constructor Detail

PDFLink

public PDFLink(int number, Rectangle r)
create objects associated with a link annotation (GoToR)
Parameters:
number - the object's number
producer - the application producing the PDF
Method Detail

setAction

public void setAction(PDFAction action)

toPDF

public byte[] toPDF()
produce the PDF representation of the object
Returns: the PDF

Association Links

to Class java.lang.String

to Class org.apache.fop.pdf.PDFAction

\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFNumber.html b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFNumber.html new file mode 100755 index 000000000..ed9511d0c --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFNumber.html @@ -0,0 +1 @@ +

org.apache.fop.pdf
Class PDFNumber

public class PDFNumber

Constructor Summary
PDFNumber()
           

Method Summary
 StringdoubleOut(Double doubleDown)
           
 StringdoubleOut(double doubleDown)
           

Constructor Detail

PDFNumber

public PDFNumber()
Method Detail

doubleOut

public String doubleOut(Double doubleDown)

doubleOut

public String doubleOut(double doubleDown)
\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFObject.html b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFObject.html new file mode 100755 index 000000000..217e9e986 --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFObject.html @@ -0,0 +1,5 @@ +

org.apache.fop.pdf
Class PDFObject

Direct Known Subclasses:
PDFAction, PDFAnnotList, PDFArray, PDFEncoding, PDFFileSpec, PDFFont, PDFFontDescriptor, PDFFunction, PDFGoTo, PDFInfo, PDFLink, PDFPage, PDFPages, PDFPathPaint, PDFResources, PDFRoot, PDFShading, PDFStream, PDFXObject
public abstract class PDFObject

generic PDF object. + +A PDF Document is essentially a collection of these objects. A PDF +Object has a number and a generation (although the generation will always +be 0 in new documents).

Constructor Summary
PDFObject(int number)
          create an empty object
PDFObject()
           

Method Summary
 intgetNumber()
           
 StringreferencePDF()
          the PDF representation of a reference to this object
 (package private) abstract byte[]toPDF()
          represent object as PDF

Constructor Detail

PDFObject

public PDFObject(int number)
create an empty object
Parameters:
number - the object's number

PDFObject

public PDFObject()
Method Detail

getNumber

public int getNumber()
Returns: the PDF Object number

referencePDF

public String referencePDF()
the PDF representation of a reference to this object
Returns: the reference string

toPDF

abstract byte[] toPDF()
represent object as PDF
Returns: PDF string
\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFPage.html b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFPage.html new file mode 100755 index 000000000..f6d060941 --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFPage.html @@ -0,0 +1,9 @@ +

org.apache.fop.pdf
Class PDFPage

org.apache.fop.pdf.PDFObject
+  |
+  +--org.apache.fop.pdf.PDFPage
+
public class PDFPage
extends PDFObject

class representing a /Page object. + +There is one of these for every page in a PDF document. The object +specifies the dimensions of the page and references a /Resources +object, a contents stream and the page's parent in the page +hierarchy.

Constructor Summary
PDFPage(int number, PDFResources resources, PDFStream contents, int pagewidth, int pageheight)
          create a /Page object

Method Summary
 voidaddShading(PDFShading shading)
           
 PDFAnnotListgetAnnotList()
          get this page's annotation list
 voidsetAnnotList(PDFAnnotList annotList)
          set this page's annotation list
 voidsetParent(PDFPages parent)
          set this page's parent
 byte[]toPDF()
          represent this object as PDF

Methods inherited from class org.apache.fop.pdf.PDFObject
getNumber, referencePDF

Constructor Detail

PDFPage

public PDFPage(int number, PDFResources resources, PDFStream contents, int pagewidth, int pageheight)
create a /Page object
Parameters:
number - the object's number
resources - the /Resources object
contents - the content stream
pagewidth - the page's width in points
pageheight - the page's height in points
Method Detail

addShading

public void addShading(PDFShading shading)

getAnnotList

public PDFAnnotList getAnnotList()
get this page's annotation list
Returns: annotList a PDFAnnotList list of annotations

setAnnotList

public void setAnnotList(PDFAnnotList annotList)
set this page's annotation list
Parameters:
annotList - a PDFAnnotList list of annotations

setParent

public void setParent(PDFPages parent)
set this page's parent
Parameters:
parent - the /Pages object that is this page's parent

toPDF

public byte[] toPDF()
represent this object as PDF
Returns: the PDF string

Association Links

to Class org.apache.fop.pdf.PDFPages

the page's parent, a /Pages object

to Class org.apache.fop.pdf.PDFResources

the page's /Resource object

to Class org.apache.fop.pdf.PDFStream

the contents stream

to Class org.apache.fop.pdf.PDFAnnotList

the list of annotation objects for this page
\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFPages.html b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFPages.html new file mode 100755 index 000000000..c3d3f302b --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFPages.html @@ -0,0 +1,8 @@ +

org.apache.fop.pdf
Class PDFPages

org.apache.fop.pdf.PDFObject
+  |
+  +--org.apache.fop.pdf.PDFPages
+
public class PDFPages
extends PDFObject

class representing a /Pages object. + +A /Pages object is an ordered collection of pages (/Page objects) +(Actually, /Pages can contain further /Pages as well but this +implementation doesn't allow this)

Constructor Summary
PDFPages(int number)
          create a /Pages object.

Method Summary
 voidaddPage(PDFPage page)
          add a /Page object.
 intgetCount()
          get the count of /Page objects
 voidincrementCount()
          increment the count of /Page objects
 byte[]toPDF()
          represent the object in PDF

Methods inherited from class org.apache.fop.pdf.PDFObject
getNumber, referencePDF

Constructor Detail

PDFPages

public PDFPages(int number)
create a /Pages object.
Parameters:
number - the object's number
Method Detail

addPage

public void addPage(PDFPage page)
add a /Page object.
Parameters:
page - the PDFPage to add.

getCount

public int getCount()
get the count of /Page objects
Returns: the number of pages

incrementCount

public void incrementCount()
increment the count of /Page objects

toPDF

public byte[] toPDF()
represent the object in PDF
Returns: the PDF string

Association Links

to Class java.util.Vector

the /Page objects
\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFPathPaint.html b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFPathPaint.html new file mode 100755 index 000000000..6482f23e6 --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFPathPaint.html @@ -0,0 +1,4 @@ +

org.apache.fop.pdf
Class PDFPathPaint

org.apache.fop.pdf.PDFObject
+  |
+  +--org.apache.fop.pdf.PDFPathPaint
+
Direct Known Subclasses:
PDFColor, PDFPattern
public abstract class PDFPathPaint
extends PDFObject

Constructor Summary
PDFPathPaint(int theNumber)
           
PDFPathPaint()
           

Method Summary
 intgetColorSpace()
           
 StringgetColorSpaceOut(boolean fillNotStroke)
           
 voidsetColorSpace(int theColorSpace)
           

Methods inherited from class org.apache.fop.pdf.PDFObject
getNumber, referencePDF, toPDF

Constructor Detail

PDFPathPaint

public PDFPathPaint(int theNumber)

PDFPathPaint

public PDFPathPaint()
Method Detail

getColorSpace

public int getColorSpace()

getColorSpaceOut

public String getColorSpaceOut(boolean fillNotStroke)

setColorSpace

public void setColorSpace(int theColorSpace)

Association Links

to Class org.apache.fop.datatypes.ColorSpace

\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFPattern.html b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFPattern.html new file mode 100755 index 000000000..cfa54aadd --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFPattern.html @@ -0,0 +1,20 @@ +

org.apache.fop.pdf
Class PDFPattern

org.apache.fop.pdf.PDFObject
+  |
+  +--org.apache.fop.pdf.PDFPathPaint
+        |
+        +--org.apache.fop.pdf.PDFPattern
+
public class PDFPattern
extends PDFPathPaint

class representing a PDF Function. + +PDF Functions represent parameterized mathematical formulas and sampled representations with +arbitrary resolution. Functions are used in two areas: device-dependent +rasterization information for halftoning and transfer +functions, and color specification for smooth shading (a PDF 1.3 feature). + +All PDF Functions have a FunctionType (0,2,3, or 4), a Domain, and a Range.

Constructor Summary
PDFPattern(int theNumber, String thePatternName, PDFResources theResources, int thePatternType, int thePaintType, int theTilingType, Vector theBBox, double theXStep, double theYStep, Vector theMatrix, Vector theXUID, StringBuffer thePatternDataStream)
          Create a tiling pattern (type 1).
PDFPattern(int theNumber, String thePatternName, int thePatternType, PDFShading theShading, Vector theXUID, StringBuffer theExtGState, Vector theMatrix)
          Create a type 2 pattern (smooth shading)

Method Summary
 StringgetColorSpaceOut(boolean fillNotStroke)
           
 StringgetName()
          Get the name of the pattern
 byte[]toPDF()
          represent as PDF.

Methods inherited from class org.apache.fop.pdf.PDFPathPaint
getColorSpace, setColorSpace

Methods inherited from class org.apache.fop.pdf.PDFObject
getNumber, referencePDF

Constructor Detail

PDFPattern

public PDFPattern(int theNumber, String thePatternName, PDFResources theResources, int thePatternType, int thePaintType, int theTilingType, Vector theBBox, double theXStep, double theYStep, Vector theMatrix, Vector theXUID, StringBuffer thePatternDataStream)
Create a tiling pattern (type 1).
Parameters:
theNumber - The object number of this PDF Object
thePatternName - The name of the pattern such as "Pa1" or "Pattern1"
theResources - the resources associated with this pattern
thePatternType - the type of pattern, which is 1 for tiling.
thePaintType - 1 or 2, colored or uncolored.
theTilingType - 1, 2, or 3, constant spacing, no distortion, or faster tiling
theBBox - Vector of Doubles: The pattern cell bounding box
theXStep - horizontal spacing
theYStep - vertical spacing
theMatrix - Optional Vector of Doubles transformation matrix
theXUID - Optional vector of Integers that uniquely identify the pattern
thePatternDataStream - The stream of pattern data to be tiled.

PDFPattern

public PDFPattern(int theNumber, String thePatternName, int thePatternType, PDFShading theShading, Vector theXUID, StringBuffer theExtGState, Vector theMatrix)
Create a type 2 pattern (smooth shading)
Parameters:
theNumber - the object number of this PDF object
thePatternName - the name of the pattern
thePatternType - the type of the pattern, which is 2, smooth shading
theShading - the PDF Shading object that comprises this pattern
theXUID - optional:the extended unique Identifier if used.
theExtGState - optional: the extended graphics state, if used.
theMatrix - Optional:Vector of Doubles that specify the matrix.
Method Detail

getColorSpaceOut

public String getColorSpaceOut(boolean fillNotStroke)

getName

public String getName()
Get the name of the pattern
Returns: String representing the name of the pattern.

toPDF

public byte[] toPDF()
represent as PDF. Whatever the FunctionType is, the correct +representation spits out. The sets of required and optional +attributes are different for each type, but if a required +attribute's object was constructed as null, then no error +is raised. Instead, the malformed PDF that was requested +by the construction is dutifully output. +This policy should be reviewed.
Returns: the PDF string.

Association Links

to Class org.apache.fop.pdf.PDFNumber

to Class org.apache.fop.pdf.PDFResources

The resources associated with this pattern

to Class java.lang.String

The name of the pattern such as "Pa1" or "Pattern1"

to Class java.util.Vector

Vector of Doubles representing the Bounding box rectangle

to Class org.apache.fop.pdf.PDFShading

The Shading object comprising the Type 2 pattern

to Class java.util.Vector

Vector of Integers represetning the Extended unique Identifier

to Class java.lang.StringBuffer

String representing the extended Graphics state. +Probably will never be used like this.

to Class java.util.Vector

Vector of Doubles representing the Transformation matrix.

to Class java.lang.StringBuffer

The stream of a pattern
\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFRectangle.html b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFRectangle.html new file mode 100755 index 000000000..50c588053 --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFRectangle.html @@ -0,0 +1,3 @@ +

org.apache.fop.pdf
Class PDFRectangle

public class PDFRectangle

class representing a rectangle + +Rectangles are specified on page 183 of the PDF 1.3 spec.

Constructor Summary
PDFRectangle(int llx, int lly, int urx, int ury)
          create a rectangle giving the four separate values
PDFRectangle(int[] array)
          create a rectangle giving an array of four values

Method Summary
 byte[]toPDF()
          produce the PDF representation for the object

Constructor Detail

PDFRectangle

public PDFRectangle(int llx, int lly, int urx, int ury)
create a rectangle giving the four separate values
Parameters:
llx - lower left x coordinate
lly - lower left y coordinate
urx - upper right x coordinate
ury - upper right y coordinate

PDFRectangle

public PDFRectangle(int[] array)
create a rectangle giving an array of four values
Parameters:
array - values in the order llx, lly, urx, ury
Method Detail

toPDF

public byte[] toPDF()
produce the PDF representation for the object
Returns: the PDF
\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFResources.html b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFResources.html new file mode 100755 index 000000000..7b902d080 --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFResources.html @@ -0,0 +1,7 @@ +

org.apache.fop.pdf
Class PDFResources

org.apache.fop.pdf.PDFObject
+  |
+  +--org.apache.fop.pdf.PDFResources
+
public class PDFResources
extends PDFObject

class representing a /Resources object. + +/Resources object contain a list of references to the fonts for the +document

Constructor Summary
PDFResources(int number)
          create a /Resources object.

Method Summary
 voidaddFont(PDFFont font)
          add font object to resources list.
 voidaddPattern(PDFPattern thePattern)
           
 voidaddShading(PDFShading theShading)
           
 voidsetXObjects(Vector xObjects)
           
 byte[]toPDF()
          represent the object in PDF

Methods inherited from class org.apache.fop.pdf.PDFObject
getNumber, referencePDF

Constructor Detail

PDFResources

public PDFResources(int number)
create a /Resources object.
Parameters:
number - the object's number
Method Detail

addFont

public void addFont(PDFFont font)
add font object to resources list.
Parameters:
font - the PDFFont to add

addPattern

public void addPattern(PDFPattern thePattern)

addShading

public void addShading(PDFShading theShading)

setXObjects

public void setXObjects(Vector xObjects)

toPDF

public byte[] toPDF()
represent the object in PDF
Returns: the PDF

Association Links

to Class java.util.Hashtable

/Font objects keyed by their internal name

to Class java.util.Vector

to Class java.util.Vector

to Class java.util.Vector

\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFRoot.html b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFRoot.html new file mode 100755 index 000000000..ae89d19a3 --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFRoot.html @@ -0,0 +1,4 @@ +

org.apache.fop.pdf
Class PDFRoot

org.apache.fop.pdf.PDFObject
+  |
+  +--org.apache.fop.pdf.PDFRoot
+
public class PDFRoot
extends PDFObject

class representing a Root (/Catalog) object

Constructor Summary
PDFRoot(int number)
          create a Root (/Catalog) object

Method Summary
 voidaddPage(PDFPage page)
          add a /Page object to the root /Pages object
 voidsetRootPages(PDFPages pages)
          set the root /Pages object
 byte[]toPDF()
          represent the object as PDF

Methods inherited from class org.apache.fop.pdf.PDFObject
getNumber, referencePDF

Constructor Detail

PDFRoot

public PDFRoot(int number)
create a Root (/Catalog) object
Parameters:
number - the object's number
Method Detail

addPage

public void addPage(PDFPage page)
add a /Page object to the root /Pages object
Parameters:
page - the /Page object to add

setRootPages

public void setRootPages(PDFPages pages)
set the root /Pages object
Parameters:
pages - the /Pages object to set as root

toPDF

public byte[] toPDF()
represent the object as PDF
Returns: the PDF string

Association Links

to Class org.apache.fop.pdf.PDFPages

the /Pages object that is root of the Pages hierarchy
\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFShading.html b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFShading.html new file mode 100755 index 000000000..ce9f3e955 --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFShading.html @@ -0,0 +1,59 @@ +

org.apache.fop.pdf
Class PDFShading

org.apache.fop.pdf.PDFObject
+  |
+  +--org.apache.fop.pdf.PDFShading
+
public class PDFShading
extends PDFObject

class representing a PDF Smooth Shading object. + +PDF Functions represent parameterized mathematical formulas and sampled representations with +arbitrary resolution. Functions are used in two areas: device-dependent +rasterization information for halftoning and transfer +functions, and color specification for smooth shading (a PDF 1.3 feature). + +All PDF Functions have a shadingType (0,2,3, or 4), a Domain, and a Range.

Constructor Summary
PDFShading(int theNumber, String theShadingName, int theShadingType, ColorSpace theColorSpace, Vector theBackground, Vector theBBox, boolean theAntiAlias, Vector theDomain, Vector theMatrix, PDFFunction theFunction)
          Constructor for type function based shading
PDFShading(int theNumber, String theShadingName, int theShadingType, ColorSpace theColorSpace, Vector theBackground, Vector theBBox, boolean theAntiAlias, Vector theCoords, Vector theDomain, PDFFunction theFunction, Vector theExtend)
          Constructor for Type 2 and 3
PDFShading(int theNumber, String theShadingName, int theShadingType, ColorSpace theColorSpace, Vector theBackground, Vector theBBox, boolean theAntiAlias, int theBitsPerCoordinate, int theBitsPerComponent, int theBitsPerFlag, Vector theDecode, PDFFunction theFunction)
          Constructor for Type 4,6, or 7
PDFShading(int theNumber, String theShadingName, int theShadingType, ColorSpace theColorSpace, Vector theBackground, Vector theBBox, boolean theAntiAlias, int theBitsPerCoordinate, int theBitsPerComponent, Vector theDecode, int theVerticesPerRow, PDFFunction theFunction)
          Constructor for type 5

Method Summary
 StringgetName()
           
 byte[]toPDF()
          represent as PDF.

Methods inherited from class org.apache.fop.pdf.PDFObject
getNumber, referencePDF

Constructor Detail

PDFShading

public PDFShading(int theNumber, String theShadingName, int theShadingType, ColorSpace theColorSpace, Vector theBackground, Vector theBBox, boolean theAntiAlias, Vector theDomain, Vector theMatrix, PDFFunction theFunction)
Constructor for type function based shading
Parameters:
theNumber - The object number of this PDF object
theShadingName - The name of the shading pattern. Can be anything +without spaces. "Shading1" or "Sh1" are good examples.
theShadingType - The type of shading object, which should be 1 for function +based shading.
theColorSpace - The colorspace is 'DeviceRGB' or something similar.
theBackground - An array of color components appropriate to the +colorspace key specifying a single color value. +This key is used by the f operator buy ignored by the sh operator.
theBBox - Vector of double's representing a rectangle +in the coordinate space that is current at the +time of shading is imaged. Temporary clipping +boundary.
theAntiAlias - Whether or not to anti-alias.
theDomain - Optional vector of Doubles specifying the domain.
theMatrix - Vector of Doubles specifying the matrix. +If it's a pattern, then the matrix maps it to pattern space. +If it's a shading, then it maps it to current user space. +It's optional, the default is the identity matrix
theFunction - The PDF Function that maps an (x,y) location to a color

PDFShading

public PDFShading(int theNumber, String theShadingName, int theShadingType, ColorSpace theColorSpace, Vector theBackground, Vector theBBox, boolean theAntiAlias, Vector theCoords, Vector theDomain, PDFFunction theFunction, Vector theExtend)
Constructor for Type 2 and 3
Parameters:
theNumber - The object number of this PDF object.
theShadingName - The name of the shading pattern. Can be anything +without spaces. "Shading1" or "Sh1" are good examples.
theShadingType - 2 or 3 for axial or radial shading
theColorSpace - "DeviceRGB" or similar.
theBackground - theBackground An array of color components appropriate to the +colorspace key specifying a single color value. +This key is used by the f operator buy ignored by the sh operator.
theBBox - Vector of double's representing a rectangle +in the coordinate space that is current at the +time of shading is imaged. Temporary clipping +boundary.
theAntiAlias - Default is false
theCoords - Vector of four (type 2) or 6 (type 3) Double
theDomain - Vector of Doubles specifying the domain
theFunction - the Stitching (PDFfunction type 3) function, even if it's stitching a single function
theExtend - Vector of Booleans of whether to extend teh start and end colors past the start and end points +The default is [false, false]

PDFShading

public PDFShading(int theNumber, String theShadingName, int theShadingType, ColorSpace theColorSpace, Vector theBackground, Vector theBBox, boolean theAntiAlias, int theBitsPerCoordinate, int theBitsPerComponent, int theBitsPerFlag, Vector theDecode, PDFFunction theFunction)
Constructor for Type 4,6, or 7
Parameters:
theNumber - The object number of this PDF object.
theShadingType - 4, 6, or 7 depending on whether it's +Free-form gouraud-shaded triangle meshes, coons patch meshes, +or tensor product patch meshes, respectively.
theShadingName - The name of the shading pattern. Can be anything +without spaces. "Shading1" or "Sh1" are good examples.
theColorSpace - "DeviceRGB" or similar.
theBackground - theBackground An array of color components appropriate to the +colorspace key specifying a single color value. +This key is used by the f operator buy ignored by the sh operator.
theBBox - Vector of double's representing a rectangle +in the coordinate space that is current at the +time of shading is imaged. Temporary clipping +boundary.
theAntiAlias - Default is false
theBitsPerCoordinate - 1,2,4,8,12,16,24 or 32.
theBitsPerComponent - 1,2,4,8,12, and 16
theBitsPerFlag - 2,4,8.
theDecode - Vector of Doubles see PDF 1.3 spec pages 303 to 312.
theFunction - the PDFFunction

PDFShading

public PDFShading(int theNumber, String theShadingName, int theShadingType, ColorSpace theColorSpace, Vector theBackground, Vector theBBox, boolean theAntiAlias, int theBitsPerCoordinate, int theBitsPerComponent, Vector theDecode, int theVerticesPerRow, PDFFunction theFunction)
Constructor for type 5
Parameters:
theShadingType - 5 for lattice-Form Gouraud shaded-triangle mesh
theShadingName - The name of the shading pattern. Can be anything +without spaces. "Shading1" or "Sh1" are good examples.
theColorSpace - "DeviceRGB" or similar.
theBackground - theBackground An array of color components appropriate to the +colorspace key specifying a single color value. +This key is used by the f operator buy ignored by the sh operator.
theBBox - Vector of double's representing a rectangle +in the coordinate space that is current at the +time of shading is imaged. Temporary clipping +boundary.
theAntiAlias - Default is false
theBitsPerCoordinate - 1,2,4,8,12,16, 24, or 32
theBitsPerComponent - 1,2,4,8,12,24,32
theDecode - Vector of Doubles. See page 305 in PDF 1.3 spec.
theVerticesPerRow - number of vertices in each "row" of the lattice.
theFunction - The PDFFunction that's mapped on to this shape
theNumber - the object number of this PDF object.
Method Detail

getName

public String getName()

toPDF

public byte[] toPDF()
represent as PDF. Whatever the shadingType is, the correct +representation spits out. The sets of required and optional +attributes are different for each type, but if a required +attribute's object was constructed as null, then no error +is raised. Instead, the malformed PDF that was requested +by the construction is dutifully output. +This policy should be reviewed.
Returns: the PDF string.

Association Links

to Class java.lang.String

The name of the Shading e.g. "Shading1"

to Class org.apache.fop.datatypes.ColorSpace

A ColorSpace representing the colorspace. "DeviceRGB" is an example.

to Class java.util.Vector

The background color. Since shading is opaque, +this is very rarely used.

to Class java.util.Vector

Optional: A Vector specifying the clipping rectangle

to Class java.util.Vector

Optional for Type 1: Array of four numbers, xmin, xmax, ymin, ymax. Default is [0 1 0 1] +Optional for Type 2: An array of two numbers between which the blend varies between start and end points. Default is 0, 1. +Optional for Type 3: An array of two numbers between which the blend varies between start and end points. Default is 0, 1.

to Class java.util.Vector

Optional for Type 1: A transformation matrix

to Class org.apache.fop.pdf.PDFFunction

Required for Type 1, 2, and 3: +The object of the color mapping function (usually type 2 or 3). +Optional for Type 4,5,6, and 7: When it's nearly the same thing.

to Class java.util.Vector

Required for Type 2: An Array of four numbers specifying the starting and ending coordinate pairs +Required for Type 3: An Array of six numbers [x0,y0,r0,x1,y1,r1] specifying the centers and radii of +the starting and ending circles.

to Class java.util.Vector

Required for Type 2+3: An Array of two boolean values specifying whether to extend the +start and end colors past the start and end points, +respectively. Default is false, false.

to Class java.util.Vector

Required for Type 4,5,6, and 7: Array of Doubles which specifies how to decode coordinate and color component values. +Each type has a differing number of decode array members, so check the spec. +Page 303 in PDF Spec 1.3

to Class org.apache.fop.pdf.PDFNumber

\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFStream.html b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFStream.html new file mode 100755 index 000000000..9d3577f1f --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFStream.html @@ -0,0 +1,13 @@ +

org.apache.fop.pdf
Class PDFStream

org.apache.fop.pdf.PDFObject
+  |
+  +--org.apache.fop.pdf.PDFStream
+
public class PDFStream
extends PDFObject

class representing a PDF stream. + +A derivative of the PDF Object, a PDF Stream has not only a dictionary +but a stream of PDF commands. The stream of commands is where the real +work is done, the dictionary just provides information like the stream +length.

Constructor Summary
PDFStream(int number)
          create an empty stream object

Method Summary
 voidadd(String s)
          append data to the stream
 voidaddFilter(PDFFilter filter)
          Add a filter for compression of the stream.
 voidaddFilter(String filterType)
           
 voidaddImageArray(int[] pixels, int width, int height)
          append an array of xRGB pixels, ASCII Hex Encoding it first
 byte[]getData()
           
 intgetDataLength()
           
 voidsetData(byte[] data)
           
 byte[]toPDF()
          represent as PDF.

Methods inherited from class org.apache.fop.pdf.PDFObject
getNumber, referencePDF

Constructor Detail

PDFStream

public PDFStream(int number)
create an empty stream object
Parameters:
number - the object's number
Method Detail

add

public void add(String s)
append data to the stream
Parameters:
s - the string of PDF to add

addFilter

public void addFilter(PDFFilter filter)
Add a filter for compression of the stream. Filters are +applied in the order they are added. This should always be a +new instance of the particular filter of choice. The applied +flag in the filter is marked true after it has been applied to the +data.

addFilter

public void addFilter(String filterType)

addImageArray

public void addImageArray(int[] pixels, int width, int height)
append an array of xRGB pixels, ASCII Hex Encoding it first
Parameters:
pixels - the area of pixels
width - the width of the image in pixels
height - the height of the image in pixels

getData

public byte[] getData()

getDataLength

public int getDataLength()

setData

public void setData(byte[] data)
              throws java.io.IOException

toPDF

public byte[] toPDF()
represent as PDF.
Returns: the PDF string.

Association Links

to Class java.io.ByteArrayOutputStream

the stream of PDF commands

to Class java.util.Vector

the filters that should be applied
\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFUri.html b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFUri.html new file mode 100755 index 000000000..951ae2060 --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFUri.html @@ -0,0 +1,6 @@ +

org.apache.fop.pdf
Class PDFUri

org.apache.fop.pdf.PDFObject
+  |
+  +--org.apache.fop.pdf.PDFAction
+        |
+        +--org.apache.fop.pdf.PDFUri
+
public class PDFUri
extends PDFAction

class used to create a PDF Uri link

Field Summary
 (package private) Stringuri
           

Constructor Summary
PDFUri(String uri)
          create a Uri instance.

Method Summary
 StringgetAction()
          returns the action ncecessary for a uri
 byte[]toPDF()
          there is nothing to return for the toPDF method, as it should not be called

Methods inherited from class org.apache.fop.pdf.PDFObject
getNumber, referencePDF

Field Detail

uri

String uri
Constructor Detail

PDFUri

public PDFUri(String uri)
create a Uri instance.
Parameters:
uri - the uri to which the link should point
Method Detail

getAction

public String getAction()
returns the action ncecessary for a uri
Returns: the action to place next to /A within a Link

toPDF

public byte[] toPDF()
there is nothing to return for the toPDF method, as it should not be called
Returns: an empty string

Association Links

to Class java.lang.String

\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/PDFXObject.html b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFXObject.html new file mode 100755 index 000000000..40cf0a644 --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/PDFXObject.html @@ -0,0 +1,10 @@ +

org.apache.fop.pdf
Class PDFXObject

org.apache.fop.pdf.PDFObject
+  |
+  +--org.apache.fop.pdf.PDFXObject
+
public class PDFXObject
extends PDFObject

PDF XObject + +A derivative of the PDF Object, is a PDF Stream that has not only a +dictionary but a stream of image data. +the dictionary just provides information like the stream length

Field Summary
 (package private) FopImagefopimage
           
 (package private) intXnum
           

Constructor Summary
PDFXObject(int number, int Xnumber, FopImage img)
          create an Xobject with the given number and name and load the +image in the object

Method Summary
 intgetXNumber()
           
 (package private) byte[]toPDF()
           

Methods inherited from class org.apache.fop.pdf.PDFObject
getNumber, referencePDF

Field Detail

fopimage

FopImage fopimage

Xnum

int Xnum
Constructor Detail

PDFXObject

public PDFXObject(int number, int Xnumber, FopImage img)
create an Xobject with the given number and name and load the +image in the object
Method Detail

getXNumber

public int getXNumber()
Returns: the PDF XObject number

toPDF

byte[] toPDF()

Association Links

to Class org.apache.fop.image.FopImage

\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/ASCII85Filter.html b/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/ASCII85Filter.html new file mode 100755 index 000000000..ba26d192d --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/ASCII85Filter.html @@ -0,0 +1 @@ +

Uses of Class
org.apache.fop.pdf.ASCII85Filter

No usage of org.apache.fop.pdf.ASCII85Filter
\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/ASCIIHexFilter.html b/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/ASCIIHexFilter.html new file mode 100755 index 000000000..6a15cd5ee --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/ASCIIHexFilter.html @@ -0,0 +1 @@ +

Uses of Class
org.apache.fop.pdf.ASCIIHexFilter

No usage of org.apache.fop.pdf.ASCIIHexFilter
\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/FlateFilter.html b/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/FlateFilter.html new file mode 100755 index 000000000..7eff6d54f --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/FlateFilter.html @@ -0,0 +1 @@ +

Uses of Class
org.apache.fop.pdf.FlateFilter

No usage of org.apache.fop.pdf.FlateFilter
\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFAction.html b/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFAction.html new file mode 100755 index 000000000..cf90bd124 --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFAction.html @@ -0,0 +1 @@ +

Uses of Class
org.apache.fop.pdf.PDFAction

Packages that use PDFAction
org.apache.fop.pdf 

Uses of PDFAction in org.apache.fop.pdf
 

Subclasses of PDFAction in org.apache.fop.pdf
class PDFGoToRemote
          class representing a /GoToR object.
class PDFInternalLink
          class used to create a PDF internal link
class PDFUri
          class used to create a PDF Uri link
 

Fields in org.apache.fop.pdf declared as PDFAction
(package private) PDFActionPDFLink.action
          
 

Methods in org.apache.fop.pdf with parameters of type PDFAction
voidPDFLink.setAction(PDFAction action)
          
 

\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFAnnotList.html b/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFAnnotList.html new file mode 100755 index 000000000..949a13888 --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFAnnotList.html @@ -0,0 +1 @@ +

Uses of Class
org.apache.fop.pdf.PDFAnnotList

Packages that use PDFAnnotList
org.apache.fop.pdf 

Uses of PDFAnnotList in org.apache.fop.pdf
 

Methods in org.apache.fop.pdf that return PDFAnnotList
PDFAnnotListPDFDocument.makeAnnotList()
          make an annotation list object
PDFAnnotListPDFPage.getAnnotList()
          get this page's annotation list
 

Methods in org.apache.fop.pdf with parameters of type PDFAnnotList
voidPDFPage.setAnnotList(PDFAnnotList annotList)
          set this page's annotation list
 

\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFArray.html b/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFArray.html new file mode 100755 index 000000000..bbff8b092 --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFArray.html @@ -0,0 +1,2 @@ +

Uses of Class
org.apache.fop.pdf.PDFArray

Packages that use PDFArray
org.apache.fop.pdf 

Uses of PDFArray in org.apache.fop.pdf
 

Methods in org.apache.fop.pdf that return PDFArray
PDFArrayPDFDocument.makeArray(int[] values)
          make an Array object (ex.
 

Methods in org.apache.fop.pdf with parameters of type PDFArray
static PDFFontPDFFont.createFont(int number, String fontname, byte subtype, String basefont, Object encoding, int firstChar, int lastChar, PDFArray widths, PDFFontDescriptor descriptor)
          factory method with the extended parameters +for Type1, MMType1 and TrueType
voidPDFFontNonBase14.setWidthMetrics(int firstChar, int lastChar, PDFArray widths)
          set the width metrics for the font
 

\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFColor.html b/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFColor.html new file mode 100755 index 000000000..d3b05195b --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFColor.html @@ -0,0 +1 @@ +

Uses of Class
org.apache.fop.pdf.PDFColor

No usage of org.apache.fop.pdf.PDFColor
\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFDocument.html b/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFDocument.html new file mode 100755 index 000000000..4fa0aa7bf --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFDocument.html @@ -0,0 +1 @@ +

Uses of Class
org.apache.fop.pdf.PDFDocument

No usage of org.apache.fop.pdf.PDFDocument
\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFEncoding.html b/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFEncoding.html new file mode 100755 index 000000000..b4c53b405 --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFEncoding.html @@ -0,0 +1 @@ +

Uses of Class
org.apache.fop.pdf.PDFEncoding

Packages that use PDFEncoding
org.apache.fop.pdf 

Uses of PDFEncoding in org.apache.fop.pdf
 

Methods in org.apache.fop.pdf that return PDFEncoding
PDFEncodingPDFDocument.makeEncoding(String encodingName)
          make a /Encoding object
 

\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFFileSpec.html b/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFFileSpec.html new file mode 100755 index 000000000..7248c5e85 --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFFileSpec.html @@ -0,0 +1 @@ +

Uses of Class
org.apache.fop.pdf.PDFFileSpec

Packages that use PDFFileSpec
org.apache.fop.pdf 

Uses of PDFFileSpec in org.apache.fop.pdf
 

Constructors in org.apache.fop.pdf with parameters of type PDFFileSpec
PDFGoToRemote.PDFGoToRemote(int number, PDFFileSpec pdfFileSpec)
          create an GoToR object.
 

\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFFilter.html b/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFFilter.html new file mode 100755 index 000000000..85ba33aa9 --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFFilter.html @@ -0,0 +1 @@ +

Uses of Class
org.apache.fop.pdf.PDFFilter

Packages that use PDFFilter
org.apache.fop.pdf 

Uses of PDFFilter in org.apache.fop.pdf
 

Subclasses of PDFFilter in org.apache.fop.pdf
class ASCII85Filter
          
class ASCIIHexFilter
          
class FlateFilter
          A filter to deflate a stream.
 

Methods in org.apache.fop.pdf with parameters of type PDFFilter
voidPDFStream.addFilter(PDFFilter filter)
          Add a filter for compression of the stream.
 

\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFFilterException.html b/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFFilterException.html new file mode 100755 index 000000000..9dd2e7efa --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFFilterException.html @@ -0,0 +1 @@ +

Uses of Class
org.apache.fop.pdf.PDFFilterException

Packages that use PDFFilterException
org.apache.fop.pdf 

Uses of PDFFilterException in org.apache.fop.pdf
 

Methods in org.apache.fop.pdf that throw PDFFilterException
voidFlateFilter.setBitsPerComponent(int bits)
          
voidFlateFilter.setColors(int colors)
          
voidFlateFilter.setColumns(int columns)
          
voidFlateFilter.setPredictor(int predictor)
          
 

\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFFont.html b/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFFont.html new file mode 100755 index 000000000..e994ce685 --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFFont.html @@ -0,0 +1,3 @@ +

Uses of Class
org.apache.fop.pdf.PDFFont

Packages that use PDFFont
org.apache.fop.pdf 

Uses of PDFFont in org.apache.fop.pdf
 

Subclasses of PDFFont in org.apache.fop.pdf
class PDFFontNonBase14
          A common ancestor for Type1, TrueType, MMType1 and Type3 fonts +(all except base 14 fonts).
 

Methods in org.apache.fop.pdf that return PDFFont
PDFFontPDFDocument.makeFont(String fontname, String basefont, String encoding, FontMetric metrics, FontDescriptor descriptor)
          make a Type1 /Font object
static PDFFontPDFFont.createFont(int number, String fontname, byte subtype, String basefont, Object encoding, int firstChar, int lastChar, PDFArray widths, PDFFontDescriptor descriptor)
          factory method with the extended parameters +for Type1, MMType1 and TrueType
static PDFFontPDFFont.createFont(int number, String fontname, byte subtype, String basefont, Object encoding)
          factory method with the basic parameters
 

Methods in org.apache.fop.pdf with parameters of type PDFFont
voidPDFResources.addFont(PDFFont font)
          add font object to resources list.
 

\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFFontDescriptor.html b/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFFontDescriptor.html new file mode 100755 index 000000000..733e41c04 --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFFontDescriptor.html @@ -0,0 +1,2 @@ +

Uses of Class
org.apache.fop.pdf.PDFFontDescriptor

Packages that use PDFFontDescriptor
org.apache.fop.pdf 

Uses of PDFFontDescriptor in org.apache.fop.pdf
 

Methods in org.apache.fop.pdf that return PDFFontDescriptor
PDFFontDescriptorPDFDocument.makeFontDescriptor(FontDescriptor desc)
          make a /FontDescriptor object for a CID font
 

Methods in org.apache.fop.pdf with parameters of type PDFFontDescriptor
static PDFFontPDFFont.createFont(int number, String fontname, byte subtype, String basefont, Object encoding, int firstChar, int lastChar, PDFArray widths, PDFFontDescriptor descriptor)
          factory method with the extended parameters +for Type1, MMType1 and TrueType
voidPDFFontNonBase14.setDescriptor(PDFFontDescriptor descriptor)
          set the font descriptor (unused for the Type3 fonts)
 

\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFFontNonBase14.html b/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFFontNonBase14.html new file mode 100755 index 000000000..7e9c9672a --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFFontNonBase14.html @@ -0,0 +1 @@ +

Uses of Class
org.apache.fop.pdf.PDFFontNonBase14

Packages that use PDFFontNonBase14
org.apache.fop.pdf 

Uses of PDFFontNonBase14 in org.apache.fop.pdf
 

Subclasses of PDFFontNonBase14 in org.apache.fop.pdf
class PDFFontType1
          class representing a Type1 or MMType1 font (not necessary for the base 14).
 

\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFFontType1.html b/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFFontType1.html new file mode 100755 index 000000000..90778c38f --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFFontType1.html @@ -0,0 +1 @@ +

Uses of Class
org.apache.fop.pdf.PDFFontType1

No usage of org.apache.fop.pdf.PDFFontType1
\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFFunction.html b/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFFunction.html new file mode 100755 index 000000000..8e5018387 --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFFunction.html @@ -0,0 +1,3 @@ +

Uses of Class
org.apache.fop.pdf.PDFFunction

Packages that use PDFFunction
org.apache.fop.pdf 

Uses of PDFFunction in org.apache.fop.pdf
 

Constructors in org.apache.fop.pdf with parameters of type PDFFunction
PDFShading.PDFShading(int theNumber, String theShadingName, int theShadingType, ColorSpace theColorSpace, Vector theBackground, Vector theBBox, boolean theAntiAlias, int theBitsPerCoordinate, int theBitsPerComponent, int theBitsPerFlag, Vector theDecode, PDFFunction theFunction)
          Constructor for Type 4,6, or 7
PDFShading.PDFShading(int theNumber, String theShadingName, int theShadingType, ColorSpace theColorSpace, Vector theBackground, Vector theBBox, boolean theAntiAlias, int theBitsPerCoordinate, int theBitsPerComponent, Vector theDecode, int theVerticesPerRow, PDFFunction theFunction)
          Constructor for type 5
PDFShading.PDFShading(int theNumber, String theShadingName, int theShadingType, ColorSpace theColorSpace, Vector theBackground, Vector theBBox, boolean theAntiAlias, Vector theCoords, Vector theDomain, PDFFunction theFunction, Vector theExtend)
          Constructor for Type 2 and 3
PDFShading.PDFShading(int theNumber, String theShadingName, int theShadingType, ColorSpace theColorSpace, Vector theBackground, Vector theBBox, boolean theAntiAlias, Vector theDomain, Vector theMatrix, PDFFunction theFunction)
          Constructor for type function based shading
 

Methods in org.apache.fop.pdf that return PDFFunction
PDFFunctionPDFDocument.makeFunction(int theNumber, int theFunctionType, Vector theDomain, Vector theRange, StringBuffer theFunctionDataStream)
          make a postscript calculator function
PDFFunctionPDFDocument.makeFunction(int theFunctionType, Vector theDomain, Vector theRange, Vector theSize, int theBitsPerSample, int theOrder, Vector theEncode, Vector theDecode, StringBuffer theFunctionDataStream, Vector theFilter)
          Make a Type 0 sampled function
PDFFunctionPDFDocument.makeFunction(int theFunctionType, Vector theDomain, Vector theRange, Vector theCZero, Vector theCOne, double theInterpolationExponentN)
          make a type Exponential interpolation function +(for shading usually)
PDFFunctionPDFDocument.makeFunction(int theFunctionType, Vector theDomain, Vector theRange, Vector theFunctions, Vector theBounds, Vector theEncode)
          Make a Type 3 Stitching function
 

Methods in org.apache.fop.pdf with parameters of type PDFFunction
PDFShadingPDFDocument.makeShading(int theShadingType, ColorSpace theColorSpace, Vector theBackground, Vector theBBox, boolean theAntiAlias, int theBitsPerCoordinate, int theBitsPerComponent, int theBitsPerFlag, Vector theDecode, PDFFunction theFunction)
          Make a free-form gouraud shaded triangle mesh, coons patch mesh, or tensor patch mesh +shading object
PDFShadingPDFDocument.makeShading(int theShadingType, ColorSpace theColorSpace, Vector theBackground, Vector theBBox, boolean theAntiAlias, int theBitsPerCoordinate, int theBitsPerComponent, Vector theDecode, int theVerticesPerRow, PDFFunction theFunction)
          make a Lattice-Form Gouraud mesh shading object
PDFShadingPDFDocument.makeShading(int theShadingType, ColorSpace theColorSpace, Vector theBackground, Vector theBBox, boolean theAntiAlias, Vector theCoords, Vector theDomain, PDFFunction theFunction, Vector theExtend)
          Make an axial or radial shading object.
PDFShadingPDFDocument.makeShading(int theShadingType, ColorSpace theColorSpace, Vector theBackground, Vector theBBox, boolean theAntiAlias, Vector theDomain, Vector theMatrix, PDFFunction theFunction)
          make a function based shading object
 

\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFGoTo.html b/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFGoTo.html new file mode 100755 index 000000000..e001ca8b3 --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFGoTo.html @@ -0,0 +1 @@ +

Uses of Class
org.apache.fop.pdf.PDFGoTo

No usage of org.apache.fop.pdf.PDFGoTo
\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFGoToRemote.html b/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFGoToRemote.html new file mode 100755 index 000000000..2660808d5 --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFGoToRemote.html @@ -0,0 +1 @@ +

Uses of Class
org.apache.fop.pdf.PDFGoToRemote

No usage of org.apache.fop.pdf.PDFGoToRemote
\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFInfo.html b/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFInfo.html new file mode 100755 index 000000000..4bdee1f4b --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFInfo.html @@ -0,0 +1 @@ +

Uses of Class
org.apache.fop.pdf.PDFInfo

No usage of org.apache.fop.pdf.PDFInfo
\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFInternalLink.html b/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFInternalLink.html new file mode 100755 index 000000000..22b23f528 --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFInternalLink.html @@ -0,0 +1 @@ +

Uses of Class
org.apache.fop.pdf.PDFInternalLink

No usage of org.apache.fop.pdf.PDFInternalLink
\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFLink.html b/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFLink.html new file mode 100755 index 000000000..12484d36b --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFLink.html @@ -0,0 +1 @@ +

Uses of Class
org.apache.fop.pdf.PDFLink

Packages that use PDFLink
org.apache.fop.pdf 

Uses of PDFLink in org.apache.fop.pdf
 

Methods in org.apache.fop.pdf that return PDFLink
PDFLinkPDFDocument.makeLink(Rectangle rect, String destination, int linkType)
          make a link object
 

Methods in org.apache.fop.pdf with parameters of type PDFLink
voidPDFAnnotList.addLink(PDFLink link)
          add an /Annot object of /Subtype /Link.
 

\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFNumber.html b/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFNumber.html new file mode 100755 index 000000000..bcd1bf284 --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFNumber.html @@ -0,0 +1 @@ +

Uses of Class
org.apache.fop.pdf.PDFNumber

No usage of org.apache.fop.pdf.PDFNumber
\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFObject.html b/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFObject.html new file mode 100755 index 000000000..d1159cbf1 --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFObject.html @@ -0,0 +1,4 @@ +

Uses of Class
org.apache.fop.pdf.PDFObject

Packages that use PDFObject
org.apache.fop.pdf 

Uses of PDFObject in org.apache.fop.pdf
 

Subclasses of PDFObject in org.apache.fop.pdf
class PDFAction
          class representing an action object.
class PDFAnnotList
          class representing an object which is a list of annotations.
class PDFArray
          class representing an array object
class PDFEncoding
          class representing an /Encoding object.
class PDFFileSpec
          class representing a /FileSpec object.
class PDFFont
          class representing a /Font object.
class PDFFontDescriptor
          class representing a font descriptor.
class PDFFunction
          class representing a PDF Function.
class PDFGoTo
          class representing a /GoTo object.
class PDFInfo
          class representing an /Info object
class PDFLink
          class representing an /Annot object of /Subtype /Link
class PDFPage
          class representing a /Page object.
class PDFPages
          class representing a /Pages object.
class PDFPathPaint
          
class PDFResources
          class representing a /Resources object.
class PDFRoot
          class representing a Root (/Catalog) object
class PDFShading
          class representing a PDF Smooth Shading object.
class PDFStream
          class representing a PDF stream.
class PDFXObject
          PDF XObject + +A derivative of the PDF Object, is a PDF Stream that has not only a +dictionary but a stream of image data.
 

\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFPage.html b/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFPage.html new file mode 100755 index 000000000..bdce0e5ac --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFPage.html @@ -0,0 +1 @@ +

Uses of Class
org.apache.fop.pdf.PDFPage

Packages that use PDFPage
org.apache.fop.pdf 

Uses of PDFPage in org.apache.fop.pdf
 

Methods in org.apache.fop.pdf that return PDFPage
PDFPagePDFDocument.makePage(PDFResources resources, PDFStream contents, int pagewidth, int pageheight, Page currentPage)
          make a /Page object
 

Methods in org.apache.fop.pdf with parameters of type PDFPage
voidPDFPages.addPage(PDFPage page)
          add a /Page object.
voidPDFRoot.addPage(PDFPage page)
          add a /Page object to the root /Pages object
 

\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFPages.html b/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFPages.html new file mode 100755 index 000000000..5430c3919 --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFPages.html @@ -0,0 +1 @@ +

Uses of Class
org.apache.fop.pdf.PDFPages

Packages that use PDFPages
org.apache.fop.pdf 

Uses of PDFPages in org.apache.fop.pdf
 

Methods in org.apache.fop.pdf with parameters of type PDFPages
voidPDFPage.setParent(PDFPages parent)
          set this page's parent
voidPDFRoot.setRootPages(PDFPages pages)
          set the root /Pages object
 

\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFPathPaint.html b/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFPathPaint.html new file mode 100755 index 000000000..6da7a4c2e --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFPathPaint.html @@ -0,0 +1 @@ +

Uses of Class
org.apache.fop.pdf.PDFPathPaint

Packages that use PDFPathPaint
org.apache.fop.pdf 

Uses of PDFPathPaint in org.apache.fop.pdf
 

Subclasses of PDFPathPaint in org.apache.fop.pdf
class PDFColor
          
class PDFPattern
          class representing a PDF Function.
 

\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFPattern.html b/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFPattern.html new file mode 100755 index 000000000..94e466f0a --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFPattern.html @@ -0,0 +1 @@ +

Uses of Class
org.apache.fop.pdf.PDFPattern

Packages that use PDFPattern
org.apache.fop.pdf 

Uses of PDFPattern in org.apache.fop.pdf
 

Methods in org.apache.fop.pdf that return PDFPattern
PDFPatternPDFDocument.createGradient(boolean radial, ColorSpace theColorspace, Vector theColors, Vector theBounds, Vector theCoords)
          
PDFPatternPDFDocument.makePattern(int thePatternType, PDFResources theResources, int thePaintType, int theTilingType, Vector theBBox, double theXStep, double theYStep, Vector theMatrix, Vector theXUID, StringBuffer thePatternDataStream)
          Make a tiling pattern
PDFPatternPDFDocument.makePattern(int thePatternType, PDFShading theShading, Vector theXUID, StringBuffer theExtGState, Vector theMatrix)
          Make a smooth shading pattern
 

Methods in org.apache.fop.pdf with parameters of type PDFPattern
voidPDFResources.addPattern(PDFPattern thePattern)
          
 

\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFRectangle.html b/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFRectangle.html new file mode 100755 index 000000000..2caccef2a --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFRectangle.html @@ -0,0 +1 @@ +

Uses of Class
org.apache.fop.pdf.PDFRectangle

Packages that use PDFRectangle
org.apache.fop.pdf 

Uses of PDFRectangle in org.apache.fop.pdf
 

Constructors in org.apache.fop.pdf with parameters of type PDFRectangle
PDFFontDescriptor.PDFFontDescriptor(int number, String basefont, int ascent, int descent, int capHeight, int flags, PDFRectangle fontBBox, int italicAngle, int stemV)
          create the /FontDescriptor object
 

\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFResources.html b/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFResources.html new file mode 100755 index 000000000..e1c5d61de --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFResources.html @@ -0,0 +1 @@ +

Uses of Class
org.apache.fop.pdf.PDFResources

Packages that use PDFResources
org.apache.fop.pdf 

Uses of PDFResources in org.apache.fop.pdf
 

Constructors in org.apache.fop.pdf with parameters of type PDFResources
PDFPage.PDFPage(int number, PDFResources resources, PDFStream contents, int pagewidth, int pageheight)
          create a /Page object
PDFPattern.PDFPattern(int theNumber, String thePatternName, PDFResources theResources, int thePatternType, int thePaintType, int theTilingType, Vector theBBox, double theXStep, double theYStep, Vector theMatrix, Vector theXUID, StringBuffer thePatternDataStream)
          Create a tiling pattern (type 1).
 

Methods in org.apache.fop.pdf that return PDFResources
PDFResourcesPDFDocument.getResources()
          get the /Resources object for the document
 

Methods in org.apache.fop.pdf with parameters of type PDFResources
PDFPagePDFDocument.makePage(PDFResources resources, PDFStream contents, int pagewidth, int pageheight, Page currentPage)
          make a /Page object
PDFPatternPDFDocument.makePattern(int thePatternType, PDFResources theResources, int thePaintType, int theTilingType, Vector theBBox, double theXStep, double theYStep, Vector theMatrix, Vector theXUID, StringBuffer thePatternDataStream)
          Make a tiling pattern
 

\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFRoot.html b/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFRoot.html new file mode 100755 index 000000000..cee4ad9b4 --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFRoot.html @@ -0,0 +1 @@ +

Uses of Class
org.apache.fop.pdf.PDFRoot

No usage of org.apache.fop.pdf.PDFRoot
\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFShading.html b/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFShading.html new file mode 100755 index 000000000..b2d5cf428 --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFShading.html @@ -0,0 +1,2 @@ +

Uses of Class
org.apache.fop.pdf.PDFShading

Packages that use PDFShading
org.apache.fop.pdf 

Uses of PDFShading in org.apache.fop.pdf
 

Constructors in org.apache.fop.pdf with parameters of type PDFShading
PDFPattern.PDFPattern(int theNumber, String thePatternName, int thePatternType, PDFShading theShading, Vector theXUID, StringBuffer theExtGState, Vector theMatrix)
          Create a type 2 pattern (smooth shading)
 

Methods in org.apache.fop.pdf that return PDFShading
PDFShadingPDFDocument.makeShading(int theShadingType, ColorSpace theColorSpace, Vector theBackground, Vector theBBox, boolean theAntiAlias, int theBitsPerCoordinate, int theBitsPerComponent, int theBitsPerFlag, Vector theDecode, PDFFunction theFunction)
          Make a free-form gouraud shaded triangle mesh, coons patch mesh, or tensor patch mesh +shading object
PDFShadingPDFDocument.makeShading(int theShadingType, ColorSpace theColorSpace, Vector theBackground, Vector theBBox, boolean theAntiAlias, int theBitsPerCoordinate, int theBitsPerComponent, Vector theDecode, int theVerticesPerRow, PDFFunction theFunction)
          make a Lattice-Form Gouraud mesh shading object
PDFShadingPDFDocument.makeShading(int theShadingType, ColorSpace theColorSpace, Vector theBackground, Vector theBBox, boolean theAntiAlias, Vector theCoords, Vector theDomain, PDFFunction theFunction, Vector theExtend)
          Make an axial or radial shading object.
PDFShadingPDFDocument.makeShading(int theShadingType, ColorSpace theColorSpace, Vector theBackground, Vector theBBox, boolean theAntiAlias, Vector theDomain, Vector theMatrix, PDFFunction theFunction)
          make a function based shading object
 

Methods in org.apache.fop.pdf with parameters of type PDFShading
PDFPatternPDFDocument.makePattern(int thePatternType, PDFShading theShading, Vector theXUID, StringBuffer theExtGState, Vector theMatrix)
          Make a smooth shading pattern
voidPDFPage.addShading(PDFShading shading)
          
voidPDFResources.addShading(PDFShading theShading)
          
 

\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFStream.html b/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFStream.html new file mode 100755 index 000000000..e3d7b5702 --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFStream.html @@ -0,0 +1 @@ +

Uses of Class
org.apache.fop.pdf.PDFStream

Packages that use PDFStream
org.apache.fop.pdf 

Uses of PDFStream in org.apache.fop.pdf
 

Constructors in org.apache.fop.pdf with parameters of type PDFStream
PDFPage.PDFPage(int number, PDFResources resources, PDFStream contents, int pagewidth, int pageheight)
          create a /Page object
 

Methods in org.apache.fop.pdf that return PDFStream
PDFStreamPDFDocument.makeStream()
          make a stream object
 

Methods in org.apache.fop.pdf with parameters of type PDFStream
PDFPagePDFDocument.makePage(PDFResources resources, PDFStream contents, int pagewidth, int pageheight, Page currentPage)
          make a /Page object
voidPDFFontDescriptor.setFontFile(byte subtype, PDFStream fontfile)
          set the optional font file stream
 

\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFUri.html b/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFUri.html new file mode 100755 index 000000000..98566eda4 --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFUri.html @@ -0,0 +1 @@ +

Uses of Class
org.apache.fop.pdf.PDFUri

No usage of org.apache.fop.pdf.PDFUri
\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFXObject.html b/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFXObject.html new file mode 100755 index 000000000..18fd84069 --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/class-use/PDFXObject.html @@ -0,0 +1 @@ +

Uses of Class
org.apache.fop.pdf.PDFXObject

No usage of org.apache.fop.pdf.PDFXObject
\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/package-frame.html b/docs/design/contrib/pdf/org/apache/fop/pdf/package-frame.html new file mode 100755 index 000000000..b82138c5a --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/package-frame.html @@ -0,0 +1,7 @@ +Package org.apache.fop.pdf +org.apache.fop.pdf
Class Diagrams 
pdf
Classes 
ASCII85Filter
ASCIIHexFilter
FlateFilter
PDFAction
PDFAnnotList
PDFArray
PDFColor
PDFDocument
PDFEncoding
PDFFileSpec
PDFFilter
PDFFilterException
PDFFont
PDFFontDescriptor
PDFFontNonBase14
PDFFontType1
PDFFunction
PDFGoTo
PDFGoToRemote
PDFInfo
PDFInternalLink
PDFLink
PDFNumber
PDFObject
PDFPage
PDFPages
PDFPathPaint
PDFPattern
PDFRectangle
PDFResources
PDFRoot
PDFShading
PDFStream
PDFUri
PDFXObject
\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/package-summary.html b/docs/design/contrib/pdf/org/apache/fop/pdf/package-summary.html new file mode 100755 index 000000000..c60d043cb --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/package-summary.html @@ -0,0 +1,14 @@ +Package org.apache.fop.pdf

Package org.apache.fop.pdf

+Classes for handling the low-level creation of PDF documents +These classes were developed for FOP, but could be used by other +applications wishing to produce PDF.

See
          Description

Class Diagram Summary
pdf 
 

Class Summary
ASCII85Filter 
ASCIIHexFilter 
FlateFilterA filter to deflate a stream.
PDFActionclass representing an action object.
PDFAnnotListclass representing an object which is a list of annotations.
PDFArrayclass representing an array object
PDFColor 
PDFDocumentclass representing a PDF document.
PDFEncodingclass representing an /Encoding object.
PDFFileSpecclass representing a /FileSpec object.
PDFFilter 
PDFFilterException 
PDFFontclass representing a /Font object.
PDFFontDescriptorclass representing a font descriptor.
PDFFontNonBase14A common ancestor for Type1, TrueType, MMType1 and Type3 fonts +(all except base 14 fonts).
PDFFontType1class representing a Type1 or MMType1 font (not necessary for the base 14).
PDFFunctionclass representing a PDF Function.
PDFGoToclass representing a /GoTo object.
PDFGoToRemoteclass representing a /GoToR object.
PDFInfoclass representing an /Info object
PDFInternalLinkclass used to create a PDF internal link
PDFLinkclass representing an /Annot object of /Subtype /Link
PDFNumber 
PDFObjectgeneric PDF object.
PDFPageclass representing a /Page object.
PDFPagesclass representing a /Pages object.
PDFPathPaint 
PDFPatternclass representing a PDF Function.
PDFRectangleclass representing a rectangle + +Rectangles are specified on page 183 of the PDF 1.3 spec.
PDFResourcesclass representing a /Resources object.
PDFRootclass representing a Root (/Catalog) object
PDFShadingclass representing a PDF Smooth Shading object.
PDFStreamclass representing a PDF stream.
PDFUriclass used to create a PDF Uri link
PDFXObjectPDF XObject + +A derivative of the PDF Object, is a PDF Stream that has not only a +dictionary but a stream of image data.
 

Package org.apache.fop.pdf Description

+

Classes for handling the low-level creation of PDF documents

+

These classes were developed for FOP, but could be used by other +applications wishing to produce PDF.

+
\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/package-tree.html b/docs/design/contrib/pdf/org/apache/fop/pdf/package-tree.html new file mode 100755 index 000000000..ef6926290 --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/package-tree.html @@ -0,0 +1 @@ +org.apache.fop.pdf Class Hierarchy

Hierarchy For Package org.apache.fop.pdf

Package Hierarchies:
All Packages

Class Hierarchy

\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/package-use.html b/docs/design/contrib/pdf/org/apache/fop/pdf/package-use.html new file mode 100755 index 000000000..1cb3d510c --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/package-use.html @@ -0,0 +1,5 @@ +

Uses of Package
org.apache.fop.pdf

Packages that use org.apache.fop.pdf
org.apache.fop.pdf 

Classes in org.apache.fop.pdf used by org.apache.fop.pdf
ASCII85Filter
          
ASCIIHexFilter
          
FlateFilter
          A filter to deflate a stream.
PDFAction
          class representing an action object.
PDFAnnotList
          class representing an object which is a list of annotations.
PDFArray
          class representing an array object
PDFColor
          
PDFDocument
          class representing a PDF document.
PDFEncoding
          class representing an /Encoding object.
PDFFileSpec
          class representing a /FileSpec object.
PDFFont
          class representing a /Font object.
PDFFontDescriptor
          class representing a font descriptor.
PDFFontNonBase14
          A common ancestor for Type1, TrueType, MMType1 and Type3 fonts +(all except base 14 fonts).
PDFFontType1
          class representing a Type1 or MMType1 font (not necessary for the base 14).
PDFFunction
          class representing a PDF Function.
PDFGoTo
          class representing a /GoTo object.
PDFGoToRemote
          class representing a /GoToR object.
PDFInfo
          class representing an /Info object
PDFInternalLink
          class used to create a PDF internal link
PDFLink
          class representing an /Annot object of /Subtype /Link
PDFPage
          class representing a /Page object.
PDFPages
          class representing a /Pages object.
PDFPathPaint
          
PDFPattern
          class representing a PDF Function.
PDFResources
          class representing a /Resources object.
PDFRoot
          class representing a Root (/Catalog) object
PDFShading
          class representing a PDF Smooth Shading object.
PDFStream
          class representing a PDF stream.
PDFUri
          class used to create a PDF Uri link
PDFXObject
          PDF XObject + +A derivative of the PDF Object, is a PDF Stream that has not only a +dictionary but a stream of image data.
 

\ No newline at end of file diff --git a/docs/design/contrib/pdf/org/apache/fop/pdf/pdf.cl.html b/docs/design/contrib/pdf/org/apache/fop/pdf/pdf.cl.html new file mode 100755 index 000000000..6ac6fc023 --- /dev/null +++ b/docs/design/contrib/pdf/org/apache/fop/pdf/pdf.cl.html @@ -0,0 +1,7 @@ +

org.apache.fop.pdf
Class Diagram pdf

Class Summary
ASCII85Filter 
ASCIIHexFilter 
FlateFilterA filter to deflate a stream.
PDFActionclass representing an action object.
PDFAnnotListclass representing an object which is a list of annotations.
PDFArrayclass representing an array object
PDFColor 
PDFDocumentclass representing a PDF document.
PDFEncodingclass representing an /Encoding object.
PDFFileSpecclass representing a /FileSpec object.
PDFFilter 
PDFFilterException 
PDFFontclass representing a /Font object.
PDFFontDescriptorclass representing a font descriptor.
PDFFontNonBase14A common ancestor for Type1, TrueType, MMType1 and Type3 fonts +(all except base 14 fonts).
PDFFontType1class representing a Type1 or MMType1 font (not necessary for the base 14).
PDFFunctionclass representing a PDF Function.
PDFGoToclass representing a /GoTo object.
PDFGoToRemoteclass representing a /GoToR object.
PDFInfoclass representing an /Info object
PDFInternalLinkclass used to create a PDF internal link
PDFLinkclass representing an /Annot object of /Subtype /Link
PDFNumber 
PDFObjectgeneric PDF object.
PDFPageclass representing a /Page object.
PDFPagesclass representing a /Pages object.
PDFPathPaint 
PDFPatternclass representing a PDF Function.
PDFRectangleclass representing a rectangle + +Rectangles are specified on page 183 of the PDF 1.3 spec.
PDFResourcesclass representing a /Resources object.
PDFRootclass representing a Root (/Catalog) object
PDFShadingclass representing a PDF Smooth Shading object.
PDFStreamclass representing a PDF stream.
PDFUriclass used to create a PDF Uri link
PDFXObjectPDF XObject + +A derivative of the PDF Object, is a PDF Stream that has not only a +dictionary but a stream of image data.
 

\ No newline at end of file