Package com.lowagie.text.rtf.list
Class RtfListLevel
java.lang.Object
com.lowagie.text.rtf.RtfElement
com.lowagie.text.rtf.list.RtfListLevel
- All Implemented Interfaces:
RtfBasicElement
,RtfExtendedElement
,com.lowagie.text.RtfElementInterface
The RtfListLevel is a listlevel object in a list.
- Since:
- 2.1.3
- Version:
- $Id: RtfListLevel.java 3580 2008-08-06 15:52:00Z howard_s $
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate int
The alignment of this RtfListprivate String
The text to use as the bullet characterprivate com.lowagie.text.Chunk
private int
The first indentation of this RtfListprivate RtfFont
The RtfFont for bulleted listsprivate RtfFont
The RtfFont for numbered listsprivate boolean
Flag to indicate if the levellegal control word should be emitted.private boolean
Flag to indicate if the tentative control word should be emitted.private int
The left indentation of this RtfListprivate int
private int
Which picture bullet from the \listpicture destination should be appliedprivate int
private static final byte[]
Constant for list levelprivate static final byte[]
Constant for list level alignment oldprivate static final byte[]
Constant for list level alignment newprivate static final byte[]
Constant for the first indentationstatic final int
static final int
static final int
private static final byte[]
Constant which specifies which character follows the level textprivate static final byte[]
Constant which specifies the levelindent control wordprivate static final byte[]
Constant which specifies (1) if list numbers from previous levels should be converted to Arabic numbers; (0) if they should be left with the format specified by their own level's definition.private static final byte[]
Constant which specifies (1) if this level does/does not restart its count each time a super ordinate level is incremented (0) if this level does not restart its count each time a super ordinate level is incremented.private static final byte[]
Constant for the beginning of the list level numbersprivate static final byte[]
Constant for the end of the list level numbersprivate static final byte[]
Constant for the list level numbersprivate static final byte[]
Constant for the levelpictureN control wordprivate static final byte[]
Constant which specifies the levelspace controlwordprivate static final byte[]
Constant for list level start atprivate static final byte[]
Constant for the beginning of the list level bulleted styleprivate static final byte[]
Constant for the end of the list level bulleted styleprivate static final byte[]
Constant for the beginning of the list level numbered styleprivate static final byte[]
Constant for the end of the list level numbered styleprivate static final byte[]
Constant for the symbol indentationprivate static final byte[]
Constant for list levelprivate static final byte[]
Constant for the lvltentative control wordprivate static final byte[]
Constant for list level textprivate static final byte[]
Constant for list level style oldprivate static final byte[]
Constant for list level style newstatic final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
private int
The level of this RtfListLevelprivate RtfListLevel
private int
Does the list restart numbering each time a super ordinate level is incrementedprivate int
The number to start counting atprivate int
Whether this RtfList is numberedprivate RtfList
Parent list objectprivate int
The right indentation of this RtfListprivate int
The symbol indentation of this RtfListprivate final int
Fields inherited from class com.lowagie.text.rtf.RtfElement
document, inHeader, inTable
Fields inherited from interface com.lowagie.text.rtf.RtfBasicElement
CLOSE_GROUP, COMMA_DELIMITER, DELIMITER, OPEN_GROUP, TWIPS_FACTOR
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected void
Correct the indentation of this levelint
int
int
int
int
int
Gets the list level of this RtfListint
int
int
int
int
boolean
isLegal()
boolean
void
setAlignment
(int alignment) void
setBulletCharacter
(String bulletCharacter) void
setBulletChunk
(com.lowagie.text.Chunk bulletCharacter) void
setBulletFont
(com.lowagie.text.Font f) set the bullet fontvoid
setFirstIndent
(int firstIndent) void
setFontBullet
(RtfFont fontBullet) void
setFontNumber
(RtfFont fontNumber) void
setLeftIndent
(int leftIndent) void
setLegal
(boolean isLegal) void
setLevelFollowValue
(int levelFollowValue) void
setLevelTextNumber
(int levelTextNumber) void
setListLevel
(int listLevel) Sets the list level of this RtfList.void
setListLevelParent
(RtfListLevel listLevelParent) void
setListNoRestart
(int listNoRestart) void
setListStartAt
(int listStartAt) void
setListType
(int listType) void
void
setRightIndent
(int rightIndent) void
setSymbolIndent
(int symbolIndent) void
setTentative
(boolean isTentative) void
writeContent
(OutputStream result) unusedvoid
writeDefinition
(OutputStream result) Write the definition part of the elementvoid
writeIndentation
(OutputStream result) Write the indentation values for thisRtfList
.void
writeListBeginning
(OutputStream result) Writes the initialization part of the RtfListprotected void
writeListNumbers
(OutputStream result) Writes only the list number and list level number.Methods inherited from class com.lowagie.text.rtf.RtfElement
intToByteArray, isInTable, setInHeader, setInTable, setRtfDocument
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.lowagie.text.rtf.RtfBasicElement
setInHeader, setInTable, setRtfDocument
-
Field Details
-
LIST_LEVEL
private static final byte[] LIST_LEVELConstant for list level -
LIST_LEVEL_TEMPLATE_ID
private static final byte[] LIST_LEVEL_TEMPLATE_IDConstant for list level -
LIST_LEVEL_TYPE
private static final byte[] LIST_LEVEL_TYPEConstant for list level style old -
LIST_LEVEL_TYPE_NEW
private static final byte[] LIST_LEVEL_TYPE_NEWConstant for list level style new -
LIST_LEVEL_ALIGNMENT
private static final byte[] LIST_LEVEL_ALIGNMENTConstant for list level alignment old -
LIST_LEVEL_ALIGNMENT_NEW
private static final byte[] LIST_LEVEL_ALIGNMENT_NEWConstant for list level alignment new -
LIST_LEVEL_START_AT
private static final byte[] LIST_LEVEL_START_ATConstant for list level start at -
LIST_LEVEL_TEXT
private static final byte[] LIST_LEVEL_TEXTConstant for list level text -
LIST_LEVEL_STYLE_NUMBERED_BEGIN
private static final byte[] LIST_LEVEL_STYLE_NUMBERED_BEGINConstant for the beginning of the list level numbered style -
LIST_LEVEL_STYLE_NUMBERED_END
private static final byte[] LIST_LEVEL_STYLE_NUMBERED_ENDConstant for the end of the list level numbered style -
LIST_LEVEL_STYLE_BULLETED_BEGIN
private static final byte[] LIST_LEVEL_STYLE_BULLETED_BEGINConstant for the beginning of the list level bulleted style -
LIST_LEVEL_STYLE_BULLETED_END
private static final byte[] LIST_LEVEL_STYLE_BULLETED_ENDConstant for the end of the list level bulleted style -
LIST_LEVEL_NUMBERS_BEGIN
private static final byte[] LIST_LEVEL_NUMBERS_BEGINConstant for the beginning of the list level numbers -
LIST_LEVEL_FOLOW
private static final byte[] LIST_LEVEL_FOLOWConstant which specifies which character follows the level text -
LIST_LEVEL_SPACE
private static final byte[] LIST_LEVEL_SPACEConstant which specifies the levelspace controlword -
LIST_LEVEL_INDENT
private static final byte[] LIST_LEVEL_INDENTConstant which specifies the levelindent control word -
LIST_LEVEL_LEGAL
private static final byte[] LIST_LEVEL_LEGALConstant which specifies (1) if list numbers from previous levels should be converted to Arabic numbers; (0) if they should be left with the format specified by their own level's definition. -
LIST_LEVEL_NO_RESTART
private static final byte[] LIST_LEVEL_NO_RESTARTConstant which specifies (1) if this level does/does not restart its count each time a super ordinate level is incremented (0) if this level does not restart its count each time a super ordinate level is incremented. -
LIST_LEVEL_NUMBERS_NUMBERED
private static final byte[] LIST_LEVEL_NUMBERS_NUMBEREDConstant for the list level numbers -
LIST_LEVEL_NUMBERS_END
private static final byte[] LIST_LEVEL_NUMBERS_ENDConstant for the end of the list level numbers -
LIST_LEVEL_FIRST_INDENT
private static final byte[] LIST_LEVEL_FIRST_INDENTConstant for the first indentation -
LIST_LEVEL_SYMBOL_INDENT
private static final byte[] LIST_LEVEL_SYMBOL_INDENTConstant for the symbol indentation -
LIST_LEVEL_TENTATIVE
private static final byte[] LIST_LEVEL_TENTATIVEConstant for the lvltentative control word -
LIST_LEVEL_PICTURE
private static final byte[] LIST_LEVEL_PICTUREConstant for the levelpictureN control word -
LIST_TYPE_NUMBERED
public static final int LIST_TYPE_NUMBERED- See Also:
-
LIST_TYPE_UPPER_LETTERS
public static final int LIST_TYPE_UPPER_LETTERS- See Also:
-
LIST_TYPE_LOWER_LETTERS
public static final int LIST_TYPE_LOWER_LETTERS- See Also:
-
LIST_TYPE_UPPER_ROMAN
public static final int LIST_TYPE_UPPER_ROMAN- See Also:
-
LIST_TYPE_LOWER_ROMAN
public static final int LIST_TYPE_LOWER_ROMAN- See Also:
-
LIST_TYPE_UNKNOWN
public static final int LIST_TYPE_UNKNOWN- See Also:
-
LIST_TYPE_BASE
public static final int LIST_TYPE_BASE- See Also:
-
LIST_TYPE_ARABIC
public static final int LIST_TYPE_ARABIC- See Also:
-
LIST_TYPE_UPPERCASE_ROMAN_NUMERAL
public static final int LIST_TYPE_UPPERCASE_ROMAN_NUMERAL- See Also:
-
LIST_TYPE_LOWERCASE_ROMAN_NUMERAL
public static final int LIST_TYPE_LOWERCASE_ROMAN_NUMERAL- See Also:
-
LIST_TYPE_UPPERCASE_LETTER
public static final int LIST_TYPE_UPPERCASE_LETTER- See Also:
-
LIST_TYPE_LOWERCASE_LETTER
public static final int LIST_TYPE_LOWERCASE_LETTER- See Also:
-
LIST_TYPE_ORDINAL_NUMBER
public static final int LIST_TYPE_ORDINAL_NUMBER- See Also:
-
LIST_TYPE_CARDINAL_TEXT_NUMBER
public static final int LIST_TYPE_CARDINAL_TEXT_NUMBER- See Also:
-
LIST_TYPE_ORDINAL_TEXT_NUMBER
public static final int LIST_TYPE_ORDINAL_TEXT_NUMBER- See Also:
-
LIST_TYPE_ARABIC_LEADING_ZERO
public static final int LIST_TYPE_ARABIC_LEADING_ZERO- See Also:
-
LIST_TYPE_BULLET
public static final int LIST_TYPE_BULLET- See Also:
-
LIST_TYPE_NO_NUMBER
public static final int LIST_TYPE_NO_NUMBER- See Also:
-
listType
private int listTypeWhether this RtfList is numbered -
bulletCharacter
The text to use as the bullet character -
bulletChunk
private com.lowagie.text.Chunk bulletChunk- Since:
- 2.1.4
-
listStartAt
private int listStartAtThe number to start counting at -
listLevel
private int listLevelThe level of this RtfListLevel -
firstIndent
private int firstIndentThe first indentation of this RtfList -
leftIndent
private int leftIndentThe left indentation of this RtfList -
rightIndent
private int rightIndentThe right indentation of this RtfList -
symbolIndent
private int symbolIndentThe symbol indentation of this RtfList -
isTentative
private boolean isTentativeFlag to indicate if the tentative control word should be emitted. -
isLegal
private boolean isLegalFlag to indicate if the levellegal control word should be emitted. true if any list numbers from previous levels should be converted to Arabic numbers; false if they should be left with the format specified by their own level definition. -
listNoRestart
private int listNoRestartDoes the list restart numbering each time a super ordinate level is incremented -
LIST_LEVEL_FOLLOW_TAB
public static final int LIST_LEVEL_FOLLOW_TAB- See Also:
-
LIST_LEVEL_FOLLOW_SPACE
public static final int LIST_LEVEL_FOLLOW_SPACE- See Also:
-
LIST_LEVEL_FOLLOW_NOTHING
public static final int LIST_LEVEL_FOLLOW_NOTHING- See Also:
-
levelFollowValue
private int levelFollowValue -
alignment
private int alignmentThe alignment of this RtfList -
levelPicture
private int levelPictureWhich picture bullet from the \listpicture destination should be applied -
levelTextNumber
private int levelTextNumber -
fontNumber
The RtfFont for numbered lists -
fontBullet
The RtfFont for bulleted lists -
templateID
private final int templateID -
listLevelParent
-
parent
Parent list object
-
-
Constructor Details
-
RtfListLevel
-
RtfListLevel
-
RtfListLevel
-
-
Method Details
-
getListNoRestart
public int getListNoRestart()- Returns:
- the listNoRestart
-
setListNoRestart
public void setListNoRestart(int listNoRestart) - Parameters:
listNoRestart
- the listNoRestart to set
-
getAlignment
public int getAlignment()- Returns:
- the alignment
-
setAlignment
public void setAlignment(int alignment) - Parameters:
alignment
- the alignment to set
-
writeDefinition
Description copied from interface:RtfExtendedElement
Write the definition part of the element- Specified by:
writeDefinition
in interfaceRtfExtendedElement
- Parameters:
result
- TheOutputStream
to write the element definition to- Throws:
IOException
-
writeContent
unused- Specified by:
writeContent
in interfaceRtfBasicElement
- Specified by:
writeContent
in classRtfElement
- Parameters:
result
- TheOutputStream
to write the content to- Throws:
IOException
-
writeListNumbers
Writes only the list number and list level number.- Parameters:
result
- TheOutputStream
to write to- Throws:
IOException
- On i/o errors.
-
writeIndentation
Write the indentation values for thisRtfList
.- Parameters:
result
- TheOutputStream
to write to.- Throws:
IOException
- On i/o errors.
-
writeListBeginning
Writes the initialization part of the RtfList- Parameters:
result
- TheOutputStream
to write to- Throws:
IOException
- On i/o errors.
-
correctIndentation
protected void correctIndentation()Correct the indentation of this level -
getListLevel
public int getListLevel()Gets the list level of this RtfList- Returns:
- Returns the list level.
-
setListLevel
public void setListLevel(int listLevel) Sets the list level of this RtfList.- Parameters:
listLevel
- The list level to set.
-
getBulletCharacter
-
getListStartAt
public int getListStartAt()- Returns:
- the listStartAt
-
setListStartAt
public void setListStartAt(int listStartAt) - Parameters:
listStartAt
- the listStartAt to set
-
getFirstIndent
public int getFirstIndent()- Returns:
- the firstIndent
-
setFirstIndent
public void setFirstIndent(int firstIndent) - Parameters:
firstIndent
- the firstIndent to set
-
getLeftIndent
public int getLeftIndent()- Returns:
- the leftIndent
-
setLeftIndent
public void setLeftIndent(int leftIndent) - Parameters:
leftIndent
- the leftIndent to set
-
getRightIndent
public int getRightIndent()- Returns:
- the rightIndent
-
setRightIndent
public void setRightIndent(int rightIndent) - Parameters:
rightIndent
- the rightIndent to set
-
getSymbolIndent
public int getSymbolIndent()- Returns:
- the symbolIndent
-
setSymbolIndent
public void setSymbolIndent(int symbolIndent) - Parameters:
symbolIndent
- the symbolIndent to set
-
getParent
- Returns:
- the parent
-
setParent
- Parameters:
parent
- the parent to set
-
setBulletCharacter
- Parameters:
bulletCharacter
- the bulletCharacter to set
-
setBulletChunk
public void setBulletChunk(com.lowagie.text.Chunk bulletCharacter) - Parameters:
bulletCharacter
-- Since:
- 2.1.4
-
getListType
public int getListType()- Returns:
- the listType
-
setListType
public void setListType(int listType) - Parameters:
listType
- the listType to set
-
setBulletFont
public void setBulletFont(com.lowagie.text.Font f) set the bullet font- Parameters:
f
-
-
getFontNumber
- Returns:
- the fontNumber
-
setFontNumber
- Parameters:
fontNumber
- the fontNumber to set
-
getFontBullet
- Returns:
- the fontBullet
-
setFontBullet
- Parameters:
fontBullet
- the fontBullet to set
-
isTentative
public boolean isTentative()- Returns:
- the isTentative
-
setTentative
public void setTentative(boolean isTentative) - Parameters:
isTentative
- the isTentative to set
-
isLegal
public boolean isLegal()- Returns:
- the isLegal
-
setLegal
public void setLegal(boolean isLegal) - Parameters:
isLegal
- the isLegal to set
-
getLevelFollowValue
public int getLevelFollowValue()- Returns:
- the levelFollowValue
-
setLevelFollowValue
public void setLevelFollowValue(int levelFollowValue) - Parameters:
levelFollowValue
- the levelFollowValue to set
-
getLevelTextNumber
public int getLevelTextNumber()- Returns:
- the levelTextNumber
-
setLevelTextNumber
public void setLevelTextNumber(int levelTextNumber) - Parameters:
levelTextNumber
- the levelTextNumber to set
-
getListLevelParent
- Returns:
- the listLevelParent
-
setListLevelParent
- Parameters:
listLevelParent
- the listLevelParent to set
-