com.lowagie.text.rtf.list

Class RtfListItem

public class RtfListItem extends RtfParagraph

The RtfListItem acts as a wrapper for a ListItem.

Since: 2.1.3

Version: $Id: RtfListItem.java 3458 2008-05-26 16:19:21Z howard_s $

Author: Mark Hall (Mark.Hall@mail.room3b.eu) Howard Shank (hgshank@yahoo.com)

Field Summary
boolean	containsInnerList Whether this RtfListItem contains further RtfLists.
int	level
RtfListLevel	parentList The RtfList this RtfListItem belongs to.

Constructor Summary
	RtfListItem(RtfDocument doc, ListItem listItem) Constructs a RtfListItem for a ListItem belonging to a RtfDocument.

Method Summary
protected void	correctIndentation() Correct the indentation of RtfLists in this RtfListItem by adding left/first line indentation from the parent RtfList.
int	getLevel()
RtfListLevel	getParent() Set the parent RtfList.
void	inheritListSettings(int listNumber, int listLevel) Inherit the list settings from the parent list to RtfLists that are contained in this RtfListItem.
boolean	isContainsInnerList() Gets whether this RtfListItem contains further RtfLists.
void	setLevel(int level)
void	setParent(RtfListLevel parentList) Set the parent RtfList.
void	writeContent(OutputStream result) Writes the content of this RtfListItem.
boolean	writeDefinition(OutputStream out) Writes the definition of the first element in this RtfListItem that is an instanceof RtfList to the given stream. If this item does not contain a RtfList element nothing is written and the method returns `false`.

Field Detail

containsInnerList

private boolean containsInnerList

Whether this RtfListItem contains further RtfLists.

parentList

private RtfListLevel parentList

The RtfList this RtfListItem belongs to.

Constructor Detail

RtfListItem

public RtfListItem(RtfDocument doc, ListItem listItem)

Constructs a RtfListItem for a ListItem belonging to a RtfDocument.

Parameters: doc The RtfDocument this RtfListItem belongs to. listItem The ListItem this RtfListItem is based on.

Method Detail

correctIndentation

protected void correctIndentation()

Correct the indentation of RtfLists in this RtfListItem by adding left/first line indentation from the parent RtfList. Also calls correctIndentation on all child RtfLists.

getLevel

public int getLevel()

Returns: the level

Since: 2.1.3

getParent

public RtfListLevel getParent()

Set the parent RtfList.

Returns: The parent RtfList to use.

Since: 2.1.3

inheritListSettings

public void inheritListSettings(int listNumber, int listLevel)

Inherit the list settings from the parent list to RtfLists that are contained in this RtfListItem.

Parameters: listNumber The list number to inherit. listLevel The list level to inherit.

isContainsInnerList

public boolean isContainsInnerList()

Gets whether this RtfListItem contains further RtfLists.

Returns: Whether this RtfListItem contains further RtfLists.

setLevel

public void setLevel(int level)

Parameters: level the level to set

Since: 2.1.3

setParent

public void setParent(RtfListLevel parentList)

Set the parent RtfList.

Parameters: parentList The parent RtfList to use.

writeContent

public void writeContent(OutputStream result)

Writes the content of this RtfListItem.

writeDefinition

public boolean writeDefinition(OutputStream out)

Writes the definition of the first element in this RtfListItem that is an instanceof RtfList to the given stream.
If this item does not contain a RtfList element nothing is written and the method returns false.

Parameters: out destination stream

Returns: true if a RtfList definition was written, false otherwise

Throws: IOException