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:01:42 UTC
cvs commit: xml-fop/docs/design/contrib/pdf/org/apache/fop/pdf PDFStream.html
arved 01/01/29 19:01:42
Added: docs/design/contrib/pdf/org/apache/fop/pdf PDFStream.html
Log:
PDF package HTML
Revision Changes Path
1.1 xml-fop/docs/design/contrib/pdf/org/apache/fop/pdf/PDFStream.html
Index: PDFStream.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/PDFStream.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/PDFShading.html"><B>PREV CLASS</B></A> <A HREF= "../../../../org/apache/fop/pdf/PDFUri.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= "PDFStream.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 PDFStream</H2><PRE><A HREF= "../../../../org/apache/fop/pdf/PDFObject.html">org.apache.fop.pdf.PDFObject</A>
|
+--<B>org.apache.fop.pdf.PDFStream</B>
</PRE><HR><DL><DT>public class <B>PDFStream</B><DT>extends <A HREF= "../../../../org/apache/fop/pdf/PDFObject.html">PDFObject</A></DL><P>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.<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/PDFStream.html#PDFStream(int)">PDFStream</A></B>(int number)</CODE><BR> create an empty stream 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/PDFStream.html#add(java.lang.String)">add</A></B>(String s)</CODE><BR> append data to the stream</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/PDFStream.html#addFilter(org.apache.fop.pdf.PDFFilter)">addFilter</A></B>(<A HREF= "../../../../org/apache/fop/pdf/PDFFilter.html">PDFFilter</A> filter)</CODE><BR> Add a filter for compression of the stream.</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/PDFStream.html#addFilter(java.lang.String)">addFilter</A></B>(String filterType)</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/PDFStream.html#addImageArray(int[], int, int)">addImageArray</A></B>(int[] pixels, int width, int height)</CODE><BR> append an array of xRGB pixels, ASCII Hex Encoding it first</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/PDFStream.html#getData()">getData</A></B>()</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/PDFStream.html#getDataLength()">getDataLength</A></B>()</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/PDFStream.html#setData(byte[])">setData</A></B>(byte[] data)</CODE><BR> </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/PDFStream.html#toPDF()">toPDF</A></B>()</CODE><BR> represent 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= "PDFStream(int)"><H3>PDFStream</H3></A><PRE>public <B>PDFStream</B>(int number)</PRE><DL><DD>create an empty stream object<DD><DL><DT><B>Parameters:</B><DD>number - the object's number</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= "add(java.lang.String)"><H3>add</H3></A><PRE>public void <B>add</B>(String s)</PRE><DL><DD>append data to the stream<DD><DL><DT><B>Parameters:</B><DD>s - the string of PDF to add</DL></DD></DL><HR><A NAME= "addFilter(org.apache.fop.pdf.PDFFilter)"><H3>addFilter</H3></A><PRE>public void <B>addFilter</B>(<A HREF= "../../../../org/apache/fop/pdf/PDFFilter.html">PDFFilter</A> filter)</PRE><DL><DD>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.</DL><HR><A NAME= "addFilter(java.lang.String)"><H3>addFilter</H3></A><PRE>public void <B>addFilter</B>(String filterType)</PRE><DL><DD></DL><HR><A NAME= "addImageArray(int[], int, int)"><H3>addImageArray</H3></A><PRE>public void <B>addImageArray</B>(int[] pixels, int width, int height)</PRE><DL><DD>append an array of xRGB pixels, ASCII Hex Encoding it first<DD><DL><DT><B>Parameters:</B><DD>pixels - the area of pixels<DD>width - the width of the image in pixels<DD>height - the height of the image in pixels</DL></DD></DL><HR><A NAME= "getData()"><H3>getData</H3></A><PRE>public byte[] <B>getData</B>()</PRE><DL><DD></DL><HR><A NAME= "getDataLength()"><H3>getDataLength</H3></A><PRE>public int <B>getDataLength</B>()</PRE><DL><DD></DL><HR><A NAME= "setData(byte[])"><H3>setData</H3></A><PRE>public void <B>setData</B>(byte[] data)<BR> throws java.io.IOException</A></PRE><DL><DD></DL><HR><A NAME= "toPDF()"><H3>toPDF</H3></A><PRE>public byte[] <B>toPDF</B>()</PRE><DL><DD>represent 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>java.io.ByteArrayOutputStream<DL><DD>the stream of PDF commands</DL><P>to <B>Class </B>java.util.Vector<DL><DD>the filters that should be applied</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/PDFStream.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/PDFShading.html"><B>PREV CLASS</B></A> <A HREF= "../../../../org/apache/fop/pdf/PDFUri.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= "PDFStream.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>