Package org.apache.fop.render.rtf.rtflib.rtfdoc

Class RtfListItem

java.lang.Object

org.apache.fop.render.rtf.rtflib.rtfdoc.RtfElement

org.apache.fop.render.rtf.rtflib.rtfdoc.RtfContainer

org.apache.fop.render.rtf.rtflib.rtfdoc.RtfListItem

All Implemented Interfaces:

IRtfListContainer, IRtfParagraphContainer, IRtfTextrunContainer

public class RtfListItem
extends RtfContainer
implements IRtfTextrunContainer, IRtfListContainer, IRtfParagraphContainer

Model of an RTF list item, which can contain RTF paragraphs.

This work was authored by Bertrand Delacretaz (bdelacretaz@codeconsult.ch) and Andreas Putz (a.putz@skynamics.com).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	RtfListItem.RtfListItemLabel	special RtfTextrun that is used as list item label
private class	RtfListItem.RtfListItemParagraph	special RtfParagraph that writes list item setup code before its content

Field Summary

Fields

Modifier and Type	Field	Description
private RtfListStyle	listStyle
private int	number
private RtfParagraph	paragraph
private RtfList	parentList

Fields inherited from class org.apache.fop.render.rtf.rtflib.rtfdoc.RtfElement

attrib, parent, writer

Constructor Summary

Constructors

Constructor	Description
RtfListItem(RtfList parent, Writer w)	Create an RTF list item as a child of given container with default attributes
RtfListItem(RtfList parent, Writer w, RtfAttributes attr)	Create an RTF list item as a child of given container with given attributes

Method Summary

Modifier and Type	Method	Description
int	getNumber()	Returns the list number
RtfList	getParentList()	Get the parent list.
RtfListStyle	getRtfListStyle()	Get list style
RtfTextrun	getTextrun()	Get the current textrun.
RtfList	newList(RtfAttributes attrs)	Start a new list after closing current paragraph, list and table
RtfParagraph	newParagraph()	Close current paragraph if any and start a new one with default attributes
RtfParagraph	newParagraph(RtfAttributes attrs)	Close current paragraph if any and start a new one
void	setRtfListStyle(RtfListStyle ls)	Change list style
protected void	writeRtfPrefix()	Overridden to setup the list: start a group with appropriate attributes
protected void	writeRtfSuffix()	End the list group

Methods inherited from class org.apache.fop.render.rtf.rtflib.rtfdoc.RtfContainer

addChild, containsText, dump, findChildren, getChildCount, getChildren, getOptions, isEmpty, okToWriteRtf, setChildren, setOptions, toString, writeRtfContent

Methods inherited from class org.apache.fop.render.rtf.rtflib.rtfdoc.RtfElement

close, getParentOfClass, getRtfAttributes, getRtfFile, isClosed, newLine, writeAttributes, writeControlWord, writeControlWordNS, writeExceptionInRtf, writeGroupMark, writeOneAttribute, writeOneAttributeNS, writeRtf, writeStarControlWord, writeStarControlWordNS

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

parentList

private RtfList parentList

paragraph

private RtfParagraph paragraph

listStyle

private RtfListStyle listStyle

number

private int number

Constructor Details

RtfListItem

RtfListItem(RtfList parent,
 Writer w)
     throws IOException

Create an RTF list item as a child of given container with default attributes

Throws:

IOException

RtfListItem

RtfListItem(RtfList parent,
 Writer w,
 RtfAttributes attr)
     throws IOException

Create an RTF list item as a child of given container with given attributes

Throws:

IOException

Method Details

newParagraph

public RtfParagraph newParagraph(RtfAttributes attrs)
                          throws IOException

Close current paragraph if any and start a new one

Specified by:

newParagraph in interface IRtfParagraphContainer

Parameters:

attrs - attributes of new paragraph

Returns:

new RtfParagraph

Throws:

IOException - Thrown when an IO-problem occurs

newParagraph

public RtfParagraph newParagraph()
                          throws IOException

Close current paragraph if any and start a new one with default attributes

Specified by:

newParagraph in interface IRtfParagraphContainer

Returns:

new RtfParagraph

Throws:

IOException - Thrown when an IO-problem occurs

getTextrun

public RtfTextrun getTextrun()
                      throws IOException

Get the current textrun.

Specified by:

getTextrun in interface IRtfTextrunContainer

Returns:

current RtfTextrun object

Throws:

IOException - Thrown when an IO-problem occurs

newList

public RtfList newList(RtfAttributes attrs)
                throws IOException

Start a new list after closing current paragraph, list and table

Specified by:

newList in interface IRtfListContainer

Parameters:

attrs - attributes of new RftList object

Returns:

new RtfList

Throws:

IOException - for I/O problems

writeRtfPrefix

protected void writeRtfPrefix()
                       throws IOException

Overridden to setup the list: start a group with appropriate attributes

Overrides:

writeRtfPrefix in class RtfElement

Throws:

IOException - for I/O problems

writeRtfSuffix

protected void writeRtfSuffix()
                       throws IOException

End the list group

Overrides:

writeRtfSuffix in class RtfElement

Throws:

IOException - for I/O problems

setRtfListStyle

public void setRtfListStyle(RtfListStyle ls)

Change list style

Parameters:

ls - ListStyle to set

getRtfListStyle

public RtfListStyle getRtfListStyle()

Get list style

Returns:

ListSytle of the List

getParentList

public RtfList getParentList()

Get the parent list.

Returns:

the parent list

getNumber

public int getNumber()

Returns the list number

Returns:

list number