rtfctrlwordhandler.html

IText PDF开发工具说明文档,使用很方便。

<P>
<DL>
<DT><B>Since:</B></DT>
  <DD>2.0.8</DD>
</DL>
</DL>
<HR>

<A NAME="ctrlWordSuffix"><!-- --></A><H3>
ctrlWordSuffix</H3>
<PRE>
protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>ctrlWordSuffix</B></PRE>
<DL>
<DD>The prefix for all control words.
<P>
<DL>
<DT><B>Since:</B></DT>
  <DD>2.0.8</DD>
</DL>
</DL>

<!-- ========= CONSTRUCTOR DETAIL ======== -->

<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="RtfCtrlWordHandler()"><!-- --></A><H3>
RtfCtrlWordHandler</H3>
<PRE>
private <B>RtfCtrlWordHandler</B>()</PRE>
<DL>
<DD>Hidden default constructor. Must use constructor with parameters.
<P>
<DL>
<DT><B>Since:</B></DT>
  <DD>2.0.8</DD>
<DT><B>See Also:</B><DD><A HREF="../../../../../../com/lowagie/text/rtf/parser/ctrlwords/RtfCtrlWordHandler.html#RtfCtrlWordHandler(com.lowagie.text.rtf.parser.RtfParser, java.lang.String, int, boolean, int, java.lang.String, java.lang.String, java.lang.String)"><CODE>RtfCtrlWordHandler(RtfParser rtfParser, String ctrlWord, int defaultParameterValue, boolean passDefaultParameterValue, int ctrlWordType, String prefix, String suffix, String specialHandler)</CODE></A></DL>
</DL>
<HR>

<A NAME="RtfCtrlWordHandler(com.lowagie.text.rtf.parser.RtfParser, java.lang.String, int, boolean, int, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
RtfCtrlWordHandler</H3>
<PRE>
public <B>RtfCtrlWordHandler</B>(<A HREF="../../../../../../com/lowagie/text/rtf/parser/RtfParser.html" title="class in com.lowagie.text.rtf.parser">RtfParser</A>&nbsp;rtfParser,
                          <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;ctrlWord,
                          int&nbsp;defaultParameterValue,
                          boolean&nbsp;passDefaultParameterValue,
                          int&nbsp;ctrlWordType,
                          <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;prefix,
                          <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;suffix,
                          <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;specialHandler)</PRE>
<DL>
<DD>Constructor:
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>rtfParser</CODE> - The parser for this control word.<DD><CODE>ctrlWord</CODE> - The string value of this control word.<DD><CODE>defaultParameterValue</CODE> - The default value of this control word. Not all control words have values.<DD><CODE>passDefaultParameterValue</CODE> - Flag indicating if this control word should use the default value.<DD><CODE>ctrlWordType</CODE> - Indicator of the type of control word this is. DESTINATION|DESTINATION_EX|VALUE|FLAG|TOGGLE|SYMBOL<DD><CODE>prefix</CODE> - String to prefix the ctrl word with. "\" or "\*\" are the 2 used values.<DD><CODE>suffix</CODE> - String to add as suffix to the ctrl word. " " and "" are the 2 used values.<DD><CODE>specialHandler</CODE> - If TOGGLE then the property name as String (propertyGroup.propertyName format ex. "character.bold")
                If FLAG then the property name as String (propertyGroup.propertyName format ex. "character.bold")
                If VALUE then the property name as String (propertyGroup.propertyName format ex. "character.bold")
                If SYMBOL then the character to use for substitution as String
                If DESTINATION|DESTINATION_EX then the RtfDestination class name as String<DT><B>Since:</B></DT>
  <DD>2.0.8</DD>
</DL>
</DL>

<!-- ============ METHOD DETAIL ========== -->

<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="handleControlword(com.lowagie.text.rtf.parser.ctrlwords.RtfCtrlWordData)"><!-- --></A><H3>
handleControlword</H3>
<PRE>
public final boolean <B>handleControlword</B>(<A HREF="../../../../../../com/lowagie/text/rtf/parser/ctrlwords/RtfCtrlWordData.html" title="class in com.lowagie.text.rtf.parser.ctrlwords">RtfCtrlWordData</A>&nbsp;ctrlWordDataIn)</PRE>
<DL>
<DD>The primary control word handler method.
 Called by the parser once it has a control word and parameter if applicable.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>ctrlWordDataIn</CODE> - The control word and associated parameter if applicable.
<DT><B>Returns:</B><DD><code>true</code> or <code>false</code> if the control word was handled.<DT><B>Since:</B></DT>
  <DD>2.0.8</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="beforeControlWord()"><!-- --></A><H3>
beforeControlWord</H3>
<PRE>
protected boolean <B>beforeControlWord</B>()</PRE>
<DL>
<DD>Pre-processing before the control word.
 
 If return value is true, no further processing will be performed on
 this control word.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD><code>false</code> = stop processing, <code>true</code> = continue processing<DT><B>Since:</B></DT>
  <DD>2.0.8</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="onControlWord()"><!-- --></A><H3>
onControlWord</H3>
<PRE>
protected boolean <B>onControlWord</B>()</PRE>
<DL>
<DD>Handle the control word.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD><code>true</code> if control word was handled, <code>false</code> if it was not handled.<DT><B>Since:</B></DT>
  <DD>2.0.8</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="afterControlWord()"><!-- --></A><H3>
afterControlWord</H3>
<PRE>
protected boolean <B>afterControlWord</B>()</PRE>
<DL>
<DD>Post-processing after the control word.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD><code>false</code> = stop processing, <code>true</code> = continue processing<DT><B>Since:</B></DT>
  <DD>2.0.8</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="printDebug(java.lang.String)"><!-- --></A><H3>
printDebug</H3>
<PRE>
private final void <B>printDebug</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;txt)</PRE>
<DL>
<DD>Debug function to print class/method
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>txt</CODE> - The <code>String</code> to output.<DT><B>Since:</B></DT>
  <DD>2.0.8</DD>
</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=2 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>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Hosted by <a href="http://www.hostbasket.com/">Hostbasket</a></EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../../com/lowagie/text/rtf/parser/ctrlwords/RtfCtrlWordData.html" title="class in com.lowagie.text.rtf.parser.ctrlwords"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../../com/lowagie/text/rtf/parser/ctrlwords/RtfCtrlWordListener.html" title="interface in com.lowagie.text.rtf.parser.ctrlwords"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../../../index.html?com/lowagie/text/rtf/parser/ctrlwords/RtfCtrlWordHandler.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="RtfCtrlWordHandler.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<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:&nbsp;NESTED&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" CLASS="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>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->

<HR>

</BODY>
</HTML>