You are viewing a plain text version of this content. The canonical link for it is here.
Posted to fop-commits@xmlgraphics.apache.org by ar...@apache.org on 2001/01/30 03:58:07 UTC
cvs commit: xml-fop/docs/design/contrib/pdf/org/apache/fop/pdf PDFDocument.html
arved 01/01/29 18:58:06
Added: docs/design/contrib/pdf/org/apache/fop/pdf PDFDocument.html
Log:
PDF package HTML
Revision Changes Path
1.1 xml-fop/docs/design/contrib/pdf/org/apache/fop/pdf/PDFDocument.html
Index: PDFDocument.html
===================================================================
<HTML><HEAD><!-- Generated by Together onThu Jan 25 10:51:03 EST 2001 --><TITLE></TITLE><LINK REL="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"></HEAD><BODY BGCOLOR="white"><!-- ========== START OF NAVBAR ========== --><TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"><TR><TD COLSPAN=2 BGCOLOR="#EEEEFF" ID="NavBarCell1"><TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"><TR ALIGN="center" VALIGN="top"><TD BGCOLOR="#EEEEFF" ID="NavBarCell1"><A HREF= "../../../../overview-summary.html"><FONT ID="NavBarFont1"><B>Overview</B></FONT></A> </TD><TD BGCOLOR="#EEEEFF" ID="NavBarCell1"><A HREF= "package-summary.html"><FONT ID="NavBarFont1"><B>Package</B></FONT></A> </TD><TD BGCOLOR="#FFFFFF" ID="NavBarCell1Rev"> <FONT ID="NavBarFont1Rev"><B>Class</B></FONT> </TD><TD BGCOLOR="#EEEEFF" ID="NavBarCell1"><A HREF= "class-use/PDFDocument.html"><FONT ID="NavBarFont1"><B>Use</B></FONT></A> </TD><TD BGCOLOR="#EEEEFF" ID="NavBarCell1"><A HREF= "package-tree.html"><FONT ID="NavBarFont1"><B>Tree</B></FONT></A> </TD><TD BGCOLOR="#EEEEFF" ID="NavBarCell1"><A HREF= "../../../../index-all.html"><FONT ID="NavBarFont1"><B>Index</B></FONT></A> </TD><TD BGCOLOR="#EEEEFF" ID="NavBarCell1"><A HREF= "../../../../help-doc.html"><FONT ID="NavBarFont1"><B>Help</B></FONT></A> </TD></TR></TABLE><TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM></TD></EM></TD></TR><TR><TD BGCOLOR="white" ID="NavBarCell2"><FONT SIZE="-2"> <A HREF= "../../../../org/apache/fop/pdf/PDFColor.html"><B>PREV CLASS</B></A> <A HREF= "../../../../org/apache/fop/pdf/PDFEncoding.html"><B>NEXT CLASS</B></A></FONT></TD><TD BGCOLOR="white" ID="NavBarCell2"><FONT SIZE="-2"> <A HREF= "../../../../index.html" TARGET="_top"><B>FRAMES</B></A> <A HREF= "PDFDocument.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD></TR><TR><TD VALIGN="top" ID="NavBarCell3"><FONT SIZE="-2">SUMMARY: INNER | FIELD | <A HREF= "#constructor_summary">CONSTR</A> | <A HREF= "#method_summary">METHOD</A></FONT></TD><TD VALIGN="top" ID="NavBarCell3"><FONT SIZE="-2">DETAIL: FIELD | <A HREF= "#constructor_detail">CONSTR</A> | <A HREF= "#method_detail">METHOD</A></FONT></TD></TR></TABLE><!-- ========== END OF NAVBAR ========== --><HR><H2><FONT SIZE="-1">org.apache.fop.pdf</FONT><BR>Class PDFDocument</H2><HR><DL><DT>public class <B>PDFDocument</B></DL><P>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.<HR><!-- =========== CONSTRUCTOR SUMMARY =========== --><A NAME= "constructor_summary"></A><TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"><TR BGCOLOR="#CCCCFF" ID="TableHeadingColor"> <TD COLSPAN=2><FONT SIZE= "+2"><B>Constructor Summary</B></FONT></TD></TR><TR BGCOLOR="white" ID="TableRowColor"><TD><CODE><B><A HREF= "../../../../org/apache/fop/pdf/PDFDocument.html#PDFDocument()">PDFDocument</A></B>()</CODE><BR> creates an empty PDF document</TD></TR></TABLE><BR><!-- =========== METHOD SUMMARY =========== --><A NAME= "method_summary"></A><TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"><TR BGCOLOR="#CCCCFF" ID="TableHeadingColor"> <TD COLSPAN=2><FONT SIZE= "+2"><B>Method Summary</B></FONT></TD></TR><TR BGCOLOR="white" ID="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="20%"><FONT SIZE="-1"><CODE> int</CODE></FONT></TD><TD><CODE><B><A HREF= "../../../../org/apache/fop/pdf/PDFDocument.html#addImage(org.apache.fop.image.FopImage)">addImage</A></B>(FopImage img)</CODE><BR> </TD></TR><TR BGCOLOR="white" ID="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="20%"><FONT SIZE="-1"><CODE> <A HREF= "../../../../org/apache/fop/pdf/PDFPattern.html">PDFPattern</A></CODE></FONT></TD><TD><CODE><B><A HREF= "../../../../org/apache/fop/pdf/PDFDocument.html#createGradient(boolean, org.apache.fop.datatypes.ColorSpace, java.util.Vector, java.util.Vector, java.util.Vector)">createGradient</A></B>(boolean radial, ColorSpace theColorspace, Vector theColors, Vector theBounds, Vector theCoords)</CODE><BR> </TD></TR><TR BGCOLOR="white" ID="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="20%"><FONT SIZE="-1"><CODE> int</CODE></FONT></TD><TD><CODE><B><A HREF= "../../../../org/apache/fop/pdf/PDFDocument.html#getColorSpace()">getColorSpace</A></B>()</CODE><BR> </TD></TR><TR BGCOLOR="white" ID="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="20%"><FONT SIZE="-1"><CODE> <A HREF= "../../../../org/apache/fop/pdf/PDFResources.html">PDFResources</A></CODE></FONT></TD><TD><CODE><B><A HREF= "../../../../org/apache/fop/pdf/PDFDocument.html#getResources()">getResources</A></B>()</CODE><BR> get the /Resources object for the document</TD></TR><TR BGCOLOR="white" ID="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="20%"><FONT SIZE="-1"><CODE> <A HREF= "../../../../org/apache/fop/pdf/PDFAnnotList.html">PDFAnnotList</A></CODE></FONT></TD><TD><CODE><B><A HREF= "../../../../org/apache/fop/pdf/PDFDocument.html#makeAnnotList()">makeAnnotList</A></B>()</CODE><BR> make an annotation list object</TD></TR><TR BGCOLOR="white" ID="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="20%"><FONT SIZE="-1"><CODE> <A HREF= "../../../../org/apache/fop/pdf/PDFArray.html">PDFArray</A></CODE></FONT></TD><TD><CODE><B><A HREF= "../../../../org/apache/fop/pdf/PDFDocument.html#makeArray(int[])">makeArray</A></B>(int[] values)</CODE><BR> make an Array object (ex.</TD></TR><TR BGCOLOR="white" ID="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="20%"><FONT SIZE="-1"><CODE> <A HREF= "../../../../org/apache/fop/pdf/PDFEncoding.html">PDFEncoding</A></CODE></FONT></TD><TD><CODE><B><A HREF= "../../../../org/apache/fop/pdf/PDFDocument.html#makeEncoding(java.lang.String)">makeEncoding</A></B>(String encodingName)</CODE><BR> make a /Encoding object</TD></TR><TR BGCOLOR="white" ID="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="20%"><FONT SIZE="-1"><CODE> <A HREF= "../../../../org/apache/fop/pdf/PDFFont.html">PDFFont</A></CODE></FONT></TD><TD><CODE><B><A HREF= "../../../../org/apache/fop/pdf/PDFDocument.html#makeFont(java.lang.String, java.lang.String, java.lang.String, org.apache.fop.layout.FontMetric, org.apache.fop.layout.FontDescriptor)">makeFont</A></B>(String fontname, String basefont, String encoding, FontMetric metrics, FontDescriptor descriptor)</CODE><BR> make a Type1 /Font object</TD></TR><TR BGCOLOR="white" ID="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="20%"><FONT SIZE="-1"><CODE> <A HREF= "../../../../org/apache/fop/pdf/PDFFontDescriptor.html">PDFFontDescriptor</A></CODE></FONT></TD><TD><CODE><B><A HREF= "../../../../org/apache/fop/pdf/PDFDocument.html#makeFontDescriptor(org.apache.fop.layout.FontDescriptor)">makeFontDescriptor</A></B>(FontDescriptor desc)</CODE><BR> make a /FontDescriptor object for a CID font</TD></TR><TR BGCOLOR="white" ID="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="20%"><FONT SIZE="-1"><CODE> <A HREF= "../../../../org/apache/fop/pdf/PDFFunction.html">PDFFunction</A></CODE></FONT></TD><TD><CODE><B><A HREF= "../../../../org/apache/fop/pdf/PDFDocument.html#makeFunction(int, java.util.Vector, java.util.Vector, java.util.Vector, int, int, java.util.Vector, java.util.Vector, java.lang.StringBuffer, java.util.Vector)">makeFunction</A></B>(int theFunctionType, Vector theDomain, Vector theRange, Vector theSize, int theBitsPerSample, int theOrder, Vector theEncode, Vector theDecode, StringBuffer theFunctionDataStream, Vector theFilter)</CODE><BR> Make a Type 0 sampled function</TD></TR><TR BGCOLOR="white" ID="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="20%"><FONT SIZE="-1"><CODE> <A HREF= "../../../../org/apache/fop/pdf/PDFFunction.html">PDFFunction</A></CODE></FONT></TD><TD><CODE><B><A HREF= "../../../../org/apache/fop/pdf/PDFDocument.html#makeFunction(int, java.util.Vector, java.util.Vector, java.util.Vector, java.util.Vector, double)">makeFunction</A></B>(int theFunctionType, Vector theDomain, Vector theRange, Vector theCZero, Vector theCOne, double theInterpolationExponentN)</CODE><BR> make a type Exponential interpolation function
(for shading usually)</TD></TR><TR BGCOLOR="white" ID="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="20%"><FONT SIZE="-1"><CODE> <A HREF= "../../../../org/apache/fop/pdf/PDFFunction.html">PDFFunction</A></CODE></FONT></TD><TD><CODE><B><A HREF= "../../../../org/apache/fop/pdf/PDFDocument.html#makeFunction(int, java.util.Vector, java.util.Vector, java.util.Vector, java.util.Vector, java.util.Vector)">makeFunction</A></B>(int theFunctionType, Vector theDomain, Vector theRange, Vector theFunctions, Vector theBounds, Vector theEncode)</CODE><BR> Make a Type 3 Stitching function</TD></TR><TR BGCOLOR="white" ID="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="20%"><FONT SIZE="-1"><CODE> <A HREF= "../../../../org/apache/fop/pdf/PDFFunction.html">PDFFunction</A></CODE></FONT></TD><TD><CODE><B><A HREF= "../../../../org/apache/fop/pdf/PDFDocument.html#makeFunction(int, int, java.util.Vector, java.util.Vector, java.lang.StringBuffer)">makeFunction</A></B>(int theNumber, int theFunctionType, Vector theDomain, Vector theRange, StringBuffer theFunctionDataStream)</CODE><BR> make a postscript calculator function</TD></TR><TR BGCOLOR="white" ID="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="20%"><FONT SIZE="-1"><CODE> <A HREF= "../../../../org/apache/fop/pdf/PDFLink.html">PDFLink</A></CODE></FONT></TD><TD><CODE><B><A HREF= "../../../../org/apache/fop/pdf/PDFDocument.html#makeLink(java.awt.Rectangle, java.lang.String, int)">makeLink</A></B>(Rectangle rect, String destination, int linkType)</CODE><BR> make a link object</TD></TR><TR BGCOLOR="white" ID="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="20%"><FONT SIZE="-1"><CODE> <A HREF= "../../../../org/apache/fop/pdf/PDFPage.html">PDFPage</A></CODE></FONT></TD><TD><CODE><B><A HREF= "../../../../org/apache/fop/pdf/PDFDocument.html#makePage(org.apache.fop.pdf.PDFResources, org.apache.fop.pdf.PDFStream, int, int, org.apache.fop.layout.Page)">makePage</A></B>(<A HREF= "../../../../org/apache/fop/pdf/PDFResources.html">PDFResources</A> resources, <A HREF= "../../../../org/apache/fop/pdf/PDFStream.html">PDFStream</A> contents, int pagewidth, int pageheight, Page currentPage)</CODE><BR> make a /Page object</TD></TR><TR BGCOLOR="white" ID="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="20%"><FONT SIZE="-1"><CODE> <A HREF= "../../../../org/apache/fop/pdf/PDFPattern.html">PDFPattern</A></CODE></FONT></TD><TD><CODE><B><A HREF= "../../../../org/apache/fop/pdf/PDFDocument.html#makePattern(int, org.apache.fop.pdf.PDFResources, int, int, java.util.Vector, double, double, java.util.Vector, java.util.Vector, java.lang.StringBuffer)">makePattern</A></B>(int thePatternType, <A HREF= "../../../../org/apache/fop/pdf/PDFResources.html">PDFResources</A> theResources, int thePaintType, int theTilingType, Vector theBBox, double theXStep, double theYStep, Vector theMatrix, Vector theXUID, StringBuffer thePatternDataStream)</CODE><BR> Make a tiling pattern</TD></TR><TR BGCOLOR="white" ID="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="20%"><FONT SIZE="-1"><CODE> <A HREF= "../../../../org/apache/fop/pdf/PDFPattern.html">PDFPattern</A></CODE></FONT></TD><TD><CODE><B><A HREF= "../../../../org/apache/fop/pdf/PDFDocument.html#makePattern(int, org.apache.fop.pdf.PDFShading, java.util.Vector, java.lang.StringBuffer, java.util.Vector)">makePattern</A></B>(int thePatternType, <A HREF= "../../../../org/apache/fop/pdf/PDFShading.html">PDFShading</A> theShading, Vector theXUID, StringBuffer theExtGState, Vector theMatrix)</CODE><BR> Make a smooth shading pattern</TD></TR><TR BGCOLOR="white" ID="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="20%"><FONT SIZE="-1"><CODE> <A HREF= "../../../../org/apache/fop/pdf/PDFShading.html">PDFShading</A></CODE></FONT></TD><TD><CODE><B><A HREF= "../../../../org/apache/fop/pdf/PDFDocument.html#makeShading(int, org.apache.fop.datatypes.ColorSpace, java.util.Vector, java.util.Vector, boolean, java.util.Vector, java.util.Vector, org.apache.fop.pdf.PDFFunction)">makeShading</A></B>(int theShadingType, ColorSpace theColorSpace, Vector theBackground, Vector theBBox, boolean theAntiAlias, Vector theDomain, Vector theMatrix, <A HREF= "../../../../org/apache/fop/pdf/PDFFunction.html">PDFFunction</A> theFunction)</CODE><BR> make a function based shading object</TD></TR><TR BGCOLOR="white" ID="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="20%"><FONT SIZE="-1"><CODE> <A HREF= "../../../../org/apache/fop/pdf/PDFShading.html">PDFShading</A></CODE></FONT></TD><TD><CODE><B><A HREF= "../../../../org/apache/fop/pdf/PDFDocument.html#makeShading(int, org.apache.fop.datatypes.ColorSpace, java.util.Vector, java.util.Vector, boolean, java.util.Vector, java.util.Vector, org.apache.fop.pdf.PDFFunction, java.util.Vector)">makeShading</A></B>(int theShadingType, ColorSpace theColorSpace, Vector theBackground, Vector theBBox, boolean theAntiAlias, Vector theCoords, Vector theDomain, <A HREF= "../../../../org/apache/fop/pdf/PDFFunction.html">PDFFunction</A> theFunction, Vector theExtend)</CODE><BR> Make an axial or radial shading object.</TD></TR><TR BGCOLOR="white" ID="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="20%"><FONT SIZE="-1"><CODE> <A HREF= "../../../../org/apache/fop/pdf/PDFShading.html">PDFShading</A></CODE></FONT></TD><TD><CODE><B><A HREF= "../../../../org/apache/fop/pdf/PDFDocument.html#makeShading(int, org.apache.fop.datatypes.ColorSpace, java.util.Vector, java.util.Vector, boolean, int, int, int, java.util.Vector, org.apache.fop.pdf.PDFFunction)">makeShading</A></B>(int theShadingType, ColorSpace theColorSpace, Vector theBackground, Vector theBBox, boolean theAntiAlias, int theBitsPerCoordinate, int theBitsPerComponent, int theBitsPerFlag, Vector theDecode, <A HREF= "../../../../org/apache/fop/pdf/PDFFunction.html">PDFFunction</A> theFunction)</CODE><BR> Make a free-form gouraud shaded triangle mesh, coons patch mesh, or tensor patch mesh
shading object</TD></TR><TR BGCOLOR="white" ID="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="20%"><FONT SIZE="-1"><CODE> <A HREF= "../../../../org/apache/fop/pdf/PDFShading.html">PDFShading</A></CODE></FONT></TD><TD><CODE><B><A HREF= "../../../../org/apache/fop/pdf/PDFDocument.html#makeShading(int, org.apache.fop.datatypes.ColorSpace, java.util.Vector, java.util.Vector, boolean, int, int, java.util.Vector, int, org.apache.fop.pdf.PDFFunction)">makeShading</A></B>(int theShadingType, ColorSpace theColorSpace, Vector theBackground, Vector theBBox, boolean theAntiAlias, int theBitsPerCoordinate, int theBitsPerComponent, Vector theDecode, int theVerticesPerRow, <A HREF= "../../../../org/apache/fop/pdf/PDFFunction.html">PDFFunction</A> theFunction)</CODE><BR> make a Lattice-Form Gouraud mesh shading object</TD></TR><TR BGCOLOR="white" ID="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="20%"><FONT SIZE="-1"><CODE> <A HREF= "../../../../org/apache/fop/pdf/PDFStream.html">PDFStream</A></CODE></FONT></TD><TD><CODE><B><A HREF= "../../../../org/apache/fop/pdf/PDFDocument.html#makeStream()">makeStream</A></B>()</CODE><BR> make a stream object</TD></TR><TR BGCOLOR="white" ID="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="20%"><FONT SIZE="-1"><CODE> void</CODE></FONT></TD><TD><CODE><B><A HREF= "../../../../org/apache/fop/pdf/PDFDocument.html#output(java.io.OutputStream)">output</A></B>(OutputStream stream)</CODE><BR> write the entire document out</TD></TR><TR BGCOLOR="white" ID="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="20%"><FONT SIZE="-1"><CODE> void</CODE></FONT></TD><TD><CODE><B><A HREF= "../../../../org/apache/fop/pdf/PDFDocument.html#setColorSpace(int)">setColorSpace</A></B>(int theColorspace)</CODE><BR> </TD></TR><TR BGCOLOR="white" ID="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="20%"><FONT SIZE="-1"><CODE> void</CODE></FONT></TD><TD><CODE><B><A HREF= "../../../../org/apache/fop/pdf/PDFDocument.html#setIDReferences(org.apache.fop.datatypes.IDReferences)">setIDReferences</A></B>(IDReferences idReferences)</CODE><BR> </TD></TR><TR BGCOLOR="white" ID="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="20%"><FONT SIZE="-1"><CODE> void</CODE></FONT></TD><TD><CODE><B><A HREF= "../../../../org/apache/fop/pdf/PDFDocument.html#setProducer(java.lang.String)">setProducer</A></B>(String producer)</CODE><BR> set the producer of the document</TD></TR></TABLE><BR><!-- =========== CONSTRUCTOR DETAIL =========== --><A NAME= "constructor_detail"></A><TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"><TR BGCOLOR="#CCCCFF" ID="TableHeadingColor"><TD COLSPAN=1><FONT SIZE="+2"><B>Constructor Detail</B></FONT></TD></TR></TABLE><BR><A NAME= "PDFDocument()"><H3>PDFDocument</H3></A><PRE>public <B>PDFDocument</B>()</PRE><DL><DD>creates an empty PDF document</DL><!-- =========== METHOD DETAIL =========== --><A NAME= "method_detail"></A><TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"><TR BGCOLOR="#CCCCFF" ID="TableHeadingColor"><TD COLSPAN=1><FONT SIZE="+2"><B>Method Detail</B></FONT></TD></TR></TABLE><BR><A NAME= "addImage(org.apache.fop.image.FopImage)"><H3>addImage</H3></A><PRE>public int <B>addImage</B>(FopImage img)</PRE><DL><DD></DL><HR><A NAME= "createGradient(boolean, org.apache.fop.datatypes.ColorSpace, java.util.Vector, java.util.Vector, java.util.Vector)"><H3>createGradient</H3></A><PRE>public <A HREF= "../../../../org/apache/fop/pdf/PDFPattern.html">PDFPattern</A> <B>createGradient</B>(boolean radial, ColorSpace theColorspace, Vector theColors, Vector theBounds, Vector theCoords)</PRE><DL><DD></DL><HR><A NAME= "getColorSpace()"><H3>getColorSpace</H3></A><PRE>public int <B>getColorSpace</B>()</PRE><DL><DD></DL><HR><A NAME= "getResources()"><H3>getResources</H3></A><PRE>public <A HREF= "../../../../org/apache/fop/pdf/PDFResources.html">PDFResources</A> <B>getResources</B>()</PRE><DL><DD>get the /Resources object for the document<DD><DL><DT><B>Returns: </B>the /Resources object</DL></DD></DL><HR><A NAME= "makeAnnotList()"><H3>makeAnnotList</H3></A><PRE>public <A HREF= "../../../../org/apache/fop/pdf/PDFAnnotList.html">PDFAnnotList</A> <B>makeAnnotList</B>()</PRE><DL><DD>make an annotation list object<DD><DL><DT><B>Returns: </B>the annotation list object created</DL></DD></DL><HR><A NAME= "makeArray(int[])"><H3>makeArray</H3></A><PRE>public <A HREF= "../../../../org/apache/fop/pdf/PDFArray.html">PDFArray</A> <B>makeArray</B>(int[] values)</PRE><DL><DD>make an Array object (ex. Widths array for a font)</DL><HR><A NAME= "makeEncoding(java.lang.String)"><H3>makeEncoding</H3></A><PRE>public <A HREF= "../../../../org/apache/fop/pdf/PDFEncoding.html">PDFEncoding</A> <B>makeEncoding</B>(String encodingName)</PRE><DL><DD>make a /Encoding object<DD><DL><DT><B>Parameters:</B><DD>encodingName - character encoding scheme name<DT><B>Returns: </B>the created /Encoding object</DL></DD></DL><HR><A NAME= "makeFont(java.lang.String, java.lang.String, java.lang.String, org.apache.fop.layout.FontMetric, org.apache.fop.layout.FontDescriptor)"><H3>makeFont</H3></A><PRE>public <A HREF= "../../../../org/apache/fop/pdf/PDFFont.html">PDFFont</A> <B>makeFont</B>(String fontname, String basefont, String encoding, FontMetric metrics, FontDescriptor descriptor)</PRE><DL><DD>make a Type1 /Font object<DD><DL><DT><B>Parameters:</B><DD>fontname - internal name to use for this font (eg "F1")<DD>basefont - name of the base font (eg "Helvetica")<DD>encoding - character encoding scheme used by the font<DD>metrics - additional information about the font<DD>descriptor - additional information about the font<DT><B>Returns: </B>the created /Font object</DL></DD></DL><HR><A NAME= "makeFontDescriptor(org.apache.fop.layout.FontDescriptor)"><H3>makeFontDescriptor</H3></A><PRE>public <A HREF= "../../../../org/apache/fop/pdf/PDFFontDescriptor.html">PDFFontDescriptor</A> <B>makeFontDescriptor</B>(FontDescriptor desc)</PRE><DL><DD>make a /FontDescriptor object for a CID font</DL><HR><A NAME= "makeFunction(int, java.util.Vector, java.util.Vector, java.util.Vector, int, int, java.util.Vector, java.util.Vector, java.lang.StringBuffer, java.util.Vector)"><H3>makeFunction</H3></A><PRE>public <A HREF= "../../../../org/apache/fop/pdf/PDFFunction.html">PDFFunction</A> <B>makeFunction</B>(int theFunctionType, Vector theDomain, Vector theRange, Vector theSize, int theBitsPerSample, int theOrder, Vector theEncode, Vector theDecode, StringBuffer theFunctionDataStream, Vector theFilter)</PRE><DL><DD>Make a Type 0 sampled function<DD><DL><DT><B>Parameters:</B><DD>theDomain - Vector objects of Double objects.
This is the domain of the function.
See page 264 of the PDF 1.3 Spec.<DD>theRange - Vector objects of Double objects.
This is the Range of the function.
See page 264 of the PDF 1.3 Spec.<DD>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.<DD>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.<DD>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.<DD>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.<DD>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.<DD>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.<DD>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.<DD>theNumber - The object number of this PDF object.<DD>theFunctionType - This is the type of function (0,2,3, or 4).
It should be 0 as this is the constructor for sampled functions.</DL></DD></DL><HR><A NAME= "makeFunction(int, java.util.Vector, java.util.Vector, java.util.Vector, java.util.Vector, double)"><H3>makeFunction</H3></A><PRE>public <A HREF= "../../../../org/apache/fop/pdf/PDFFunction.html">PDFFunction</A> <B>makeFunction</B>(int theFunctionType, Vector theDomain, Vector theRange, Vector theCZero, Vector theCOne, double theInterpolationExponentN)</PRE><DL><DD>make a type Exponential interpolation function
(for shading usually)<DD><DL><DT><B>Parameters:</B><DD>theDomain - Vector objects of Double objects.
This is the domain of the function.
See page 264 of the PDF 1.3 Spec.<DD>theRange - Vector of Doubles that is the Range of the function.
See page 264 of the PDF 1.3 Spec.<DD>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.<DD>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.<DD>theInterpolationExponentN - This is the inerpolation exponent.
This attribute is required.
PDF Spec page 268<DD>theFunctionType - The type of the function, which should be 2.</DL></DD></DL><HR><A NAME= "makeFunction(int, java.util.Vector, java.util.Vector, java.util.Vector, java.util.Vector, java.util.Vector)"><H3>makeFunction</H3></A><PRE>public <A HREF= "../../../../org/apache/fop/pdf/PDFFunction.html">PDFFunction</A> <B>makeFunction</B>(int theFunctionType, Vector theDomain, Vector theRange, Vector theFunctions, Vector theBounds, Vector theEncode)</PRE><DL><DD>Make a Type 3 Stitching function<DD><DL><DT><B>Parameters:</B><DD>theDomain - Vector objects of Double objects.
This is the domain of the function.
See page 264 of the PDF 1.3 Spec.<DD>theRange - Vector objects of Double objects.
This is the Range of the function.
See page 264 of the PDF 1.3 Spec.<DD>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.<DD>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.<DD>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.<DD>theFunctionType - This is the function type. It should be 3,
for a stitching function.</DL></DD></DL><HR><A NAME= "makeFunction(int, int, java.util.Vector, java.util.Vector, java.lang.StringBuffer)"><H3>makeFunction</H3></A><PRE>public <A HREF= "../../../../org/apache/fop/pdf/PDFFunction.html">PDFFunction</A> <B>makeFunction</B>(int theNumber, int theFunctionType, Vector theDomain, Vector theRange, StringBuffer theFunctionDataStream)</PRE><DL><DD>make a postscript calculator function<DD><DL><DT><B>Parameters:</B><DD>theNumber<DD>theFunctionType<DD>theDomain<DD>theRange<DD>theFunctionDataStream</DL></DD></DL><HR><A NAME= "makeLink(java.awt.Rectangle, java.lang.String, int)"><H3>makeLink</H3></A><PRE>public <A HREF= "../../../../org/apache/fop/pdf/PDFLink.html">PDFLink</A> <B>makeLink</B>(Rectangle rect, String destination, int linkType)</PRE><DL><DD>make a link object<DD><DL><DT><B>Parameters:</B><DD>rect - the clickable rectangle<DD>destination - the destination file<DD>linkType - the link type<DT><B>Returns: </B>the PDFLink object created</DL></DD></DL><HR><A NAME= "makePage(org.apache.fop.pdf.PDFResources, org.apache.fop.pdf.PDFStream, int, int, org.apache.fop.layout.Page)"><H3>makePage</H3></A><PRE>public <A HREF= "../../../../org/apache/fop/pdf/PDFPage.html">PDFPage</A> <B>makePage</B>(<A HREF= "../../../../org/apache/fop/pdf/PDFResources.html">PDFResources</A> resources, <A HREF= "../../../../org/apache/fop/pdf/PDFStream.html">PDFStream</A> contents, int pagewidth, int pageheight, Page currentPage)</PRE><DL><DD>make a /Page object<DD><DL><DT><B>Parameters:</B><DD>resources - resources object to use<DD>contents - stream object with content<DD>pagewidth - width of the page in points<DD>pageheight - height of the page in points<DT><B>Returns: </B>the created /Page object</DL></DD></DL><HR><A NAME= "makePattern(int, org.apache.fop.pdf.PDFResources, int, int, java.util.Vector, double, double, java.util.Vector, java.util.Vector, java.lang.StringBuffer)"><H3>makePattern</H3></A><PRE>public <A HREF= "../../../../org/apache/fop/pdf/PDFPattern.html">PDFPattern</A> <B>makePattern</B>(int thePatternType, <A HREF= "../../../../org/apache/fop/pdf/PDFResources.html">PDFResources</A> theResources, int thePaintType, int theTilingType, Vector theBBox, double theXStep, double theYStep, Vector theMatrix, Vector theXUID, StringBuffer thePatternDataStream)</PRE><DL><DD>Make a tiling pattern<DD><DL><DT><B>Parameters:</B><DD>thePatternType - the type of pattern, which is 1 for tiling.<DD>theResources - the resources associated with this pattern<DD>thePaintType - 1 or 2, colored or uncolored.<DD>theTilingType - 1, 2, or 3, constant spacing, no distortion, or faster tiling<DD>theBBox - Vector of Doubles: The pattern cell bounding box<DD>theXStep - horizontal spacing<DD>theYStep - vertical spacing<DD>theMatrix - Optional Vector of Doubles transformation matrix<DD>theXUID - Optional vector of Integers that uniquely identify the pattern<DD>thePatternDataStream - The stream of pattern data to be tiled.</DL></DD></DL><HR><A NAME= "makePattern(int, org.apache.fop.pdf.PDFShading, java.util.Vector, java.lang.StringBuffer, java.util.Vector)"><H3>makePattern</H3></A><PRE>public <A HREF= "../../../../org/apache/fop/pdf/PDFPattern.html">PDFPattern</A> <B>makePattern</B>(int thePatternType, <A HREF= "../../../../org/apache/fop/pdf/PDFShading.html">PDFShading</A> theShading, Vector theXUID, StringBuffer theExtGState, Vector theMatrix)</PRE><DL><DD>Make a smooth shading pattern<DD><DL><DT><B>Parameters:</B><DD>thePatternType - the type of the pattern, which is 2, smooth shading<DD>theShading - the PDF Shading object that comprises this pattern<DD>theXUID - optional:the extended unique Identifier if used.<DD>theExtGState - optional: the extended graphics state, if used.<DD>theMatrix - Optional:Vector of Doubles that specify the matrix.</DL></DD></DL><HR><A NAME= "makeShading(int, org.apache.fop.datatypes.ColorSpace, java.util.Vector, java.util.Vector, boolean, java.util.Vector, java.util.Vector, org.apache.fop.pdf.PDFFunction)"><H3>makeShading</H3></A><PRE>public <A HREF= "../../../../org/apache/fop/pdf/PDFShading.html">PDFShading</A> <B>makeShading</B>(int theShadingType, ColorSpace theColorSpace, Vector theBackground, Vector theBBox, boolean theAntiAlias, Vector theDomain, Vector theMatrix, <A HREF= "../../../../org/apache/fop/pdf/PDFFunction.html">PDFFunction</A> theFunction)</PRE><DL><DD>make a function based shading object<DD><DL><DT><B>Parameters:</B><DD>theShadingType - The type of shading object, which should be 1 for function
based shading.<DD>theColorSpace - The colorspace is 'DeviceRGB' or something similar.<DD>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.<DD>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.<DD>theAntiAlias - Whether or not to anti-alias.<DD>theDomain - Optional vector of Doubles specifying the domain.<DD>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<DD>theFunction - The PDF Function that maps an (x,y) location to a color</DL></DD></DL><HR><A NAME= "makeShading(int, org.apache.fop.datatypes.ColorSpace, java.util.Vector, java.util.Vector, boolean, java.util.Vector, java.util.Vector, org.apache.fop.pdf.PDFFunction, java.util.Vector)"><H3>makeShading</H3></A><PRE>public <A HREF= "../../../../org/apache/fop/pdf/PDFShading.html">PDFShading</A> <B>makeShading</B>(int theShadingType, ColorSpace theColorSpace, Vector theBackground, Vector theBBox, boolean theAntiAlias, Vector theCoords, Vector theDomain, <A HREF= "../../../../org/apache/fop/pdf/PDFFunction.html">PDFFunction</A> theFunction, Vector theExtend)</PRE><DL><DD>Make an axial or radial shading object.<DD><DL><DT><B>Parameters:</B><DD>theShadingType - 2 or 3 for axial or radial shading<DD>theColorSpace - "DeviceRGB" or similar.<DD>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.<DD>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.<DD>theAntiAlias - Default is false<DD>theCoords - Vector of four (type 2) or 6 (type 3) Double<DD>theDomain - Vector of Doubles specifying the domain<DD>theFunction - the Stitching (PDFfunction type 3) function, even if it's stitching a single function<DD>theExtend - Vector of Booleans of whether to extend teh start and end colors past the start and end points
The default is [false, false]</DL></DD></DL><HR><A NAME= "makeShading(int, org.apache.fop.datatypes.ColorSpace, java.util.Vector, java.util.Vector, boolean, int, int, int, java.util.Vector, org.apache.fop.pdf.PDFFunction)"><H3>makeShading</H3></A><PRE>public <A HREF= "../../../../org/apache/fop/pdf/PDFShading.html">PDFShading</A> <B>makeShading</B>(int theShadingType, ColorSpace theColorSpace, Vector theBackground, Vector theBBox, boolean theAntiAlias, int theBitsPerCoordinate, int theBitsPerComponent, int theBitsPerFlag, Vector theDecode, <A HREF= "../../../../org/apache/fop/pdf/PDFFunction.html">PDFFunction</A> theFunction)</PRE><DL><DD>Make a free-form gouraud shaded triangle mesh, coons patch mesh, or tensor patch mesh
shading object<DD><DL><DT><B>Parameters:</B><DD>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.<DD>theColorSpace - "DeviceRGB" or similar.<DD>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.<DD>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.<DD>theAntiAlias - Default is false<DD>theBitsPerCoordinate - 1,2,4,8,12,16,24 or 32.<DD>theBitsPerComponent - 1,2,4,8,12, and 16<DD>theBitsPerFlag - 2,4,8.<DD>theDecode - Vector of Doubles see PDF 1.3 spec pages 303 to 312.<DD>theFunction - the PDFFunction</DL></DD></DL><HR><A NAME= "makeShading(int, org.apache.fop.datatypes.ColorSpace, java.util.Vector, java.util.Vector, boolean, int, int, java.util.Vector, int, org.apache.fop.pdf.PDFFunction)"><H3>makeShading</H3></A><PRE>public <A HREF= "../../../../org/apache/fop/pdf/PDFShading.html">PDFShading</A> <B>makeShading</B>(int theShadingType, ColorSpace theColorSpace, Vector theBackground, Vector theBBox, boolean theAntiAlias, int theBitsPerCoordinate, int theBitsPerComponent, Vector theDecode, int theVerticesPerRow, <A HREF= "../../../../org/apache/fop/pdf/PDFFunction.html">PDFFunction</A> theFunction)</PRE><DL><DD>make a Lattice-Form Gouraud mesh shading object<DD><DL><DT><B>Parameters:</B><DD>theShadingType - 5 for lattice-Form Gouraud shaded-triangle mesh
without spaces. "Shading1" or "Sh1" are good examples.<DD>theColorSpace - "DeviceRGB" or similar.<DD>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.<DD>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.<DD>theAntiAlias - Default is false<DD>theBitsPerCoordinate - 1,2,4,8,12,16, 24, or 32<DD>theBitsPerComponent - 1,2,4,8,12,24,32<DD>theDecode - Vector of Doubles. See page 305 in PDF 1.3 spec.<DD>theVerticesPerRow - number of vertices in each "row" of the lattice.<DD>theFunction - The PDFFunction that's mapped on to this shape</DL></DD></DL><HR><A NAME= "makeStream()"><H3>makeStream</H3></A><PRE>public <A HREF= "../../../../org/apache/fop/pdf/PDFStream.html">PDFStream</A> <B>makeStream</B>()</PRE><DL><DD>make a stream object<DD><DL><DT><B>Returns: </B>the stream object created</DL></DD></DL><HR><A NAME= "output(java.io.OutputStream)"><H3>output</H3></A><PRE>public void <B>output</B>(OutputStream stream)<BR> throws java.io.IOException</A></PRE><DL><DD>write the entire document out<DD><DL><DT><B>Parameters:</B><DD>writer - the OutputStream to output the document to</DL></DD></DL><HR><A NAME= "setColorSpace(int)"><H3>setColorSpace</H3></A><PRE>public void <B>setColorSpace</B>(int theColorspace)</PRE><DL><DD></DL><HR><A NAME= "setIDReferences(org.apache.fop.datatypes.IDReferences)"><H3>setIDReferences</H3></A><PRE>public void <B>setIDReferences</B>(IDReferences idReferences)</PRE><DL><DD></DL><HR><A NAME= "setProducer(java.lang.String)"><H3>setProducer</H3></A><PRE>public void <B>setProducer</B>(String producer)</PRE><DL><DD>set the producer of the document<DD><DL><DT><B>Parameters:</B><DD>producer - string indicating application producing the PDF</DL></DD></DL><P><TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0"><TR BGCOLOR="#CCCCFF" ID="TableHeadingColor"><TD><FONT SIZE= "+0"><B>Association Links</B></FONT></TD></TR></TABLE><BR>to <B>Class </B>java.lang.String<DL><DD>the version of PDF supported</DL><P>to <B>Class </B>java.util.Vector<DL><DD>the character position of each object</DL><P>to <B>Class </B>java.util.Vector<DL><DD>the objects themselves</DL><P>to <B>Class </B><A HREF= "../../../../org/apache/fop/pdf/PDFRoot.html">org.apache.fop.pdf.PDFRoot</A><DL><DD>the /Root object</DL><P>to <B>Class </B><A HREF= "../../../../org/apache/fop/pdf/PDFInfo.html">org.apache.fop.pdf.PDFInfo</A><DL><DD>the /Info object</DL><P>to <B>Class </B><A HREF= "../../../../org/apache/fop/pdf/PDFResources.html">org.apache.fop.pdf.PDFResources</A><DL><DD>the /Resources object</DL><P>to <B>Class </B>org.apache.fop.datatypes.IDReferences<DL><DD>the documents idReferences</DL><P>to <B>Class </B>org.apache.fop.datatypes.ColorSpace<DL><DD>the colorspace (0=RGB, 1=CMYK) *</DL><P>to <B>Class </B>java.util.Vector<DL><DD>the XObjects</DL><P>to <B>Class </B>java.util.Hashtable<DL><DD>the XObjects Map.
Should be modified (works only for image subtype)</DL><HR><!-- ========== START OF NAVBAR ========== --><TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"><TR><TD COLSPAN=2 BGCOLOR="#EEEEFF" ID="NavBarCell1"><TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"><TR ALIGN="center" VALIGN="top"><TD BGCOLOR="#EEEEFF" ID="NavBarCell1"><A HREF= "../../../../overview-summary.html"><FONT ID="NavBarFont1"><B>Overview</B></FONT></A> </TD><TD BGCOLOR="#EEEEFF" ID="NavBarCell1"><A HREF= "package-summary.html"><FONT ID="NavBarFont1"><B>Package</B></FONT></A> </TD><TD BGCOLOR="#FFFFFF" ID="NavBarCell1Rev"> <FONT ID="NavBarFont1Rev"><B>Class</B></FONT> </TD><TD BGCOLOR="#EEEEFF" ID="NavBarCell1"><A HREF= "class-use/PDFDocument.html"><FONT ID="NavBarFont1"><B>Use</B></FONT></A> </TD><TD BGCOLOR="#EEEEFF" ID="NavBarCell1"><A HREF= "package-tree.html"><FONT ID="NavBarFont1"><B>Tree</B></FONT></A> </TD><TD BGCOLOR="#EEEEFF" ID="NavBarCell1"><A HREF= "../../../../index-all.html"><FONT ID="NavBarFont1"><B>Index</B></FONT></A> </TD><TD BGCOLOR="#EEEEFF" ID="NavBarCell1"><A HREF= "../../../../help-doc.html"><FONT ID="NavBarFont1"><B>Help</B></FONT></A> </TD></TR></TABLE><TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM></TD></EM></TD></TR><TR><TD BGCOLOR="white" ID="NavBarCell2"><FONT SIZE="-2"> <A HREF= "../../../../org/apache/fop/pdf/PDFColor.html"><B>PREV CLASS</B></A> <A HREF= "../../../../org/apache/fop/pdf/PDFEncoding.html"><B>NEXT CLASS</B></A></FONT></TD><TD BGCOLOR="white" ID="NavBarCell2"><FONT SIZE="-2"> <A HREF= "../../../../index.html" TARGET="_top"><B>FRAMES</B></A> <A HREF= "PDFDocument.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD></TR><TR><TD VALIGN="top" ID="NavBarCell3"><FONT SIZE="-2">SUMMARY: INNER | FIELD | <A HREF= "#constructor_summary">CONSTR</A> | <A HREF= "#method_summary">METHOD</A></FONT></TD><TD VALIGN="top" ID="NavBarCell3"><FONT SIZE="-2">DETAIL: FIELD | <A HREF= "#constructor_detail">CONSTR</A> | <A HREF= "#method_detail">METHOD</A></FONT></TD></TR></TABLE><!-- ========== END OF NAVBAR ========== --><HR></BODY></HTML>