RtfListLevel (iText-4.2.1 4.2.1 API)

java.lang.Object
- com.lowagie.text.rtf.RtfElement
- - com.lowagie.text.rtf.list.RtfListLevel

All Implemented Interfaces:

RtfBasicElement, RtfExtendedElement, RtfElementInterface
```
public class RtfListLevel
extends RtfElement
implements RtfExtendedElement
```
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 $

Author:

Howard Shank (hgshank@yahoo.com)

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`LIST_LEVEL_FOLLOW_NOTHING`
`static int`	`LIST_LEVEL_FOLLOW_SPACE`
`static int`	`LIST_LEVEL_FOLLOW_TAB`
`static int`	`LIST_TYPE_ARABIC`
`static int`	`LIST_TYPE_ARABIC_LEADING_ZERO`
`static int`	`LIST_TYPE_BASE`
`static int`	`LIST_TYPE_BULLET`
`static int`	`LIST_TYPE_CARDINAL_TEXT_NUMBER`
`static int`	`LIST_TYPE_LOWER_LETTERS`
`static int`	`LIST_TYPE_LOWER_ROMAN`
`static int`	`LIST_TYPE_LOWERCASE_LETTER`
`static int`	`LIST_TYPE_LOWERCASE_ROMAN_NUMERAL`
`static int`	`LIST_TYPE_NO_NUMBER`
`static int`	`LIST_TYPE_NUMBERED`
`static int`	`LIST_TYPE_ORDINAL_NUMBER`
`static int`	`LIST_TYPE_ORDINAL_TEXT_NUMBER`
`static int`	`LIST_TYPE_UNKNOWN`
`static int`	`LIST_TYPE_UPPER_LETTERS`
`static int`	`LIST_TYPE_UPPER_ROMAN`
`static int`	`LIST_TYPE_UPPERCASE_LETTER`
`static int`	`LIST_TYPE_UPPERCASE_ROMAN_NUMERAL`

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
Constructor and Description

RtfListLevel(RtfDocument doc)

RtfListLevel(RtfDocument doc, RtfList parent)

RtfListLevel(RtfListLevel ll)

Constructors
Constructor and Description
`RtfListLevel(RtfDocument doc)`
`RtfListLevel(RtfDocument doc, RtfList parent)`
`RtfListLevel(RtfListLevel ll)`

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`correctIndentation()` Correct the indentation of this level
`int`	`getAlignment()`
`String`	`getBulletCharacter()`
`int`	`getFirstIndent()`
`RtfFont`	`getFontBullet()`
`RtfFont`	`getFontNumber()`
`int`	`getLeftIndent()`
`int`	`getLevelFollowValue()`
`int`	`getLevelTextNumber()`
`int`	`getListLevel()` Gets the list level of this RtfList
`RtfListLevel`	`getListLevelParent()`
`int`	`getListNoRestart()`
`int`	`getListStartAt()`
`int`	`getListType()`
`RtfList`	`getParent()`
`int`	`getRightIndent()`
`int`	`getSymbolIndent()`
`boolean`	`isLegal()`
`boolean`	`isTentative()`
`void`	`setAlignment(int alignment)`
`void`	`setBulletCharacter(String bulletCharacter)`
`void`	`setBulletChunk(Chunk bulletCharacter)`
`void`	`setBulletFont(Font f)` set the bullet font
`void`	`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`	`setParent(RtfList parent)`
`void`	`setRightIndent(int rightIndent)`
`void`	`setSymbolIndent(int symbolIndent)`
`void`	`setTentative(boolean isTentative)`
`void`	`writeContent(OutputStream result)` unused
`void`	`writeDefinition(OutputStream result)` Write the definition part of the element
`void`	`writeIndentation(OutputStream result)` Write the indentation values for this `RtfList`.
`void`	`writeListBeginning(OutputStream result)` Writes the initialization part of the RtfList
`protected 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 Detail
  - LIST_TYPE_NUMBERED
```
public static final int LIST_TYPE_NUMBERED
```
    See Also:
    Constant Field Values
  - LIST_TYPE_UPPER_LETTERS
```
public static final int LIST_TYPE_UPPER_LETTERS
```
    See Also:
    Constant Field Values
  - LIST_TYPE_LOWER_LETTERS
```
public static final int LIST_TYPE_LOWER_LETTERS
```
    See Also:
    Constant Field Values
  - LIST_TYPE_UPPER_ROMAN
```
public static final int LIST_TYPE_UPPER_ROMAN
```
    See Also:
    Constant Field Values
  - LIST_TYPE_LOWER_ROMAN
```
public static final int LIST_TYPE_LOWER_ROMAN
```
    See Also:
    Constant Field Values
  - LIST_TYPE_UNKNOWN
```
public static final int LIST_TYPE_UNKNOWN
```
    See Also:
    Constant Field Values
  - LIST_TYPE_BASE
```
public static final int LIST_TYPE_BASE
```
    See Also:
    Constant Field Values
  - LIST_TYPE_ARABIC
```
public static final int LIST_TYPE_ARABIC
```
    See Also:
    Constant Field Values
  - LIST_TYPE_UPPERCASE_ROMAN_NUMERAL
```
public static final int LIST_TYPE_UPPERCASE_ROMAN_NUMERAL
```
    See Also:
    Constant Field Values
  - LIST_TYPE_LOWERCASE_ROMAN_NUMERAL
```
public static final int LIST_TYPE_LOWERCASE_ROMAN_NUMERAL
```
    See Also:
    Constant Field Values
  - LIST_TYPE_UPPERCASE_LETTER
```
public static final int LIST_TYPE_UPPERCASE_LETTER
```
    See Also:
    Constant Field Values
  - LIST_TYPE_LOWERCASE_LETTER
```
public static final int LIST_TYPE_LOWERCASE_LETTER
```
    See Also:
    Constant Field Values
  - LIST_TYPE_ORDINAL_NUMBER
```
public static final int LIST_TYPE_ORDINAL_NUMBER
```
    See Also:
    Constant Field Values
  - LIST_TYPE_CARDINAL_TEXT_NUMBER
```
public static final int LIST_TYPE_CARDINAL_TEXT_NUMBER
```
    See Also:
    Constant Field Values
  - LIST_TYPE_ORDINAL_TEXT_NUMBER
```
public static final int LIST_TYPE_ORDINAL_TEXT_NUMBER
```
    See Also:
    Constant Field Values
  - LIST_TYPE_ARABIC_LEADING_ZERO
```
public static final int LIST_TYPE_ARABIC_LEADING_ZERO
```
    See Also:
    Constant Field Values
  - LIST_TYPE_BULLET
```
public static final int LIST_TYPE_BULLET
```
    See Also:
    Constant Field Values
  - LIST_TYPE_NO_NUMBER
```
public static final int LIST_TYPE_NO_NUMBER
```
    See Also:
    Constant Field Values
  - LIST_LEVEL_FOLLOW_TAB
```
public static final int LIST_LEVEL_FOLLOW_TAB
```
    See Also:
    Constant Field Values
  - LIST_LEVEL_FOLLOW_SPACE
```
public static final int LIST_LEVEL_FOLLOW_SPACE
```
    See Also:
    Constant Field Values
  - LIST_LEVEL_FOLLOW_NOTHING
```
public static final int LIST_LEVEL_FOLLOW_NOTHING
```
    See Also:
    Constant Field Values
- Constructor Detail
  - RtfListLevel
```
public RtfListLevel(RtfDocument doc)
```
  - RtfListLevel
```
public RtfListLevel(RtfDocument doc,
            RtfList parent)
```
  - RtfListLevel
```
public RtfListLevel(RtfListLevel ll)
```
- Method Detail
  - 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
```
public void writeDefinition(OutputStream result)
                     throws IOException
```
    Description copied from interface: RtfExtendedElement
    
    Write the definition part of the element
    
    Specified by:
    
    writeDefinition in interface RtfExtendedElement
    
    Parameters:
    result - The OutputStream to write the element definition to
    
    Throws:
    
    IOException
  - writeContent
```
public void writeContent(OutputStream result)
                  throws IOException
```
    unused
    
    Specified by:
    
    writeContent in interface RtfBasicElement
    
    Specified by:
    
    writeContent in class RtfElement
    
    Parameters:
    result - The OutputStream to write the content to
    
    Throws:
    
    IOException
  - writeListNumbers
```
protected void writeListNumbers(OutputStream result)
                         throws IOException
```
    Writes only the list number and list level number.
    
    Parameters:
    result - The OutputStream to write to
    
    Throws:
    
    IOException - On i/o errors.
  - writeIndentation
```
public void writeIndentation(OutputStream result)
                      throws IOException
```
    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)
                        throws IOException
```
    Writes the initialization part of the RtfList
    
    Parameters:
    result - The OutputStream 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
```
public String 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
```
public RtfList getParent()
```
    Returns:
    the parent
  - setParent
```
public void setParent(RtfList parent)
```
    Parameters:
    parent - the parent to set
  - setBulletCharacter
```
public void setBulletCharacter(String bulletCharacter)
```
    Parameters:
    bulletCharacter - the bulletCharacter to set
  - setBulletChunk
```
public void setBulletChunk(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(Font f)
```
    set the bullet font
    
    Parameters:
    f -
  - getFontNumber
```
public RtfFont getFontNumber()
```
    Returns:
    the fontNumber
  - setFontNumber
```
public void setFontNumber(RtfFont fontNumber)
```
    Parameters:
    fontNumber - the fontNumber to set
  - getFontBullet
```
public RtfFont getFontBullet()
```
    Returns:
    the fontBullet
  - setFontBullet
```
public void setFontBullet(RtfFont fontBullet)
```
    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
```
public RtfListLevel getListLevelParent()
```
    Returns:
    the listLevelParent
  - setListLevelParent
```
public void setListLevelParent(RtfListLevel listLevelParent)
```
    Parameters:
    listLevelParent - the listLevelParent to set

Class RtfListLevel

Field Summary

Fields inherited from class com.lowagie.text.rtf.RtfElement

Fields inherited from interface com.lowagie.text.rtf.RtfBasicElement

Constructor Summary

Method Summary

Methods inherited from class com.lowagie.text.rtf.RtfElement

Methods inherited from class java.lang.Object

Methods inherited from interface com.lowagie.text.rtf.RtfBasicElement

Field Detail

LIST_TYPE_NUMBERED

LIST_TYPE_UPPER_LETTERS

LIST_TYPE_LOWER_LETTERS

LIST_TYPE_UPPER_ROMAN

LIST_TYPE_LOWER_ROMAN

LIST_TYPE_UNKNOWN

LIST_TYPE_BASE

LIST_TYPE_ARABIC

LIST_TYPE_UPPERCASE_ROMAN_NUMERAL

LIST_TYPE_LOWERCASE_ROMAN_NUMERAL

LIST_TYPE_UPPERCASE_LETTER

LIST_TYPE_LOWERCASE_LETTER

LIST_TYPE_ORDINAL_NUMBER

LIST_TYPE_CARDINAL_TEXT_NUMBER

LIST_TYPE_ORDINAL_TEXT_NUMBER

LIST_TYPE_ARABIC_LEADING_ZERO

LIST_TYPE_BULLET

LIST_TYPE_NO_NUMBER

LIST_LEVEL_FOLLOW_TAB

LIST_LEVEL_FOLLOW_SPACE

LIST_LEVEL_FOLLOW_NOTHING

Constructor Detail

RtfListLevel

RtfListLevel

RtfListLevel

Method Detail

getListNoRestart

setListNoRestart

getAlignment

setAlignment

writeDefinition

writeContent

writeListNumbers

writeIndentation

writeListBeginning

correctIndentation

getListLevel

setListLevel

getBulletCharacter

getListStartAt

setListStartAt

getFirstIndent

setFirstIndent

getLeftIndent

setLeftIndent

getRightIndent

setRightIndent

getSymbolIndent

setSymbolIndent

getParent

setParent

setBulletCharacter

setBulletChunk

getListType

setListType

setBulletFont

getFontNumber

setFontNumber

getFontBullet

setFontBullet

isTentative

setTentative

isLegal

setLegal

getLevelFollowValue

setLevelFollowValue

getLevelTextNumber

setLevelTextNumber

getListLevelParent

setListLevelParent