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:44 UTC

cvs commit: xml-fop/docs/design/contrib/pdf/org/apache/fop/pdf PDFFont.html

arved       01/01/29 18:58:44

  Added:       docs/design/contrib/pdf/org/apache/fop/pdf PDFFont.html
  Log:
  PDF package HTML
  
  Revision  Changes    Path
  1.1                  xml-fop/docs/design/contrib/pdf/org/apache/fop/pdf/PDFFont.html
  
  Index: PDFFont.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>&nbsp;</TD><TD BGCOLOR="#EEEEFF" ID="NavBarCell1"><A HREF= "package-summary.html"><FONT ID="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD><TD BGCOLOR="#FFFFFF" ID="NavBarCell1Rev"> &nbsp;<FONT ID="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD><TD BGCOLOR="#EEEEFF" ID="NavBarCell1"><A HREF= "class-use/PDFFont.html"><FONT ID="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD><TD BGCOLOR="#EEEEFF" ID="NavBarCell1"><A HREF= "package-tree.html"><FONT ID="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD><TD BGCOLOR="#EEEEFF" ID="NavBarCell1"><A HREF= "../../../../index-all.html"><FONT ID="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD><TD BGCOLOR="#EEEEFF" ID="NavBarCell1"><A HREF= "../../../../help-doc.html"><FONT ID="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD></TR></TABLE><TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM></TD></EM></TD></TR><TR><TD BGCOLOR="white" ID="NavBarCell2"><FONT SIZE="-2">&nbsp;<A HREF= "../../../../org/apache/fop/pdf/PDFFilterException.html"><B>PREV CLASS</B></A>&nbsp;&nbsp;<A HREF= "../../../../org/apache/fop/pdf/PDFFontDescriptor.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>  &nbsp;&nbsp;<A HREF= "PDFFont.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD></TR><TR><TD VALIGN="top" ID="NavBarCell3"><FONT SIZE="-2">SUMMARY:&nbsp;INNER&nbsp;|&nbsp;<A HREF= "#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF= "#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF= "#method_summary">METHOD</A></FONT></TD><TD VALIGN="top" ID="NavBarCell3"><FONT SIZE="-2">DETAIL:&nbsp;<A HREF= "#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF= "#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<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 PDFFont</H2><PRE><A HREF= "../../../../org/apache/fop/pdf/PDFObject.html">org.apache.fop.pdf.PDFObject</A>
    |
    +--<B>org.apache.fop.pdf.PDFFont</B>
  </PRE><DL><DT><B>Direct Known Subclasses:</B><DD><A HREF= "../../../../org/apache/fop/pdf/PDFFontNonBase14.html">PDFFontNonBase14</A></DD></DL><HR><DL><DT>public class <B>PDFFont</B><DT>extends <A HREF= "../../../../org/apache/fop/pdf/PDFObject.html">PDFObject</A></DL><P>class representing a /Font object.
  
  A more complete object expressing the base font name and encoding of a
  font along with an internal name for the font used within
  streams of content.
  
  Fonts are specified on page 198 and onwards of the PDF 1.3 spec.<HR><!--  =========== FIELD SUMMARY ===========  --><A NAME= "field_summary"></A><TABLE BORDER="1"  CELLPADDING="3" CELLSPACING="0" WIDTH="100%"><TR BGCOLOR="#CCCCFF"  ID="TableHeadingColor"> <TD COLSPAN=2><FONT SIZE= "+2"><B>Field Summary</B></FONT></TD></TR><TR BGCOLOR="white" ID="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="20%"><FONT SIZE="-1"><CODE>&nbsp;final static byte</CODE></FONT></TD><TD><CODE><B><A HREF= "../../../../org/apache/fop/pdf/PDFFont.html#MMTYPE1">MMTYPE1</A></B></CODE><BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;font subtype to be used as parameter to createFont()</TD></TR><TR BGCOLOR="white" ID="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="20%"><FONT SIZE="-1"><CODE>&nbsp;final static byte</CODE></FONT></TD><TD><CODE><B><A HREF= "../../../../org/apache/fop/pdf/PDFFont.html#TRUETYPE">TRUETYPE</A></B></CODE><BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;font subtype to be used as parameter to createFont()</TD></TR><TR BGCOLOR="white" ID="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="20%"><FONT SIZE="-1"><CODE>&nbsp;final static byte</CODE></FONT></TD><TD><CODE><B><A HREF= "../../../../org/apache/fop/pdf/PDFFont.html#TYPE0">TYPE0</A></B></CODE><BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;font subtype to be used as parameter to createFont()</TD></TR><TR BGCOLOR="white" ID="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="20%"><FONT SIZE="-1"><CODE>&nbsp;final static byte</CODE></FONT></TD><TD><CODE><B><A HREF= "../../../../org/apache/fop/pdf/PDFFont.html#TYPE1">TYPE1</A></B></CODE><BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;font subtype to be used as parameter to createFont()</TD></TR><TR BGCOLOR="white" ID="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="20%"><FONT SIZE="-1"><CODE>&nbsp;final static byte</CODE></FONT></TD><TD><CODE><B><A HREF= "../../../../org/apache/fop/pdf/PDFFont.html#TYPE3">TYPE3</A></B></CODE><BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;font subtype to be used as parameter to createFont()</TD></TR></TABLE><BR><!--  =========== 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/PDFFont.html#PDFFont(int, java.lang.String, byte, java.lang.String, java.lang.Object)">PDFFont</A></B>(int number, String fontname, byte subtype, String basefont, Object encoding)</CODE><BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;create the /Font 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>&nbsp;static <A HREF= "../../../../org/apache/fop/pdf/PDFFont.html">PDFFont</A></CODE></FONT></TD><TD><CODE><B><A HREF= "../../../../org/apache/fop/pdf/PDFFont.html#createFont(int, java.lang.String, byte, java.lang.String, java.lang.Object)">createFont</A></B>(int number, String fontname, byte subtype, String basefont, Object encoding)</CODE><BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;factory method with the basic parameters</TD></TR><TR BGCOLOR="white" ID="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="20%"><FONT SIZE="-1"><CODE>&nbsp;static <A HREF= "../../../../org/apache/fop/pdf/PDFFont.html">PDFFont</A></CODE></FONT></TD><TD><CODE><B><A HREF= "../../../../org/apache/fop/pdf/PDFFont.html#createFont(int, java.lang.String, byte, java.lang.String, java.lang.Object, int, int, org.apache.fop.pdf.PDFArray, org.apache.fop.pdf.PDFFontDescriptor)">createFont</A></B>(int number, String fontname, byte subtype, String basefont, Object encoding, int firstChar, int lastChar, <A HREF= "../../../../org/apache/fop/pdf/PDFArray.html">PDFArray</A> widths, <A HREF= "../../../../org/apache/fop/pdf/PDFFontDescriptor.html">PDFFontDescriptor</A> descriptor)</CODE><BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;factory method with the extended parameters
  for Type1, MMType1 and TrueType</TD></TR><TR BGCOLOR="white" ID="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="20%"><FONT SIZE="-1"><CODE>&nbsp;String</CODE></FONT></TD><TD><CODE><B><A HREF= "../../../../org/apache/fop/pdf/PDFFont.html#getName()">getName</A></B>()</CODE><BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;get the internal name used for this font</TD></TR><TR BGCOLOR="white" ID="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="20%"><FONT SIZE="-1"><CODE>&nbsp;byte[]</CODE></FONT></TD><TD><CODE><B><A HREF= "../../../../org/apache/fop/pdf/PDFFont.html#toPDF()">toPDF</A></B>()</CODE><BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;produce the PDF representation for the object</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><!--  =========== FIELD DETAIL ===========  --><A NAME= "field_detail"></A><TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"><TR BGCOLOR="#CCCCFF" ID="TableHeadingColor"><TD COLSPAN=1><FONT SIZE="+2"><B>Field Detail</B></FONT></TD></TR></TABLE><BR><A NAME= "MMTYPE1"><H3>MMTYPE1</H3></A><PRE>public final static byte <B>MMTYPE1</B></PRE><DL><DD>font subtype to be used as parameter to createFont()</DL><HR><A NAME= "TRUETYPE"><H3>TRUETYPE</H3></A><PRE>public final static byte <B>TRUETYPE</B></PRE><DL><DD>font subtype to be used as parameter to createFont()</DL><HR><A NAME= "TYPE0"><H3>TYPE0</H3></A><PRE>public final static byte <B>TYPE0</B></PRE><DL><DD>font subtype to be used as parameter to createFont()</DL><HR><A NAME= "TYPE1"><H3>TYPE1</H3></A><PRE>public final static byte <B>TYPE1</B></PRE><DL><DD>font subtype to be used as parameter to createFont()</DL><HR><A NAME= "TYPE3"><H3>TYPE3</H3></A><PRE>public final static byte <B>TYPE3</B></PRE><DL><DD>font subtype to be used as parameter to createFont()</DL><!--  =========== 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= "PDFFont(int, java.lang.String, byte, java.lang.String, java.lang.Object)"><H3>PDFFont</H3></A><PRE>public <B>PDFFont</B>(int number, String fontname, byte subtype, String basefont, Object encoding)</PRE><DL><DD>create the /Font object<DD><DL><DT><B>Parameters:</B><DD>number - the object's number<DD>fontname - the internal name for the font<DD>subtype - the font's subtype<DD>basefont - the base font name<DD>encoding - the character encoding schema used by the font<DD>mapping - the Unicode mapping mechanism</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= "createFont(int, java.lang.String, byte, java.lang.String, java.lang.Object)"><H3>createFont</H3></A><PRE>public static <A HREF= "../../../../org/apache/fop/pdf/PDFFont.html">PDFFont</A> <B>createFont</B>(int number, String fontname, byte subtype, String basefont, Object encoding)</PRE><DL><DD>factory method with the basic parameters<DD><DL><DT><B>Parameters:</B><DD>number - the object's number<DD>fontname - the internal name for the font<DD>subtype - the font's subtype<DD>basefont - the base font name<DD>encoding - the character encoding schema used by the font</DL></DD></DL><HR><A NAME= "createFont(int, java.lang.String, byte, java.lang.String, java.lang.Object, int, int, org.apache.fop.pdf.PDFArray, org.apache.fop.pdf.PDFFontDescriptor)"><H3>createFont</H3></A><PRE>public static <A HREF= "../../../../org/apache/fop/pdf/PDFFont.html">PDFFont</A> <B>createFont</B>(int number, String fontname, byte subtype, String basefont, Object encoding, int firstChar, int lastChar, <A HREF= "../../../../org/apache/fop/pdf/PDFArray.html">PDFArray</A> widths, <A HREF= "../../../../org/apache/fop/pdf/PDFFontDescriptor.html">PDFFontDescriptor</A> descriptor)</PRE><DL><DD>factory method with the extended parameters
  for Type1, MMType1 and TrueType<DD><DL><DT><B>Parameters:</B><DD>number - the object's number<DD>fontname - the internal name for the font<DD>subtype - the font's subtype<DD>basefont - the base font name<DD>encoding - the character encoding schema used by the font<DD>firstChar - the first character code in the font<DD>lastChar - the last character code in the font<DD>widths - an array of size (lastChar - firstChar +1)<DD>descriptor - the descriptor for other font's metrics</DL></DD></DL><HR><A NAME= "getName()"><H3>getName</H3></A><PRE>public String <B>getName</B>()</PRE><DL><DD>get the internal name used for this font<DD><DL><DT><B>Returns: </B>the internal name</DL></DD></DL><HR><A NAME= "toPDF()"><H3>toPDF</H3></A><PRE>public byte[] <B>toPDF</B>()</PRE><DL><DD>produce the PDF representation for the object<DD><DL><DT><B>Returns: </B>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>font subtype names as output in the PDF</DL><P>to <B>Class </B>java.lang.String<DL><DD>the internal name for the font (eg "F1")</DL><P>to <B>Class </B>java.lang.String<DL><DD>the base font name (eg "Helvetica")</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>&nbsp;</TD><TD BGCOLOR="#EEEEFF" ID="NavBarCell1"><A HREF= "package-summary.html"><FONT ID="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD><TD BGCOLOR="#FFFFFF" ID="NavBarCell1Rev"> &nbsp;<FONT ID="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD><TD BGCOLOR="#EEEEFF" ID="NavBarCell1"><A HREF= "class-use/PDFFont.html"><FONT ID="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD><TD BGCOLOR="#EEEEFF" ID="NavBarCell1"><A HREF= "package-tree.html"><FONT ID="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD><TD BGCOLOR="#EEEEFF" ID="NavBarCell1"><A HREF= "../../../../index-all.html"><FONT ID="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD><TD BGCOLOR="#EEEEFF" ID="NavBarCell1"><A HREF= "../../../../help-doc.html"><FONT ID="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD></TR></TABLE><TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM></TD></EM></TD></TR><TR><TD BGCOLOR="white" ID="NavBarCell2"><FONT SIZE="-2">&nbsp;<A HREF= "../../../../org/apache/fop/pdf/PDFFilterException.html"><B>PREV CLASS</B></A>&nbsp;&nbsp;<A HREF= "../../../../org/apache/fop/pdf/PDFFontDescriptor.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>  &nbsp;&nbsp;<A HREF= "PDFFont.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD></TR><TR><TD VALIGN="top" ID="NavBarCell3"><FONT SIZE="-2">SUMMARY:&nbsp;INNER&nbsp;|&nbsp;<A HREF= "#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF= "#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF= "#method_summary">METHOD</A></FONT></TD><TD VALIGN="top" ID="NavBarCell3"><FONT SIZE="-2">DETAIL:&nbsp;<A HREF= "#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF= "#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF= "#method_detail">METHOD</A></FONT></TD></TR></TABLE><!-- ========== END OF NAVBAR ========== --><HR></BODY></HTML>