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

Class 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.
Author:
Christopher Scott, scottc@westinghouse.com

Field Summary

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

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

attrib, parent, writer

Constructor Summary

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

Method Summary

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
void
writeRtfContent()
Write the content

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

addChild, getChildCount, getChildren, isEmpty, okToWriteRtf, setChildren, setOptions, toString, writeRtfContent

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

close, getRtfAttributes, isEmpty, newLine, okToWriteRtf, toString, writeAttributes, writeControlWord, writeControlWordNS, writeExceptionInRtf, writeGroupMark, writeOneAttribute, writeOneAttributeNS, writeRtf, writeRtfContent, writeRtfPrefix, writeRtfSuffix, writeStarControlWord, writeStarControlWordNS

Field Details

LIST

public static final String LIST
constant for a list

LIST_FOLLOWING_CHAR

public static final String LIST_FOLLOWING_CHAR
constant for list following character

LIST_FONT_TYPE

public static final String LIST_FONT_TYPE
constant for list font type

LIST_ID

public static final String LIST_ID
constant for list ID

LIST_INDENT

public static final String LIST_INDENT
constant for list indentation

LIST_JUSTIFICATION

public static final String LIST_JUSTIFICATION
constant for a list justification

LIST_LEVEL

public static final String LIST_LEVEL
constant for a list level

LIST_NAME

public static final String LIST_NAME
constant for list name

LIST_NUMBER

public static final String LIST_NUMBER
constant for list number

LIST_NUMBER_TYPE

public static final String LIST_NUMBER_TYPE
constant for a list number type

LIST_NUM_POSITION

public static final String LIST_NUM_POSITION
constant for list number positioning

LIST_OVR

public static final String LIST_OVR
constant for list override

LIST_OVR_COUNT

public static final String LIST_OVR_COUNT
constant for list override count

LIST_OVR_TABLE

public static final String LIST_OVR_TABLE
constant for list override table

LIST_SPACE

public static final String LIST_SPACE
constant for list space

LIST_START_AT

public static final String LIST_START_AT
constant for list start at

LIST_TABLE

public static final String LIST_TABLE
constant for a list table

LIST_TABLE_ATTR

public static final String[] LIST_TABLE_ATTR
String array of list table attributes

LIST_TEMPLATE_ID

public static final String LIST_TEMPLATE_ID
constant for a list template id

LIST_TEXT_FORM

public static final String LIST_TEXT_FORM
constant for list text format

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

Method Details

addList

public int addList(RtfList list)
Add List
Parameters:
list - RtfList to add
Returns:
number of lists in the table after adding

addRtfListStyle

public int addRtfListStyle(RtfListStyle ls)
Add list style
Parameters:
ls - ListStyle to set
Returns:
number of styles after adding

isEmpty

public boolean isEmpty()
Since this has no text content we have to overwrite isEmpty to print the table
Overrides:
isEmpty in interface RtfContainer
Returns:
false (always)

writeRtfContent

public void writeRtfContent()
            throws IOException
Write the content
Overrides:
writeRtfContent in interface RtfContainer

Copyright 1999-2007 The Apache Software Foundation. All Rights Reserved.