rtfctrlwordhandler.html

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

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Hidden default constructor.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;</CODE></FONT></TD>
<TD><CODE><B><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)">RtfCtrlWordHandler</A></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)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructor:</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== METHOD SUMMARY =========== -->

<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../com/lowagie/text/rtf/parser/ctrlwords/RtfCtrlWordHandler.html#afterControlWord()">afterControlWord</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Post-processing after the control word.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../com/lowagie/text/rtf/parser/ctrlwords/RtfCtrlWordHandler.html#beforeControlWord()">beforeControlWord</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Pre-processing before the control word.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../com/lowagie/text/rtf/parser/ctrlwords/RtfCtrlWordHandler.html#handleControlword(com.lowagie.text.rtf.parser.ctrlwords.RtfCtrlWordData)">handleControlword</A></B>(<A HREF="../../../../../../com/lowagie/text/rtf/parser/ctrlwords/RtfCtrlWordData.html" title="class in com.lowagie.text.rtf.parser.ctrlwords">RtfCtrlWordData</A>&nbsp;ctrlWordDataIn)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The primary control word handler method.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../com/lowagie/text/rtf/parser/ctrlwords/RtfCtrlWordHandler.html#onControlWord()">onControlWord</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Handle the control word.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private &nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../com/lowagie/text/rtf/parser/ctrlwords/RtfCtrlWordHandler.html#printDebug(java.lang.String)">printDebug</A></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)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Debug function to print class/method</TD>
</TR>
</TABLE>
&nbsp;<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">
<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>

<!-- ============ FIELD DETAIL =========== -->

<A NAME="field_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>Field Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="debug"><!-- --></A><H3>
debug</H3>
<PRE>
private static final boolean <B>debug</B></PRE>
<DL>
<DD>Debug flag - internal use
<P>
<DL>
<DT><B>Since:</B></DT>
  <DD>2.0.8</DD>
<DT><B>See Also:</B><DD><A HREF="../../../../../../constant-values.html#com.lowagie.text.rtf.parser.ctrlwords.RtfCtrlWordHandler.debug">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="rtfParser"><!-- --></A><H3>
rtfParser</H3>
<PRE>
protected <A HREF="../../../../../../com/lowagie/text/rtf/parser/RtfParser.html" title="class in com.lowagie.text.rtf.parser">RtfParser</A> <B>rtfParser</B></PRE>
<DL>
<DD>Local variable referencing the parser object.
<P>
<DL>
<DT><B>Since:</B></DT>
  <DD>2.0.8</DD>
</DL>
</DL>
<HR>

<A NAME="ctrlWord"><!-- --></A><H3>
ctrlWord</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>ctrlWord</B></PRE>
<DL>
<DD>The control word for this class.
<P>
<DL>
<DT><B>Since:</B></DT>
  <DD>2.0.8</DD>
</DL>
</DL>
<HR>

<A NAME="defaultParameterValue"><!-- --></A><H3>
defaultParameterValue</H3>
<PRE>
protected int <B>defaultParameterValue</B></PRE>
<DL>
<DD>The default value for this control word.
 Not all control words use a default parameter value.
<P>
<DL>
<DT><B>Since:</B></DT>
  <DD>2.0.8</DD>
</DL>
</DL>
<HR>

<A NAME="passDefaultParameterValue"><!-- --></A><H3>
passDefaultParameterValue</H3>
<PRE>
protected boolean <B>passDefaultParameterValue</B></PRE>
<DL>
<DD>Does this control word use the default value?
<P>
<DL>
<DT><B>Since:</B></DT>
  <DD>2.0.8</DD>
</DL>
</DL>
<HR>

<A NAME="ctrlWordType"><!-- --></A><H3>
ctrlWordType</H3>
<PRE>
protected int <B>ctrlWordType</B></PRE>
<DL>
<DD>Control Word type. Destination, toggle, value, etc.
<P>
<DL>
<DT><B>Since:</B></DT>
  <DD>2.0.8</DD>
</DL>
</DL>
<HR>

<A NAME="specialHandler"><!-- --></A><H3>
specialHandler</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>specialHandler</B></PRE>
<DL>
<DD>Class, property, etc.
<P>
<DL>
<DT><B>Since:</B></DT>
  <DD>2.0.8</DD>
</DL>
</DL>
<HR>

<A NAME="rtfVersionSupported"><!-- --></A><H3>
rtfVersionSupported</H3>
<PRE>
protected float <B>rtfVersionSupported</B></PRE>
<DL>
<DD>What version of the RTF spec the control word was introduced.
<P>
<DL>
<DT><B>Since:</B></DT>
  <DD>2.0.8</DD>
</DL>
</DL>
<HR>

<A NAME="ctrlWordData"><!-- --></A><H3>
ctrlWordData</H3>
<PRE>
protected <A HREF="../../../../../../com/lowagie/text/rtf/parser/ctrlwords/RtfCtrlWordData.html" title="class in com.lowagie.text.rtf.parser.ctrlwords">RtfCtrlWordData</A> <B>ctrlWordData</B></PRE>
<DL>
<DD>The control word as parsed by the parser.
<P>
<DL>
<DT><B>Since:</B></DT>
  <DD>2.0.8</DD>
</DL>
</DL>
<HR>

<A NAME="groupPrefix"><!-- --></A><H3>
groupPrefix</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>groupPrefix</B></PRE>
<DL>
<DD>String containing the value of "{" or "" (blank) depending on if this is the
 first control word in a group.
<P>
<DL>
<DT><B>Since:</B></DT>
  <DD>2.0.8</DD>
</DL>
</DL>
<HR>

<A NAME="ctrlWordPrefix"><!-- --></A><H3>
ctrlWordPrefix</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>ctrlWordPrefix</B></PRE>
<DL>
<DD>The prefix for all control words.