org.jfor.jfor.rtflib.rtfdoc
Class RtfList

java.lang.Object
  extended byorg.jfor.jfor.rtflib.rtfdoc.RtfElement
      extended byorg.jfor.jfor.rtflib.rtfdoc.RtfContainer
          extended byorg.jfor.jfor.rtflib.rtfdoc.RtfList

public class RtfList
extends RtfContainer

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

Author:
Bertrand Delacretaz bdelacretaz@codeconsult.ch

Nested Class Summary
static class RtfList.NumberingStyle
           
 
Field Summary
 
Fields inherited from class org.jfor.jfor.rtflib.rtfdoc.RtfElement
m_attrib, m_parent, m_writer
 
Constructor Summary
(package private) RtfList(RtfContainer parent, java.io.Writer w, RtfAttributes attr)
          Create an RTF list as a child of given container with given attributes
 
Method Summary
 boolean isBulletedList()
          true if this is a bulleted list (as opposed to numbered list)
 RtfListItem newListItem()
          close current list item and start a new one
 void setNumberingStyle(RtfList.NumberingStyle ns)
          change numbering 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.jfor.jfor.rtflib.rtfdoc.RtfContainer
addChild, containsText, dump, getChildCount, getChildren, getOptions, isEmpty, okToWriteRtf, setChildren, setOptions, toString, writeRtfContent
 
Methods inherited from class org.jfor.jfor.rtflib.rtfdoc.RtfElement
close, getParentOfClass, getRtfAttributes, getRtfFile, isClosed, 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
 

Constructor Detail

RtfList

RtfList(RtfContainer parent,
        java.io.Writer w,
        RtfAttributes attr)
  throws java.io.IOException
Create an RTF list as a child of given container with given attributes

Method Detail

setNumberingStyle

public void setNumberingStyle(RtfList.NumberingStyle ns)
change numbering style


writeRtfPrefix

protected void writeRtfPrefix()
                       throws java.io.IOException
overridden to setup the list: start a group with appropriate attributes

Overrides:
writeRtfPrefix in class RtfElement
Throws:
java.io.IOException

writeRtfSuffix

protected void writeRtfSuffix()
                       throws java.io.IOException
end the list group

Overrides:
writeRtfSuffix in class RtfElement
Throws:
java.io.IOException

newListItem

public RtfListItem newListItem()
                        throws java.io.IOException
close current list item and start a new one

Throws:
java.io.IOException

isBulletedList

public boolean isBulletedList()
true if this is a bulleted list (as opposed to numbered list)