Class RtfCtrlWordHandler
java.lang.Object
com.lowagie.text.rtf.parser.ctrlwords.RtfCtrlWordHandler
- All Implemented Interfaces:
Cloneable
RtfCtrlWordBase
is the base class for all
control word handlers to extend from.- Since:
- 2.0.8
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected String
The control word for this class.protected RtfCtrlWordData
The control word as parsed by the parser.protected String
The prefix for all control words.protected String
The prefix for all control words.protected int
Control Word type.private static final boolean
Debug flag - internal useprotected int
The default value for this control word.protected String
String containing the value of "{" or "" (blank) depending on if this is the first control word in a group.protected boolean
Does this control word use the default value?protected RtfParser
Local variable referencing the parser object.protected float
What version of the RTF spec the control word was introduced.protected String
Class, property, etc. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected boolean
Post-processing after the control word.protected boolean
Pre-processing before the control word.final boolean
handleControlword
(RtfCtrlWordData ctrlWordDataIn) The primary control word handler method.protected boolean
Handle the control word.private void
printDebug
(String txt) Debug function to print class/method
-
Field Details
-
debug
private static final boolean debugDebug flag - internal use- Since:
- 2.0.8
- See Also:
-
rtfParser
Local variable referencing the parser object.- Since:
- 2.0.8
-
ctrlWord
The control word for this class.- Since:
- 2.0.8
-
defaultParameterValue
protected int defaultParameterValueThe default value for this control word. Not all control words use a default parameter value.- Since:
- 2.0.8
-
passDefaultParameterValue
protected boolean passDefaultParameterValueDoes this control word use the default value?- Since:
- 2.0.8
-
ctrlWordType
protected int ctrlWordTypeControl Word type. Destination, toggle, value, etc.- Since:
- 2.0.8
-
specialHandler
Class, property, etc.- Since:
- 2.0.8
-
rtfVersionSupported
protected float rtfVersionSupportedWhat version of the RTF spec the control word was introduced.- Since:
- 2.0.8
-
ctrlWordData
The control word as parsed by the parser.- Since:
- 2.0.8
-
groupPrefix
String containing the value of "{" or "" (blank) depending on if this is the first control word in a group.- Since:
- 2.0.8
-
ctrlWordPrefix
The prefix for all control words.- Since:
- 2.0.8
-
ctrlWordSuffix
The prefix for all control words.- Since:
- 2.0.8
-
-
Constructor Details
-
RtfCtrlWordHandler
private RtfCtrlWordHandler()Hidden default constructor. Must use constructor with parameters.- Since:
- 2.0.8
- See Also:
-
RtfCtrlWordHandler
public RtfCtrlWordHandler(RtfParser rtfParser, String ctrlWord, int defaultParameterValue, boolean passDefaultParameterValue, int ctrlWordType, String prefix, String suffix, String specialHandler) Constructor:- Parameters:
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 String- Since:
- 2.0.8
-
-
Method Details
-
handleControlword
The primary control word handler method. Called by the parser once it has a control word and parameter if applicable.- Parameters:
ctrlWordDataIn
- The control word and associated parameter if applicable.- Returns:
true
orfalse
if the control word was handled.- Since:
- 2.0.8
-
beforeControlWord
protected boolean beforeControlWord()Pre-processing before the control word. If return value is true, no further processing will be performed on this control word.- Returns:
false
= stop processing,true
= continue processing- Since:
- 2.0.8
-
onControlWord
protected boolean onControlWord()Handle the control word.- Returns:
true
if control word was handled,false
if it was not handled.- Since:
- 2.0.8
-
afterControlWord
protected boolean afterControlWord()Post-processing after the control word.- Returns:
false
= stop processing,true
= continue processing- Since:
- 2.0.8
-
printDebug
Debug function to print class/method- Parameters:
txt
- TheString
to output.- Since:
- 2.0.8
-