/trunk/contribs/fop-1.0/javadocs/org/apache/fop/render/AbstractFOEventHandlerMaker.html
HTML | 330 lines | 263 code | 42 blank | 25 comment | 0 complexity | e50a0f4ea5e9f3abcde7d12d1235197a MD5 | raw file
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
- <!--NewPage-->
- <HTML>
- <HEAD>
- <!-- Generated by javadoc (build 1.4.2_11) on Mon Jul 12 21:37:37 CEST 2010 -->
- <TITLE>
- AbstractFOEventHandlerMaker (Apache FOP 1.0 API)
- </TITLE>
- <META NAME="keywords" CONTENT="org.apache.fop.render.AbstractFOEventHandlerMaker class">
- <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
- <SCRIPT type="text/javascript">
- function windowTitle()
- {
- parent.document.title="AbstractFOEventHandlerMaker (Apache FOP 1.0 API)";
- }
- </SCRIPT>
- </HEAD>
- <BODY BGCOLOR="white" onload="windowTitle();">
- <!-- ========= START OF TOP NAVBAR ======= -->
- <A NAME="navbar_top"><!-- --></A>
- <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
- <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
- <TR>
- <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
- <A NAME="navbar_top_firstrow"><!-- --></A>
- <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
- <TR ALIGN="center" VALIGN="top">
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
- <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/AbstractFOEventHandlerMaker.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
- </TR>
- </TABLE>
- </TD>
- <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
- fop 1.0</EM>
- </TD>
- </TR>
- <TR>
- <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../../org/apache/fop/render/AbstractConfigurator.html" title="class in org.apache.fop.render"><B>PREV CLASS</B></A>
- <A HREF="../../../../org/apache/fop/render/AbstractGenericSVGHandler.html" title="class in org.apache.fop.render"><B>NEXT CLASS</B></A></FONT></TD>
- <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../../index.html" target="_top"><B>FRAMES</B></A>
- <A HREF="AbstractFOEventHandlerMaker.html" target="_top"><B>NO FRAMES</B></A>
- <SCRIPT type="text/javascript">
- <!--
- if(window==top) {
- document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
- }
- //-->
- </SCRIPT>
- <NOSCRIPT>
- <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
- </NOSCRIPT>
- </FONT></TD>
- </TR>
- <TR>
- <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
- SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
- <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
- DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
- </TR>
- </TABLE>
- <A NAME="skip-navbar_top"></A>
- <!-- ========= END OF TOP NAVBAR ========= -->
- <HR>
- <!-- ======== START OF CLASS DATA ======== -->
- <H2>
- <FONT SIZE="-1">
- org.apache.fop.render</FONT>
- <BR>
- Class AbstractFOEventHandlerMaker</H2>
- <PRE>
- java.lang.Object
- <IMG SRC="../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.fop.render.AbstractFOEventHandlerMaker</B>
- </PRE>
- <DL>
- <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../org/apache/fop/render/mif/MIFFOEventHandlerMaker.html" title="class in org.apache.fop.render.mif">MIFFOEventHandlerMaker</A>, <A HREF="../../../../org/apache/fop/render/rtf/RTFFOEventHandlerMaker.html" title="class in org.apache.fop.render.rtf">RTFFOEventHandlerMaker</A></DD>
- </DL>
- <HR>
- <DL>
- <DT>public abstract class <B>AbstractFOEventHandlerMaker</B><DT>extends java.lang.Object</DL>
- <P>
- Base class for factory classes which instantiate FOEventHandlers and provide information
- about them.
- <P>
- <P>
- <HR>
- <P>
- <!-- ======== NESTED CLASS SUMMARY ======== -->
- <!-- =========== FIELD SUMMARY =========== -->
- <!-- ======== CONSTRUCTOR SUMMARY ======== -->
- <A NAME="constructor_summary"><!-- --></A>
- <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
- <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
- <TD COLSPAN=2><FONT SIZE="+2">
- <B>Constructor Summary</B></FONT></TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD><CODE><B><A HREF="../../../../org/apache/fop/render/AbstractFOEventHandlerMaker.html#AbstractFOEventHandlerMaker()">AbstractFOEventHandlerMaker</A></B>()</CODE>
- <BR>
- </TD>
- </TR>
- </TABLE>
-
- <!-- ========== METHOD SUMMARY =========== -->
- <A NAME="method_summary"><!-- --></A>
- <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
- <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
- <TD COLSPAN=2><FONT SIZE="+2">
- <B>Method Summary</B></FONT></TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>abstract java.lang.String[]</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../org/apache/fop/render/AbstractFOEventHandlerMaker.html#getSupportedMimeTypes()">getSupportedMimeTypes</A></B>()</CODE>
- <BR>
- </TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> boolean</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../org/apache/fop/render/AbstractFOEventHandlerMaker.html#isMimeTypeSupported(java.lang.String)">isMimeTypeSupported</A></B>(java.lang.String mimeType)</CODE>
- <BR>
- Indicates whether a specific MIME type is supported by this renderer.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>abstract <A HREF="../../../../org/apache/fop/fo/FOEventHandler.html" title="class in org.apache.fop.fo">FOEventHandler</A></CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../org/apache/fop/render/AbstractFOEventHandlerMaker.html#makeFOEventHandler(org.apache.fop.apps.FOUserAgent, java.io.OutputStream)">makeFOEventHandler</A></B>(<A HREF="../../../../org/apache/fop/apps/FOUserAgent.html" title="class in org.apache.fop.apps">FOUserAgent</A> ua,
- java.io.OutputStream out)</CODE>
- <BR>
- Instantiates a new FOEventHandler.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>abstract boolean</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../org/apache/fop/render/AbstractFOEventHandlerMaker.html#needsOutputStream()">needsOutputStream</A></B>()</CODE>
- <BR>
- </TD>
- </TR>
- </TABLE>
- <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
- <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
- <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
- <TD><B>Methods inherited from class java.lang.Object</B></TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
- </TR>
- </TABLE>
-
- <P>
- <!-- ============ FIELD DETAIL =========== -->
- <!-- ========= CONSTRUCTOR DETAIL ======== -->
- <A NAME="constructor_detail"><!-- --></A>
- <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
- <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
- <TD COLSPAN=1><FONT SIZE="+2">
- <B>Constructor Detail</B></FONT></TD>
- </TR>
- </TABLE>
- <A NAME="AbstractFOEventHandlerMaker()"><!-- --></A><H3>
- AbstractFOEventHandlerMaker</H3>
- <PRE>
- public <B>AbstractFOEventHandlerMaker</B>()</PRE>
- <DL>
- </DL>
- <!-- ============ METHOD DETAIL ========== -->
- <A NAME="method_detail"><!-- --></A>
- <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
- <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
- <TD COLSPAN=1><FONT SIZE="+2">
- <B>Method Detail</B></FONT></TD>
- </TR>
- </TABLE>
- <A NAME="makeFOEventHandler(org.apache.fop.apps.FOUserAgent, java.io.OutputStream)"><!-- --></A><H3>
- makeFOEventHandler</H3>
- <PRE>
- public abstract <A HREF="../../../../org/apache/fop/fo/FOEventHandler.html" title="class in org.apache.fop.fo">FOEventHandler</A> <B>makeFOEventHandler</B>(<A HREF="../../../../org/apache/fop/apps/FOUserAgent.html" title="class in org.apache.fop.apps">FOUserAgent</A> ua,
- java.io.OutputStream out)
- throws <A HREF="../../../../org/apache/fop/apps/FOPException.html" title="class in org.apache.fop.apps">FOPException</A></PRE>
- <DL>
- <DD>Instantiates a new FOEventHandler.
- <P>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>ua</CODE> - the user agent<DD><CODE>out</CODE> - OutputStream for the FOEventHandler to use
- <DT><B>Returns:</B><DD>the newly instantiated FOEventHandler
- <DT><B>Throws:</B>
- <DD><CODE><A HREF="../../../../org/apache/fop/apps/FOPException.html" title="class in org.apache.fop.apps">FOPException</A></CODE> - if a problem occurs while creating the event handler</DL>
- </DD>
- </DL>
- <HR>
- <A NAME="needsOutputStream()"><!-- --></A><H3>
- needsOutputStream</H3>
- <PRE>
- public abstract boolean <B>needsOutputStream</B>()</PRE>
- <DL>
- <DD><DL>
- <DT><B>Returns:</B><DD>Indicates whether this renderer requires an OutputStream to work with.</DL>
- </DD>
- </DL>
- <HR>
- <A NAME="getSupportedMimeTypes()"><!-- --></A><H3>
- getSupportedMimeTypes</H3>
- <PRE>
- public abstract java.lang.String[] <B>getSupportedMimeTypes</B>()</PRE>
- <DL>
- <DD><DL>
- <DT><B>Returns:</B><DD>an array of MIME types the renderer supports.</DL>
- </DD>
- </DL>
- <HR>
- <A NAME="isMimeTypeSupported(java.lang.String)"><!-- --></A><H3>
- isMimeTypeSupported</H3>
- <PRE>
- public boolean <B>isMimeTypeSupported</B>(java.lang.String mimeType)</PRE>
- <DL>
- <DD>Indicates whether a specific MIME type is supported by this renderer.
- <P>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>mimeType</CODE> - the MIME type (ex. "application/rtf")
- <DT><B>Returns:</B><DD>true if the MIME type is supported</DL>
- </DD>
- </DL>
- <!-- ========= END OF CLASS DATA ========= -->
- <HR>
- <!-- ======= START OF BOTTOM NAVBAR ====== -->
- <A NAME="navbar_bottom"><!-- --></A>
- <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
- <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
- <TR>
- <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
- <A NAME="navbar_bottom_firstrow"><!-- --></A>
- <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
- <TR ALIGN="center" VALIGN="top">
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
- <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/AbstractFOEventHandlerMaker.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
- </TR>
- </TABLE>
- </TD>
- <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
- fop 1.0</EM>
- </TD>
- </TR>
- <TR>
- <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../../org/apache/fop/render/AbstractConfigurator.html" title="class in org.apache.fop.render"><B>PREV CLASS</B></A>
- <A HREF="../../../../org/apache/fop/render/AbstractGenericSVGHandler.html" title="class in org.apache.fop.render"><B>NEXT CLASS</B></A></FONT></TD>
- <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../../index.html" target="_top"><B>FRAMES</B></A>
- <A HREF="AbstractFOEventHandlerMaker.html" target="_top"><B>NO FRAMES</B></A>
- <SCRIPT type="text/javascript">
- <!--
- if(window==top) {
- document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
- }
- //-->
- </SCRIPT>
- <NOSCRIPT>
- <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
- </NOSCRIPT>
- </FONT></TD>
- </TR>
- <TR>
- <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
- SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
- <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
- DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
- </TR>
- </TABLE>
- <A NAME="skip-navbar_bottom"></A>
- <!-- ======== END OF BOTTOM NAVBAR ======= -->
- <HR>
- Copyright 1999-2010 The Apache Software Foundation. All Rights Reserved.
- </BODY>
- </HTML>