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 04:00:33 UTC
cvs commit: xml-fop/docs/design/contrib/pdf/org/apache/fop/pdf PDFPage.html
arved 01/01/29 19:00:32
Added: docs/design/contrib/pdf/org/apache/fop/pdf PDFPage.html
Log:
PDF package HTML
Revision Changes Path
1.1 xml-fop/docs/design/contrib/pdf/org/apache/fop/pdf/PDFPage.html
Index: PDFPage.html
===================================================================
<HTML><HEAD><!-- Generated by Together onThu Jan 25 10:51:04 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/PDFPage.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/PDFObject.html"><B>PREV CLASS</B></A> <A HREF= "../../../../org/apache/fop/pdf/PDFPages.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= "PDFPage.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 PDFPage</H2><PRE><A HREF= "../../../../org/apache/fop/pdf/PDFObject.html">org.apache.fop.pdf.PDFObject</A>
|
+--<B>org.apache.fop.pdf.PDFPage</B>
</PRE><HR><DL><DT>public class <B>PDFPage</B><DT>extends <A HREF= "../../../../org/apache/fop/pdf/PDFObject.html">PDFObject</A></DL><P>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.<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/PDFPage.html#PDFPage(int, org.apache.fop.pdf.PDFResources, org.apache.fop.pdf.PDFStream, int, int)">PDFPage</A></B>(int number, <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)</CODE><BR> create a /Page object</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> void</CODE></FONT></TD><TD><CODE><B><A HREF= "../../../../org/apache/fop/pdf/PDFPage.html#addShading(org.apache.fop.pdf.PDFShading)">addShading</A></B>(<A HREF= "../../../../org/apache/fop/pdf/PDFShading.html">PDFShading</A> shading)</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/PDFAnnotList.html">PDFAnnotList</A></CODE></FONT></TD><TD><CODE><B><A HREF= "../../../../org/apache/fop/pdf/PDFPage.html#getAnnotList()">getAnnotList</A></B>()</CODE><BR> get this page's annotation list</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/PDFPage.html#setAnnotList(org.apache.fop.pdf.PDFAnnotList)">setAnnotList</A></B>(<A HREF= "../../../../org/apache/fop/pdf/PDFAnnotList.html">PDFAnnotList</A> annotList)</CODE><BR> set this page's annotation list</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/PDFPage.html#setParent(org.apache.fop.pdf.PDFPages)">setParent</A></B>(<A HREF= "../../../../org/apache/fop/pdf/PDFPages.html">PDFPages</A> parent)</CODE><BR> set this page's parent</TD></TR><TR BGCOLOR="white" ID="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="20%"><FONT SIZE="-1"><CODE> byte[]</CODE></FONT></TD><TD><CODE><B><A HREF= "../../../../org/apache/fop/pdf/PDFPage.html#toPDF()">toPDF</A></B>()</CODE><BR> represent this object as PDF</TD></TR></TABLE><BR><A NAME= "methods_inherited_from_class_org.apache.fop.pdf.PDFObject"></A><TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"><TR BGCOLOR="#EEEEFF" ID="TableSubHeadingColor"><TD><B>Methods inherited from class org.apache.fop.pdf.<A HREF= "../../../../org/apache/fop/pdf/PDFObject.html">PDFObject</A><B></TD></TR><TR BGCOLOR="white" ID="TableRowColor"><TD><CODE><A HREF= "../../../../org/apache/fop/pdf/PDFObject.html#getNumber()">getNumber</A>, <A HREF= "../../../../org/apache/fop/pdf/PDFObject.html#referencePDF()">referencePDF</A></CODE></TD></TR></TABLE><P><!-- =========== 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= "PDFPage(int, org.apache.fop.pdf.PDFResources, org.apache.fop.pdf.PDFStream, int, int)"><H3>PDFPage</H3></A><PRE>public <B>PDFPage</B>(int number, <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)</PRE><DL><DD>create a /Page object<DD><DL><DT><B>Parameters:</B><DD>number - the object's number<DD>resources - the /Resources object<DD>contents - the content stream<DD>pagewidth - the page's width in points<DD>pageheight - the page's height in points</DL></DD></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= "addShading(org.apache.fop.pdf.PDFShading)"><H3>addShading</H3></A><PRE>public void <B>addShading</B>(<A HREF= "../../../../org/apache/fop/pdf/PDFShading.html">PDFShading</A> shading)</PRE><DL><DD></DL><HR><A NAME= "getAnnotList()"><H3>getAnnotList</H3></A><PRE>public <A HREF= "../../../../org/apache/fop/pdf/PDFAnnotList.html">PDFAnnotList</A> <B>getAnnotList</B>()</PRE><DL><DD>get this page's annotation list<DD><DL><DT><B>Returns: </B>annotList a PDFAnnotList list of annotations</DL></DD></DL><HR><A NAME= "setAnnotList(org.apache.fop.pdf.PDFAnnotList)"><H3>setAnnotList</H3></A><PRE>public void <B>setAnnotList</B>(<A HREF= "../../../../org/apache/fop/pdf/PDFAnnotList.html">PDFAnnotList</A> annotList)</PRE><DL><DD>set this page's annotation list<DD><DL><DT><B>Parameters:</B><DD>annotList - a PDFAnnotList list of annotations</DL></DD></DL><HR><A NAME= "setParent(org.apache.fop.pdf.PDFPages)"><H3>setParent</H3></A><PRE>public void <B>setParent</B>(<A HREF= "../../../../org/apache/fop/pdf/PDFPages.html">PDFPages</A> parent)</PRE><DL><DD>set this page's parent<DD><DL><DT><B>Parameters:</B><DD>parent - the /Pages object that is this page's parent</DL></DD></DL><HR><A NAME= "toPDF()"><H3>toPDF</H3></A><PRE>public byte[] <B>toPDF</B>()</PRE><DL><DD>represent this object as PDF<DD><DL><DT><B>Returns: </B>the PDF string</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><A HREF= "../../../../org/apache/fop/pdf/PDFPages.html">org.apache.fop.pdf.PDFPages</A><DL><DD>the page's parent, a /Pages object</DL><P>to <B>Class </B><A HREF= "../../../../org/apache/fop/pdf/PDFResources.html">org.apache.fop.pdf.PDFResources</A><DL><DD>the page's /Resource object</DL><P>to <B>Class </B><A HREF= "../../../../org/apache/fop/pdf/PDFStream.html">org.apache.fop.pdf.PDFStream</A><DL><DD>the contents stream</DL><P>to <B>Class </B><A HREF= "../../../../org/apache/fop/pdf/PDFAnnotList.html">org.apache.fop.pdf.PDFAnnotList</A><DL><DD>the list of annotation objects for this page</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/PDFPage.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/PDFObject.html"><B>PREV CLASS</B></A> <A HREF= "../../../../org/apache/fop/pdf/PDFPages.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= "PDFPage.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>