Class RtfList

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.RtfList

public class RtfList
extends RtfContainer

Model of an RTF list, which can contain RTF list items.

This work was authored by Bertrand Delacretaz (bdelacretaz@codeconsult.ch), Christopher Scott (scottc@westinghouse.com), and Peter Herweg (pherweg@web.de).

Field Summary

Fields

Modifier and Type	Field	Description
private RtfListStyle	defaultListStyle
private final boolean	hasTableParent
private RtfListItem	item
private Integer	listId
private static Random	listIdGenerator
private RtfListTable	listTable
private Integer	listTemplateId

Fields inherited from class RtfElement

attrib, parent, writer

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
boolean	getHasTableParent()	Returns true, if the list has a parent table.
Integer	getListId()	Returns the Id of the list.
Integer	getListTemplateId()	Returns the Id of the list template.
RtfListStyle	getRtfListStyle()	Get list style
RtfListItem	newListItem()	Close current list item and start a new one
void	setRtfListStyle(RtfListStyle ls)	Change list style

Methods inherited from class RtfContainer

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

Methods inherited from class RtfElement

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

Methods inherited from class Object

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

Field Details

item

private RtfListItem item

listTable

private RtfListTable listTable

hasTableParent

private final boolean hasTableParent

defaultListStyle

private RtfListStyle defaultListStyle

listTemplateId

private Integer listTemplateId

listId

private Integer listId

listIdGenerator

private static Random listIdGenerator

Constructor Details

RtfList

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

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

Throws:

IOException

Method Details

newListItem

public RtfListItem newListItem()
                        throws IOException

Close current list item and start a new one

Returns:

new RtfListItem

Throws:

IOException - for I/O problems

getListId

public Integer getListId()

Returns the Id of the list.

Returns:

Id of the list

getListTemplateId

public Integer getListTemplateId()

Returns the Id of the list template.

Returns:

Id of the list template

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

getHasTableParent

public boolean getHasTableParent()

Returns true, if the list has a parent table.

Returns:

true, if the list has a parent table