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:00 UTC
cvs commit: xml-fop/docs/design/contrib/pdf/org/apache/fop/pdf PDFPattern.html
arved 01/01/29 19:01:00
Added: docs/design/contrib/pdf/org/apache/fop/pdf PDFPattern.html
Log:
PDF package HTML
Revision Changes Path
1.1 xml-fop/docs/design/contrib/pdf/org/apache/fop/pdf/PDFPattern.html
Index: PDFPattern.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/PDFPattern.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/PDFPathPaint.html"><B>PREV CLASS</B></A> <A HREF= "../../../../org/apache/fop/pdf/PDFRectangle.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= "PDFPattern.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 PDFPattern</H2><PRE><A HREF= "../../../../org/apache/fop/pdf/PDFObject.html">org.apache.fop.pdf.PDFObject</A>
|
+--<A HREF= "../../../../org/apache/fop/pdf/PDFPathPaint.html">org.apache.fop.pdf.PDFPathPaint</A>
|
+--<B>org.apache.fop.pdf.PDFPattern</B>
</PRE><HR><DL><DT>public class <B>PDFPattern</B><DT>extends <A HREF= "../../../../org/apache/fop/pdf/PDFPathPaint.html">PDFPathPaint</A></DL><P>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.<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/PDFPattern.html#PDFPattern(int, java.lang.String, org.apache.fop.pdf.PDFResources, int, int, int, java.util.Vector, double, double, java.util.Vector, java.util.Vector, java.lang.StringBuffer)">PDFPattern</A></B>(int theNumber, String thePatternName, <A HREF= "../../../../org/apache/fop/pdf/PDFResources.html">PDFResources</A> theResources, int thePatternType, int thePaintType, int theTilingType, Vector theBBox, double theXStep, double theYStep, Vector theMatrix, Vector theXUID, StringBuffer thePatternDataStream)</CODE><BR> Create a tiling pattern (type 1).</TD></TR><TR BGCOLOR="white" ID="TableRowColor"><TD><CODE><B><A HREF= "../../../../org/apache/fop/pdf/PDFPattern.html#PDFPattern(int, java.lang.String, int, org.apache.fop.pdf.PDFShading, java.util.Vector, java.lang.StringBuffer, java.util.Vector)">PDFPattern</A></B>(int theNumber, String thePatternName, int thePatternType, <A HREF= "../../../../org/apache/fop/pdf/PDFShading.html">PDFShading</A> theShading, Vector theXUID, StringBuffer theExtGState, Vector theMatrix)</CODE><BR> Create a type 2 pattern (smooth shading)</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> String</CODE></FONT></TD><TD><CODE><B><A HREF= "../../../../org/apache/fop/pdf/PDFPattern.html#getColorSpaceOut(boolean)">getColorSpaceOut</A></B>(boolean fillNotStroke)</CODE><BR> </TD></TR><TR BGCOLOR="white" ID="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="20%"><FONT SIZE="-1"><CODE> String</CODE></FONT></TD><TD><CODE><B><A HREF= "../../../../org/apache/fop/pdf/PDFPattern.html#getName()">getName</A></B>()</CODE><BR> Get the name of the pattern</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/PDFPattern.html#toPDF()">toPDF</A></B>()</CODE><BR> represent as PDF.</TD></TR></TABLE><BR><A NAME= "methods_inherited_from_class_org.apache.fop.pdf.PDFPathPaint"></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/PDFPathPaint.html">PDFPathPaint</A><B></TD></TR><TR BGCOLOR="white" ID="TableRowColor"><TD><CODE><A HREF= "../../../../org/apache/fop/pdf/PDFPathPaint.html#getColorSpace()">getColorSpace</A>, <A HREF= "../../../../org/apache/fop/pdf/PDFPathPaint.html#setColorSpace(int)">setColorSpace</A></CODE></TD></TR></TABLE><P><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= "PDFPattern(int, java.lang.String, org.apache.fop.pdf.PDFResources, int, int, int, java.util.Vector, double, double, java.util.Vector, java.util.Vector, java.lang.StringBuffer)"><H3>PDFPattern</H3></A><PRE>public <B>PDFPattern</B>(int theNumber, String thePatternName, <A HREF= "../../../../org/apache/fop/pdf/PDFResources.html">PDFResources</A> theResources, int thePatternType, int thePaintType, int theTilingType, Vector theBBox, double theXStep, double theYStep, Vector theMatrix, Vector theXUID, StringBuffer thePatternDataStream)</PRE><DL><DD>Create a tiling pattern (type 1).<DD><DL><DT><B>Parameters:</B><DD>theNumber - The object number of this PDF Object<DD>thePatternName - The name of the pattern such as "Pa1" or "Pattern1"<DD>theResources - the resources associated with this pattern<DD>thePatternType - the type of pattern, which is 1 for tiling.<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= "PDFPattern(int, java.lang.String, int, org.apache.fop.pdf.PDFShading, java.util.Vector, java.lang.StringBuffer, java.util.Vector)"><H3>PDFPattern</H3></A><PRE>public <B>PDFPattern</B>(int theNumber, String thePatternName, int thePatternType, <A HREF= "../../../../org/apache/fop/pdf/PDFShading.html">PDFShading</A> theShading, Vector theXUID, StringBuffer theExtGState, Vector theMatrix)</PRE><DL><DD>Create a type 2 pattern (smooth shading)<DD><DL><DT><B>Parameters:</B><DD>theNumber - the object number of this PDF object<DD>thePatternName - the name of the pattern<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><!-- =========== 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= "getColorSpaceOut(boolean)"><H3>getColorSpaceOut</H3></A><PRE>public String <B>getColorSpaceOut</B>(boolean fillNotStroke)</PRE><DL><DD></DL><HR><A NAME= "getName()"><H3>getName</H3></A><PRE>public String <B>getName</B>()</PRE><DL><DD>Get the name of the pattern<DD><DL><DT><B>Returns: </B>String representing the name of the pattern.</DL></DD></DL><HR><A NAME= "toPDF()"><H3>toPDF</H3></A><PRE>public byte[] <B>toPDF</B>()</PRE><DL><DD>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.<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/PDFNumber.html">org.apache.fop.pdf.PDFNumber</A><DL></DL><P>to <B>Class </B><A HREF= "../../../../org/apache/fop/pdf/PDFResources.html">org.apache.fop.pdf.PDFResources</A><DL><DD>The resources associated with this pattern</DL><P>to <B>Class </B>java.lang.String<DL><DD>The name of the pattern such as "Pa1" or "Pattern1"</DL><P>to <B>Class </B>java.util.Vector<DL><DD>Vector of Doubles representing the Bounding box rectangle</DL><P>to <B>Class </B><A HREF= "../../../../org/apache/fop/pdf/PDFShading.html">org.apache.fop.pdf.PDFShading</A><DL><DD>The Shading object comprising the Type 2 pattern</DL><P>to <B>Class </B>java.util.Vector<DL><DD>Vector of Integers represetning the Extended unique Identifier</DL><P>to <B>Class </B>java.lang.StringBuffer<DL><DD>String representing the extended Graphics state.
Probably will never be used like this.</DL><P>to <B>Class </B>java.util.Vector<DL><DD>Vector of Doubles representing the Transformation matrix.</DL><P>to <B>Class </B>java.lang.StringBuffer<DL><DD>The stream of a pattern</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/PDFPattern.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/PDFPathPaint.html"><B>PREV CLASS</B></A> <A HREF= "../../../../org/apache/fop/pdf/PDFRectangle.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= "PDFPattern.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>