com.lowagie.text.rtf.parser.ctrlwords
public class RtfCtrlWordHandler extends java.lang.Object implements java.lang.Cloneable
RtfCtrlWordBase
is the base class for all
control word handlers to extend from.Modifier and Type | Field and Description |
---|---|
protected java.lang.String |
ctrlWord
The control word for this class.
|
protected RtfCtrlWordData |
ctrlWordData
The control word as parsed by the parser.
|
protected java.lang.String |
ctrlWordPrefix
The prefix for all control words.
|
protected java.lang.String |
ctrlWordSuffix
The prefix for all control words.
|
protected int |
ctrlWordType
Control Word type.
|
private static boolean |
debug
Debug flag - internal use
|
protected int |
defaultParameterValue
The default value for this control word.
|
protected java.lang.String |
groupPrefix
String containing the value of "{" or "" (blank) depending on if this is the
first control word in a group.
|
protected boolean |
passDefaultParameterValue
Does this control word use the default value?
|
protected RtfParser |
rtfParser
Local variable referencing the parser object.
|
protected float |
rtfVersionSupported
What version of the RTF spec the control word was introduced.
|
protected java.lang.String |
specialHandler
Class, property, etc.
|
Modifier | Constructor and Description |
---|---|
private |
RtfCtrlWordHandler()
Hidden default constructor.
|
|
RtfCtrlWordHandler(RtfParser rtfParser,
java.lang.String ctrlWord,
int defaultParameterValue,
boolean passDefaultParameterValue,
int ctrlWordType,
java.lang.String prefix,
java.lang.String suffix,
java.lang.String specialHandler)
Constructor:
|
Modifier and Type | Method and Description |
---|---|
protected boolean |
afterControlWord()
Post-processing after the control word.
|
protected boolean |
beforeControlWord()
Pre-processing before the control word.
|
boolean |
handleControlword(RtfCtrlWordData ctrlWordDataIn)
The primary control word handler method.
|
protected boolean |
onControlWord()
Handle the control word.
|
private void |
printDebug(java.lang.String txt)
Debug function to print class/method
|
private static final boolean debug
protected RtfParser rtfParser
protected java.lang.String ctrlWord
protected int defaultParameterValue
protected boolean passDefaultParameterValue
protected int ctrlWordType
protected java.lang.String specialHandler
protected float rtfVersionSupported
protected RtfCtrlWordData ctrlWordData
protected java.lang.String groupPrefix
protected java.lang.String ctrlWordPrefix
protected java.lang.String ctrlWordSuffix
private RtfCtrlWordHandler()
public RtfCtrlWordHandler(RtfParser rtfParser, java.lang.String ctrlWord, int defaultParameterValue, boolean passDefaultParameterValue, int ctrlWordType, java.lang.String prefix, java.lang.String suffix, java.lang.String specialHandler)
rtfParser
- The parser for this control word.ctrlWord
- The string value of this control word.defaultParameterValue
- The default value of this control word. Not all control words have values.passDefaultParameterValue
- Flag indicating if this control word should use the default value.ctrlWordType
- Indicator of the type of control word this is. DESTINATION|DESTINATION_EX|VALUE|FLAG|TOGGLE|SYMBOLprefix
- String to prefix the ctrl word with. "\" or "\*\" are the 2 used values.suffix
- String to add as suffix to the ctrl word. " " and "" are the 2 used values.specialHandler
- 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 Stringpublic final boolean handleControlword(RtfCtrlWordData ctrlWordDataIn)
ctrlWordDataIn
- The control word and associated parameter if applicable.true
or false
if the control word was handled.protected boolean beforeControlWord()
false
= stop processing, true
= continue processingprotected boolean onControlWord()
true
if control word was handled, false
if it was not handled.protected boolean afterControlWord()
false
= stop processing, true
= continue processingprivate final void printDebug(java.lang.String txt)
txt
- The String
to output.