com.lowagie.text.rtf.parser.ctrlwords

Class RtfCtrlWordData

public class RtfCtrlWordData extends Object implements Cloneable

The control word and parameter information as parsed by the parser. Contains the control word, Flag indicating if there is a parameter. The parameter value as a string. Flag indicating the parameter is positive or negative.

Since: 2.0.8

Author: Howard Shank (hgshank@yahoo.com)

Field Summary
StringctrlWord
The control word found by the parser
intctrlWordType
booleanhasParam
Flag indicating if this keyword has a parameter.
booleanisNeg
Flag indicating if parameter is positive or negative.
booleanmodified
Flag indicating if this object has been modified.
booleannewGroup
Flag indicating a new group
Stringparam
The parameter for the control word.
Stringprefix
StringspecialHandler
Stringsuffix
Method Summary
Objectclone()
intintValue()
Return the parameter value as an integer (int) value.
longlongValue()
Return the parameter value as a long value
IntegertoInteger()
Return the parameter value as an Integer object.
LongtoLong()
Return the parameter value as a Long object
StringtoString()

Field Detail

ctrlWord

public String ctrlWord
The control word found by the parser

ctrlWordType

public int ctrlWordType

hasParam

public boolean hasParam
Flag indicating if this keyword has a parameter.

isNeg

public boolean isNeg
Flag indicating if parameter is positive or negative.

modified

public boolean modified
Flag indicating if this object has been modified.

newGroup

public boolean newGroup
Flag indicating a new group

param

public String param
The parameter for the control word.

prefix

public String prefix

specialHandler

public String specialHandler

suffix

public String suffix

Method Detail

clone

public Object clone()

intValue

public int intValue()
Return the parameter value as an integer (int) value.

Returns: Returns the parameter value as an int vlaue.

longValue

public long longValue()
Return the parameter value as a long value

Returns: Returns the parameter value as a long value

toInteger

public Integer toInteger()
Return the parameter value as an Integer object.

Returns: Returns the parameter value as an Integer object.

toLong

public Long toLong()
Return the parameter value as a Long object

Returns: Returns the parameter value as a Long object.

toString

public String toString()