org.jfor.jfor.rtflib.rtfdoc
Class RtfListTable

java.lang.Object
  extended byorg.jfor.jfor.rtflib.rtfdoc.RtfElement
      extended byorg.jfor.jfor.rtflib.rtfdoc.RtfContainer
          extended byorg.jfor.jfor.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.


Field Summary
static java.lang.String LIST
           
static java.lang.String LIST_FOLLOWING_CHAR
           
static java.lang.String LIST_FONT_TYPE
           
static java.lang.String LIST_ID
           
static java.lang.String LIST_INDENT
           
static java.lang.String LIST_JUSTIFICATION
           
static java.lang.String LIST_LEVEL
           
static java.lang.String LIST_NAME
           
static java.lang.String LIST_NUM_POSITION
           
static java.lang.String LIST_NUMBER
           
static java.lang.String LIST_NUMBER_TYPE
           
static java.lang.String LIST_OVR
           
static java.lang.String LIST_OVR_COUNT
           
static java.lang.String LIST_OVR_TABLE
           
static java.lang.String LIST_SPACE
           
static java.lang.String LIST_START_AT
           
static java.lang.String LIST_TABLE
           
static java.lang.String[] LIST_TABLE_ATTR
           
static java.lang.String LIST_TEMPLATE_ID
           
static java.lang.String LIST_TEXT_FORM
           
 
Fields inherited from class org.jfor.jfor.rtflib.rtfdoc.RtfElement
m_attrib, m_parent, m_writer
 
Constructor Summary
RtfListTable(RtfContainer parent, java.io.Writer w, java.lang.Integer num, RtfAttributes attrs)
          RtfListTable Constructor: sets the number of the list, and allocates for the RtfAttributes
 
Method Summary
 java.lang.Integer getListNumber()
           
 boolean isEmpty()
          true if this element would generate no "useful" RTF content.
 void setParentList(RtfList parent)
           
 void writeRtfContent()
          write RTF code of all our children
 
Methods inherited from class org.jfor.jfor.rtflib.rtfdoc.RtfContainer
addChild, containsText, dump, getChildCount, getChildren, getOptions, okToWriteRtf, setChildren, setOptions, toString
 
Methods inherited from class org.jfor.jfor.rtflib.rtfdoc.RtfElement
close, getParentOfClass, getRtfAttributes, getRtfFile, isClosed, writeAttributes, writeControlWord, writeControlWordNS, writeExceptionInRtf, writeGroupMark, writeOneAttribute, writeOneAttributeNS, writeRtf, writeRtfPrefix, writeRtfSuffix, writeStarControlWord, writeStarControlWordNS
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

LIST_TABLE

public static final java.lang.String LIST_TABLE
See Also:
Constant Field Values

LIST

public static final java.lang.String LIST
See Also:
Constant Field Values

LIST_TEMPLATE_ID

public static final java.lang.String LIST_TEMPLATE_ID
See Also:
Constant Field Values

LIST_LEVEL

public static final java.lang.String LIST_LEVEL
See Also:
Constant Field Values

LIST_NUMBER_TYPE

public static final java.lang.String LIST_NUMBER_TYPE
See Also:
Constant Field Values

LIST_JUSTIFICATION

public static final java.lang.String LIST_JUSTIFICATION
See Also:
Constant Field Values

LIST_FOLLOWING_CHAR

public static final java.lang.String LIST_FOLLOWING_CHAR
See Also:
Constant Field Values

LIST_START_AT

public static final java.lang.String LIST_START_AT
See Also:
Constant Field Values

LIST_SPACE

public static final java.lang.String LIST_SPACE
See Also:
Constant Field Values

LIST_INDENT

public static final java.lang.String LIST_INDENT
See Also:
Constant Field Values

LIST_TEXT_FORM

public static final java.lang.String LIST_TEXT_FORM
See Also:
Constant Field Values

LIST_NUM_POSITION

public static final java.lang.String LIST_NUM_POSITION
See Also:
Constant Field Values

LIST_NAME

public static final java.lang.String LIST_NAME
See Also:
Constant Field Values

LIST_ID

public static final java.lang.String LIST_ID
See Also:
Constant Field Values

LIST_FONT_TYPE

public static final java.lang.String LIST_FONT_TYPE
See Also:
Constant Field Values

LIST_OVR_TABLE

public static final java.lang.String LIST_OVR_TABLE
See Also:
Constant Field Values

LIST_OVR

public static final java.lang.String LIST_OVR
See Also:
Constant Field Values

LIST_OVR_COUNT

public static final java.lang.String LIST_OVR_COUNT
See Also:
Constant Field Values

LIST_NUMBER

public static final java.lang.String LIST_NUMBER
See Also:
Constant Field Values

LIST_TABLE_ATTR

public static final java.lang.String[] LIST_TABLE_ATTR
Constructor Detail

RtfListTable

public RtfListTable(RtfContainer parent,
                    java.io.Writer w,
                    java.lang.Integer num,
                    RtfAttributes attrs)
             throws java.io.IOException
RtfListTable Constructor: sets the number of the list, and allocates for the RtfAttributes

Method Detail

setParentList

public void setParentList(RtfList parent)

getListNumber

public java.lang.Integer getListNumber()

writeRtfContent

public void writeRtfContent()
                     throws java.io.IOException
Description copied from class: RtfContainer
write RTF code of all our children

Overrides:
writeRtfContent in class RtfContainer
Throws:
java.io.IOException

isEmpty

public boolean isEmpty()
Description copied from class: RtfContainer
true if this element would generate no "useful" RTF content. For an RtfContainer, true if it has no children where isEmpty() is false

Overrides:
isEmpty in class RtfContainer