Class RtfListTable

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

public class RtfListTable
extends RtfContainer

RtfListTable: used to make the list table in the header section of the RtfFile. This is the method that Word uses to make lists in RTF and the way most RTF readers, esp. Adobe FrameMaker read lists from RTF.

This work was authored by Christopher Scott (scottc@westinghouse.com).

Field Summary

Fields

Modifier and Type	Field	Description
static final String	LIST	constant for a list
static final String	LIST_FOLLOWING_CHAR	constant for list following character
static final String	LIST_FONT_TYPE	constant for list font type
static final String	LIST_ID	constant for list ID
static final String	LIST_INDENT	constant for list indentation
static final String	LIST_JUSTIFICATION	constant for a list justification
static final String	LIST_LEVEL	constant for a list level
static final String	LIST_NAME	constant for list name
static final String	LIST_NUM_POSITION	constant for list number positioning
static final String	LIST_NUMBER	constant for list number
static final String	LIST_NUMBER_TYPE	constant for a list number type
static final String	LIST_OVR	constant for list override
static final String	LIST_OVR_COUNT	constant for list override count
static final String	LIST_OVR_TABLE	constant for list override table
static final String	LIST_SPACE	constant for list space
static final String	LIST_START_AT	constant for list start at
static final String	LIST_TABLE	constant for a list table
static final String[]	LIST_TABLE_ATTR	String array of list table attributes
static final String	LIST_TEMPLATE_ID	constant for a list template id
static final String	LIST_TEXT_FORM	constant for list text format
private LinkedList	lists
private LinkedList	styles

Fields inherited from class RtfElement

attrib, parent, writer

Constructor Summary

Constructors

Constructor	Description
RtfListTable(RtfContainer parent, Writer w, Integer num, RtfAttributes attrs)	RtfListTable Constructor: sets the number of the list, and allocates for the RtfAttributes

Method Summary

Modifier and Type	Method	Description
int	addList(RtfList list)	Add List
int	addRtfListStyle(RtfListStyle ls)	Add list style
boolean	isEmpty()	Since this has no text content we have to overwrite isEmpty to print the table
private void	writeListTableEntry(RtfList list)
void	writeRtfContent()	Write the content

Methods inherited from class RtfContainer

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

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

lists

private LinkedList lists

styles

private LinkedList styles

LIST_TABLE

public static final String LIST_TABLE

constant for a list table

See Also:

• Constant Field Values

LIST

public static final String LIST

constant for a list

See Also:

• Constant Field Values

LIST_TEMPLATE_ID

public static final String LIST_TEMPLATE_ID

constant for a list template id

See Also:

• Constant Field Values

LIST_LEVEL

public static final String LIST_LEVEL

constant for a list level

See Also:

• Constant Field Values

LIST_NUMBER_TYPE

public static final String LIST_NUMBER_TYPE

constant for a list number type

See Also:

• Constant Field Values

LIST_JUSTIFICATION

public static final String LIST_JUSTIFICATION

constant for a list justification

See Also:

• Constant Field Values

LIST_FOLLOWING_CHAR

public static final String LIST_FOLLOWING_CHAR

constant for list following character

See Also:

• Constant Field Values

LIST_START_AT

public static final String LIST_START_AT

constant for list start at

See Also:

• Constant Field Values

LIST_SPACE

public static final String LIST_SPACE

constant for list space

See Also:

• Constant Field Values

LIST_INDENT

public static final String LIST_INDENT

constant for list indentation

See Also:

• Constant Field Values

LIST_TEXT_FORM

public static final String LIST_TEXT_FORM

constant for list text format

See Also:

• Constant Field Values

LIST_NUM_POSITION

public static final String LIST_NUM_POSITION

constant for list number positioning

See Also:

• Constant Field Values

LIST_NAME

public static final String LIST_NAME

constant for list name

See Also:

• Constant Field Values

LIST_ID

public static final String LIST_ID

constant for list ID

See Also:

• Constant Field Values

LIST_FONT_TYPE

public static final String LIST_FONT_TYPE

constant for list font type

See Also:

• Constant Field Values

LIST_OVR_TABLE

public static final String LIST_OVR_TABLE

constant for list override table

See Also:

• Constant Field Values

LIST_OVR

public static final String LIST_OVR

constant for list override

See Also:

• Constant Field Values

LIST_OVR_COUNT

public static final String LIST_OVR_COUNT

constant for list override count

See Also:

• Constant Field Values

LIST_NUMBER

public static final String LIST_NUMBER

constant for list number

See Also:

• Constant Field Values

LIST_TABLE_ATTR

public static final String[] LIST_TABLE_ATTR

String array of list table attributes

Constructor Details

RtfListTable

public RtfListTable(RtfContainer parent,
 Writer w,
 Integer num,
 RtfAttributes attrs)
             throws IOException

RtfListTable Constructor: sets the number of the list, and allocates for the RtfAttributes

Parameters:

parent - RtfContainer holding this RtfListTable

w - Writer

num - number of the list in the document

attrs - attributes of new RtfListTable

Throws:

IOException - for I/O problems

Method Details

addList

public int addList(RtfList list)

Add List

Parameters:

list - RtfList to add

Returns:

number of lists in the table after adding

writeRtfContent

public void writeRtfContent()
                     throws IOException

Write the content

Overrides:

writeRtfContent in class RtfContainer

Throws:

IOException - for I/O problems

isEmpty

public boolean isEmpty()

Since this has no text content we have to overwrite isEmpty to print the table

Overrides:

isEmpty in class RtfContainer

Returns:

false (always)

writeListTableEntry

private void writeListTableEntry(RtfList list)
                          throws IOException

Throws:

IOException

addRtfListStyle

public int addRtfListStyle(RtfListStyle ls)

Add list style

Parameters:

ls - ListStyle to set

Returns:

number of styles after adding