com.lowagie.text.rtf.list

Class RtfListLevel

public class RtfListLevel extends RtfElement implements RtfExtendedElement

The RtfListLevel is a listlevel object in a list.

Since: 2.1.3

Version: $Id:$

Author: Howard Shank (hgshank@yahoo.com)

Field Summary
intalignment
The alignment of this RtfList
StringbulletCharacter
The text to use as the bullet character
intfirstIndent
The first indentation of this RtfList
RtfFontfontBullet
The RtfFont for bulleted lists
RtfFontfontNumber
The RtfFont for numbered lists
booleanisLegal
Flag 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.
booleanisTentative
Flag to indicate if the tentative control word should be emitted.
intleftIndent
The left indentation of this RtfList
intlevelFollowValue
intlevelPicture
Which picture bullet from the \listpicture destination should be applied
intlevelTextNumber
intlistLevel
The level of this RtfListLevel
RtfListLevellistLevelParent
intlistNoRestart
Does the list restart numbering each time a super ordinate level is incremented
intlistStartAt
The number to start counting at
intlistType
Whether this RtfList is numbered
static byte[]LIST_LEVEL
Constant for list level
static byte[]LIST_LEVEL_ALIGNMENT
Constant for list level alignment old
static byte[]LIST_LEVEL_ALIGNMENT_NEW
Constant for list level alignment new
static byte[]LIST_LEVEL_FIRST_INDENT
Constant for the first indentation
static intLIST_LEVEL_FOLLOW_NOTHING
static intLIST_LEVEL_FOLLOW_SPACE
static intLIST_LEVEL_FOLLOW_TAB
static byte[]LIST_LEVEL_FOLOW
Constant which specifies which character follows the level text
static byte[]LIST_LEVEL_INDENT
Constant which specifies the levelindent control word
static byte[]LIST_LEVEL_LEGAL
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.
static byte[]LIST_LEVEL_NO_RESTART
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.
static byte[]LIST_LEVEL_NUMBERS_BEGIN
Constant for the beginning of the list level numbers
static byte[]LIST_LEVEL_NUMBERS_END
Constant for the end of the list level numbers
static byte[]LIST_LEVEL_NUMBERS_NUMBERED
Constant for the list level numbers
static byte[]LIST_LEVEL_PICTURE
Constant for the levelpictureN control word
static byte[]LIST_LEVEL_SPACE
Constant which specifies the levelspace controlword
static byte[]LIST_LEVEL_START_AT
Constant for list level start at
static byte[]LIST_LEVEL_STYLE_BULLETED_BEGIN
Constant for the beginning of the list level bulleted style
static byte[]LIST_LEVEL_STYLE_BULLETED_END
Constant for the end of the list level bulleted style
static byte[]LIST_LEVEL_STYLE_NUMBERED_BEGIN
Constant for the beginning of the list level numbered style
static byte[]LIST_LEVEL_STYLE_NUMBERED_END
Constant for the end of the list level numbered style
static byte[]LIST_LEVEL_SYMBOL_INDENT
Constant for the symbol indentation
static byte[]LIST_LEVEL_TEMPLATE_ID
Constant for list level
static byte[]LIST_LEVEL_TENTATIVE
Constant for the lvltentative control word
static byte[]LIST_LEVEL_TEXT
Constant for list level text
static byte[]LIST_LEVEL_TYPE
Constant for list level style old
static byte[]LIST_LEVEL_TYPE_NEW
Constant for list level style new
static intLIST_TYPE_ARABIC
static intLIST_TYPE_ARABIC_LEADING_ZERO
static intLIST_TYPE_BASE
static intLIST_TYPE_BULLET
static intLIST_TYPE_CARDINAL_TEXT_NUMBER
static intLIST_TYPE_LOWERCASE_LETTER
static intLIST_TYPE_LOWERCASE_ROMAN_NUMERAL
static intLIST_TYPE_LOWER_LETTERS
static intLIST_TYPE_LOWER_ROMAN
static intLIST_TYPE_NO_NUMBER
static intLIST_TYPE_NUMBERED
static intLIST_TYPE_ORDINAL_NUMBER
static intLIST_TYPE_ORDINAL_TEXT_NUMBER
static intLIST_TYPE_UNKNOWN
static intLIST_TYPE_UPPERCASE_LETTER
static intLIST_TYPE_UPPERCASE_ROMAN_NUMERAL
static intLIST_TYPE_UPPER_LETTERS
static intLIST_TYPE_UPPER_ROMAN
RtfListparent
Parent list object
intrightIndent
The right indentation of this RtfList
intsymbolIndent
The symbol indentation of this RtfList
inttemplateID
Constructor Summary
RtfListLevel(RtfDocument doc)
RtfListLevel(RtfDocument doc, RtfList parent)
RtfListLevel(RtfListLevel ll)
Method Summary
protected voidcorrectIndentation()
Correct the indentation of this level
intgetAlignment()
StringgetBulletCharacter()
intgetFirstIndent()
RtfFontgetFontBullet()
RtfFontgetFontNumber()
intgetLeftIndent()
intgetLevelFollowValue()
intgetLevelTextNumber()
intgetListLevel()
Gets the list level of this RtfList
RtfListLevelgetListLevelParent()
intgetListNoRestart()
intgetListStartAt()
intgetListType()
RtfListgetParent()
intgetRightIndent()
intgetSymbolIndent()
booleanisLegal()
booleanisTentative()
voidsetAlignment(int alignment)
voidsetBulletCharacter(String bulletCharacter)
voidsetBulletFont(Font f)
set the bullet font
voidsetFirstIndent(int firstIndent)
voidsetFontBullet(RtfFont fontBullet)
voidsetFontNumber(RtfFont fontNumber)
voidsetLeftIndent(int leftIndent)
voidsetLegal(boolean isLegal)
voidsetLevelFollowValue(int levelFollowValue)
voidsetLevelTextNumber(int levelTextNumber)
voidsetListLevel(int listLevel)
Sets the list level of this RtfList.
voidsetListLevelParent(RtfListLevel listLevelParent)
voidsetListNoRestart(int listNoRestart)
voidsetListStartAt(int listStartAt)
voidsetListType(int listType)
voidsetParent(RtfList parent)
voidsetRightIndent(int rightIndent)
voidsetSymbolIndent(int symbolIndent)
voidsetTentative(boolean isTentative)
voidwriteContent(OutputStream result)
unused
voidwriteDefinition(OutputStream result)
voidwriteIndentation(OutputStream result)
Write the indentation values for this RtfList.
voidwriteListBeginning(OutputStream result)
Writes the initialization part of the RtfList
protected voidwriteListNumbers(OutputStream result)
Writes only the list number and list level number.

Field Detail

alignment

private int alignment
The alignment of this RtfList

bulletCharacter

private String bulletCharacter
The text to use as the bullet character

firstIndent

private int firstIndent
The first indentation of this RtfList

fontBullet

private RtfFont fontBullet
The RtfFont for bulleted lists

fontNumber

private RtfFont fontNumber
The RtfFont for numbered lists

isLegal

private boolean isLegal
Flag 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.

isTentative

private boolean isTentative
Flag to indicate if the tentative control word should be emitted.

leftIndent

private int leftIndent
The left indentation of this RtfList

levelFollowValue

private int levelFollowValue

levelPicture

private int levelPicture
Which picture bullet from the \listpicture destination should be applied

levelTextNumber

private int levelTextNumber

listLevel

private int listLevel
The level of this RtfListLevel

listLevelParent

private RtfListLevel listLevelParent

listNoRestart

private int listNoRestart
Does the list restart numbering each time a super ordinate level is incremented

listStartAt

private int listStartAt
The number to start counting at

listType

private int listType
Whether this RtfList is numbered

LIST_LEVEL

private static final byte[] LIST_LEVEL
Constant for list level

LIST_LEVEL_ALIGNMENT

private static final byte[] LIST_LEVEL_ALIGNMENT
Constant for list level alignment old

LIST_LEVEL_ALIGNMENT_NEW

private static final byte[] LIST_LEVEL_ALIGNMENT_NEW
Constant for list level alignment new

LIST_LEVEL_FIRST_INDENT

private static final byte[] LIST_LEVEL_FIRST_INDENT
Constant for the first indentation

LIST_LEVEL_FOLLOW_NOTHING

public static final int LIST_LEVEL_FOLLOW_NOTHING

LIST_LEVEL_FOLLOW_SPACE

public static final int LIST_LEVEL_FOLLOW_SPACE

LIST_LEVEL_FOLLOW_TAB

public static final int LIST_LEVEL_FOLLOW_TAB

LIST_LEVEL_FOLOW

private static final byte[] LIST_LEVEL_FOLOW
Constant which specifies which character follows the level text

LIST_LEVEL_INDENT

private static final byte[] LIST_LEVEL_INDENT
Constant which specifies the levelindent control word

LIST_LEVEL_LEGAL

private static final byte[] LIST_LEVEL_LEGAL
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.

LIST_LEVEL_NO_RESTART

private static final byte[] LIST_LEVEL_NO_RESTART
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.

LIST_LEVEL_NUMBERS_BEGIN

private static final byte[] LIST_LEVEL_NUMBERS_BEGIN
Constant for the beginning of the list level numbers

LIST_LEVEL_NUMBERS_END

private static final byte[] LIST_LEVEL_NUMBERS_END
Constant for the end of the list level numbers

LIST_LEVEL_NUMBERS_NUMBERED

private static final byte[] LIST_LEVEL_NUMBERS_NUMBERED
Constant for the list level numbers

LIST_LEVEL_PICTURE

private static final byte[] LIST_LEVEL_PICTURE
Constant for the levelpictureN control word

LIST_LEVEL_SPACE

private static final byte[] LIST_LEVEL_SPACE
Constant which specifies the levelspace controlword

LIST_LEVEL_START_AT

private static final byte[] LIST_LEVEL_START_AT
Constant for list level start at

LIST_LEVEL_STYLE_BULLETED_BEGIN

private static final byte[] LIST_LEVEL_STYLE_BULLETED_BEGIN
Constant for the beginning of the list level bulleted style

LIST_LEVEL_STYLE_BULLETED_END

private static final byte[] LIST_LEVEL_STYLE_BULLETED_END
Constant for the end of the list level bulleted style

LIST_LEVEL_STYLE_NUMBERED_BEGIN

private static final byte[] LIST_LEVEL_STYLE_NUMBERED_BEGIN
Constant for the beginning of the list level numbered style

LIST_LEVEL_STYLE_NUMBERED_END

private static final byte[] LIST_LEVEL_STYLE_NUMBERED_END
Constant for the end of the list level numbered style

LIST_LEVEL_SYMBOL_INDENT

private static final byte[] LIST_LEVEL_SYMBOL_INDENT
Constant for the symbol indentation

LIST_LEVEL_TEMPLATE_ID

private static final byte[] LIST_LEVEL_TEMPLATE_ID
Constant for list level

LIST_LEVEL_TENTATIVE

private static final byte[] LIST_LEVEL_TENTATIVE
Constant for the lvltentative control word

LIST_LEVEL_TEXT

private static final byte[] LIST_LEVEL_TEXT
Constant for list level text

LIST_LEVEL_TYPE

private static final byte[] LIST_LEVEL_TYPE
Constant for list level style old

LIST_LEVEL_TYPE_NEW

private static final byte[] LIST_LEVEL_TYPE_NEW
Constant for list level style new

LIST_TYPE_ARABIC

public static final int LIST_TYPE_ARABIC

LIST_TYPE_ARABIC_LEADING_ZERO

public static final int LIST_TYPE_ARABIC_LEADING_ZERO

LIST_TYPE_BASE

public static final int LIST_TYPE_BASE

LIST_TYPE_BULLET

public static final int LIST_TYPE_BULLET

LIST_TYPE_CARDINAL_TEXT_NUMBER

public static final int LIST_TYPE_CARDINAL_TEXT_NUMBER

LIST_TYPE_LOWERCASE_LETTER

public static final int LIST_TYPE_LOWERCASE_LETTER

LIST_TYPE_LOWERCASE_ROMAN_NUMERAL

public static final int LIST_TYPE_LOWERCASE_ROMAN_NUMERAL

LIST_TYPE_LOWER_LETTERS

public static final int LIST_TYPE_LOWER_LETTERS

LIST_TYPE_LOWER_ROMAN

public static final int LIST_TYPE_LOWER_ROMAN

LIST_TYPE_NO_NUMBER

public static final int LIST_TYPE_NO_NUMBER

LIST_TYPE_NUMBERED

public static final int LIST_TYPE_NUMBERED

LIST_TYPE_ORDINAL_NUMBER

public static final int LIST_TYPE_ORDINAL_NUMBER

LIST_TYPE_ORDINAL_TEXT_NUMBER

public static final int LIST_TYPE_ORDINAL_TEXT_NUMBER

LIST_TYPE_UNKNOWN

public static final int LIST_TYPE_UNKNOWN

LIST_TYPE_UPPERCASE_LETTER

public static final int LIST_TYPE_UPPERCASE_LETTER

LIST_TYPE_UPPERCASE_ROMAN_NUMERAL

public static final int LIST_TYPE_UPPERCASE_ROMAN_NUMERAL

LIST_TYPE_UPPER_LETTERS

public static final int LIST_TYPE_UPPER_LETTERS

LIST_TYPE_UPPER_ROMAN

public static final int LIST_TYPE_UPPER_ROMAN

parent

private RtfList parent
Parent list object

rightIndent

private int rightIndent
The right indentation of this RtfList

symbolIndent

private int symbolIndent
The symbol indentation of this RtfList

templateID

private int templateID

Constructor Detail

RtfListLevel

public RtfListLevel(RtfDocument doc)

RtfListLevel

public RtfListLevel(RtfDocument doc, RtfList parent)

RtfListLevel

public RtfListLevel(RtfListLevel ll)

Method Detail

correctIndentation

protected void correctIndentation()
Correct the indentation of this level

getAlignment

public int getAlignment()

Returns: the alignment

getBulletCharacter

public String getBulletCharacter()

getFirstIndent

public int getFirstIndent()

Returns: the firstIndent

getFontBullet

public RtfFont getFontBullet()

Returns: the fontBullet

getFontNumber

public RtfFont getFontNumber()

Returns: the fontNumber

getLeftIndent

public int getLeftIndent()

Returns: the leftIndent

getLevelFollowValue

public int getLevelFollowValue()

Returns: the levelFollowValue

getLevelTextNumber

public int getLevelTextNumber()

Returns: the levelTextNumber

getListLevel

public int getListLevel()
Gets the list level of this RtfList

Returns: Returns the list level.

getListLevelParent

public RtfListLevel getListLevelParent()

Returns: the listLevelParent

getListNoRestart

public int getListNoRestart()

Returns: the listNoRestart

getListStartAt

public int getListStartAt()

Returns: the listStartAt

getListType

public int getListType()

Returns: the listType

getParent

public RtfList getParent()

Returns: the parent

getRightIndent

public int getRightIndent()

Returns: the rightIndent

getSymbolIndent

public int getSymbolIndent()

Returns: the symbolIndent

isLegal

public boolean isLegal()

Returns: the isLegal

isTentative

public boolean isTentative()

Returns: the isTentative

setAlignment

public void setAlignment(int alignment)

Parameters: alignment the alignment to set

setBulletCharacter

public void setBulletCharacter(String bulletCharacter)

Parameters: bulletCharacter the bulletCharacter to set

setBulletFont

public void setBulletFont(Font f)
set the bullet font

Parameters: f

setFirstIndent

public void setFirstIndent(int firstIndent)

Parameters: firstIndent the firstIndent to set

setFontBullet

public void setFontBullet(RtfFont fontBullet)

Parameters: fontBullet the fontBullet to set

setFontNumber

public void setFontNumber(RtfFont fontNumber)

Parameters: fontNumber the fontNumber to set

setLeftIndent

public void setLeftIndent(int leftIndent)

Parameters: leftIndent the leftIndent to set

setLegal

public void setLegal(boolean isLegal)

Parameters: isLegal the isLegal to set

setLevelFollowValue

public void setLevelFollowValue(int levelFollowValue)

Parameters: levelFollowValue the levelFollowValue to set

setLevelTextNumber

public void setLevelTextNumber(int levelTextNumber)

Parameters: levelTextNumber the levelTextNumber to set

setListLevel

public void setListLevel(int listLevel)
Sets the list level of this RtfList.

Parameters: listLevel The list level to set.

setListLevelParent

public void setListLevelParent(RtfListLevel listLevelParent)

Parameters: listLevelParent the listLevelParent to set

setListNoRestart

public void setListNoRestart(int listNoRestart)

Parameters: listNoRestart the listNoRestart to set

setListStartAt

public void setListStartAt(int listStartAt)

Parameters: listStartAt the listStartAt to set

setListType

public void setListType(int listType)

Parameters: listType the listType to set

setParent

public void setParent(RtfList parent)

Parameters: parent the parent to set

setRightIndent

public void setRightIndent(int rightIndent)

Parameters: rightIndent the rightIndent to set

setSymbolIndent

public void setSymbolIndent(int symbolIndent)

Parameters: symbolIndent the symbolIndent to set

setTentative

public void setTentative(boolean isTentative)

Parameters: isTentative the isTentative to set

writeContent

public void writeContent(OutputStream result)
unused

writeDefinition

public void writeDefinition(OutputStream result)

writeIndentation

public void writeIndentation(OutputStream result)
Write the indentation values for this RtfList.

Parameters: result The OutputStream to write to.

Throws: IOException On i/o errors.

writeListBeginning

public void writeListBeginning(OutputStream result)
Writes the initialization part of the RtfList

Parameters: result The OutputStream to write to

Throws: IOException On i/o errors.

writeListNumbers

protected void writeListNumbers(OutputStream result)
Writes only the list number and list level number.

Parameters: result The OutputStream to write to

Throws: IOException On i/o errors.