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:34 UTC
cvs commit: xml-fop/docs/design/contrib/pdf/org/apache/fop/pdf PDFShading.html
arved 01/01/29 19:01:34
Added: docs/design/contrib/pdf/org/apache/fop/pdf PDFShading.html
Log:
PDF package HTML
Revision Changes Path
1.1 xml-fop/docs/design/contrib/pdf/org/apache/fop/pdf/PDFShading.html
Index: PDFShading.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/PDFShading.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/PDFRoot.html"><B>PREV CLASS</B></A> <A HREF= "../../../../org/apache/fop/pdf/PDFStream.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= "PDFShading.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 PDFShading</H2><PRE><A HREF= "../../../../org/apache/fop/pdf/PDFObject.html">org.apache.fop.pdf.PDFObject</A>
|
+--<B>org.apache.fop.pdf.PDFShading</B>
</PRE><HR><DL><DT>public class <B>PDFShading</B><DT>extends <A HREF= "../../../../org/apache/fop/pdf/PDFObject.html">PDFObject</A></DL><P>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.<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/PDFShading.html#PDFShading(int, java.lang.String, int, org.apache.fop.datatypes.ColorSpace, java.util.Vector, java.util.Vector, boolean, java.util.Vector, java.util.Vector, org.apache.fop.pdf.PDFFunction)">PDFShading</A></B>(int theNumber, String theShadingName, 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> Constructor for type function based shading</TD></TR><TR BGCOLOR="white" ID="TableRowColor"><TD><CODE><B><A HREF= "../../../../org/apache/fop/pdf/PDFShading.html#PDFShading(int, java.lang.String, 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)">PDFShading</A></B>(int theNumber, String theShadingName, 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> Constructor for Type 2 and 3</TD></TR><TR BGCOLOR="white" ID="TableRowColor"><TD><CODE><B><A HREF= "../../../../org/apache/fop/pdf/PDFShading.html#PDFShading(int, java.lang.String, int, org.apache.fop.datatypes.ColorSpace, java.util.Vector, java.util.Vector, boolean, int, int, int, java.util.Vector, org.apache.fop.pdf.PDFFunction)">PDFShading</A></B>(int theNumber, String theShadingName, 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> Constructor for Type 4,6, or 7</TD></TR><TR BGCOLOR="white" ID="TableRowColor"><TD><CODE><B><A HREF= "../../../../org/apache/fop/pdf/PDFShading.html#PDFShading(int, java.lang.String, int, org.apache.fop.datatypes.ColorSpace, java.util.Vector, java.util.Vector, boolean, int, int, java.util.Vector, int, org.apache.fop.pdf.PDFFunction)">PDFShading</A></B>(int theNumber, String theShadingName, 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> Constructor for type 5</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/PDFShading.html#getName()">getName</A></B>()</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/PDFShading.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= "PDFShading(int, java.lang.String, 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>PDFShading</H3></A><PRE>public <B>PDFShading</B>(int theNumber, String theShadingName, 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>Constructor for type function based shading<DD><DL><DT><B>Parameters:</B><DD>theNumber - The object number of this PDF object<DD>theShadingName - The name of the shading pattern. Can be anything
without spaces. "Shading1" or "Sh1" are good examples.<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= "PDFShading(int, java.lang.String, 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>PDFShading</H3></A><PRE>public <B>PDFShading</B>(int theNumber, String theShadingName, 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>Constructor for Type 2 and 3<DD><DL><DT><B>Parameters:</B><DD>theNumber - The object number of this PDF object.<DD>theShadingName - The name of the shading pattern. Can be anything
without spaces. "Shading1" or "Sh1" are good examples.<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= "PDFShading(int, java.lang.String, 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>PDFShading</H3></A><PRE>public <B>PDFShading</B>(int theNumber, String theShadingName, 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>Constructor for Type 4,6, or 7<DD><DL><DT><B>Parameters:</B><DD>theNumber - The object number of this PDF object.<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>theShadingName - The name of the shading pattern. Can be anything
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, 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= "PDFShading(int, java.lang.String, 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>PDFShading</H3></A><PRE>public <B>PDFShading</B>(int theNumber, String theShadingName, 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>Constructor for type 5<DD><DL><DT><B>Parameters:</B><DD>theShadingType - 5 for lattice-Form Gouraud shaded-triangle mesh<DD>theShadingName - The name of the shading pattern. Can be anything
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<DD>theNumber - the object number of this PDF object.</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= "getName()"><H3>getName</H3></A><PRE>public String <B>getName</B>()</PRE><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 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.<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.lang.String<DL><DD>The name of the Shading e.g. "Shading1"</DL><P>to <B>Class </B>org.apache.fop.datatypes.ColorSpace<DL><DD>A ColorSpace representing the colorspace. "DeviceRGB" is an example.</DL><P>to <B>Class </B>java.util.Vector<DL><DD>The background color. Since shading is opaque,
this is very rarely used.</DL><P>to <B>Class </B>java.util.Vector<DL><DD>Optional: A Vector specifying the clipping rectangle</DL><P>to <B>Class </B>java.util.Vector<DL><DD>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.</DL><P>to <B>Class </B>java.util.Vector<DL><DD>Optional for Type 1: A transformation matrix</DL><P>to <B>Class </B><A HREF= "../../../../org/apache/fop/pdf/PDFFunction.html">org.apache.fop.pdf.PDFFunction</A><DL><DD>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.</DL><P>to <B>Class </B>java.util.Vector<DL><DD>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.</DL><P>to <B>Class </B>java.util.Vector<DL><DD>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.</DL><P>to <B>Class </B>java.util.Vector<DL><DD>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</DL><P>to <B>Class </B><A HREF= "../../../../org/apache/fop/pdf/PDFNumber.html">org.apache.fop.pdf.PDFNumber</A><DL></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/PDFShading.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/PDFRoot.html"><B>PREV CLASS</B></A> <A HREF= "../../../../org/apache/fop/pdf/PDFStream.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= "PDFShading.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>