Class RtfContainer
- java.lang.Object
-
- org.apache.fop.render.rtf.rtflib.rtfdoc.RtfElement
-
- org.apache.fop.render.rtf.rtflib.rtfdoc.RtfContainer
-
- Direct Known Subclasses:
RtfAfter,RtfBefore,RtfBookmarkContainerImpl,RtfDocumentArea,RtfExtraRowSet,RtfFile,RtfFootnote,RtfHyperLink,RtfJforCmd,RtfLeader,RtfList,RtfListItem,RtfListTable,RtfNull,RtfPage,RtfPageArea,RtfPageNumber,RtfPageNumberCitation,RtfParagraphKeepTogether,RtfSection,RtfTable,RtfTableCell,RtfTableRow,RtfTextrun
public class RtfContainer extends RtfElement
An RtfElement that can contain other elements.
This work was authored by Bertrand Delacretaz (bdelacretaz@codeconsult.ch).
-
-
Field Summary
-
Fields inherited from class org.apache.fop.render.rtf.rtflib.rtfdoc.RtfElement
attrib, parent, writer
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected voidaddChild(RtfElement e)add a child element to thisintfindChildren(RtfElement aChild)Find the passed child in the current containerintgetChildCount()java.util.ListgetChildren()booleanisEmpty()protected booleanokToWriteRtf()can be overridden to suppress all RTF outputbooleansetChildren(java.util.List list)Add by Boris Poudérous on 07/22/2002 Set the children listvoidsetOptions(RtfOptions opt)set optionsjava.lang.StringtoString()minimal debugging displayprotected voidwriteRtfContent()write RTF code of all our children-
Methods inherited from class org.apache.fop.render.rtf.rtflib.rtfdoc.RtfElement
close, getParentOfClass, getRtfAttributes, newLine, writeAttributes, writeControlWord, writeControlWordNS, writeExceptionInRtf, writeGroupMark, writeOneAttribute, writeOneAttributeNS, writeRtf, writeRtfPrefix, writeRtfSuffix, writeStarControlWord, writeStarControlWordNS
-
-
-
-
Method Detail
-
setOptions
public void setOptions(RtfOptions opt)
set options- Parameters:
opt- options to set
-
addChild
protected void addChild(RtfElement e) throws RtfStructureException
add a child element to this- Parameters:
e- child element to add- Throws:
RtfStructureException- for trying to add an invalid child (??)
-
getChildren
public java.util.List getChildren()
- Returns:
- a copy of our children's list
-
getChildCount
public int getChildCount()
- Returns:
- the number of children
-
findChildren
public int findChildren(RtfElement aChild)
Find the passed child in the current container- Parameters:
aChild- the child element- Returns:
- the depth (nested level) inside the current container
-
setChildren
public boolean setChildren(java.util.List list)
Add by Boris Poudérous on 07/22/2002 Set the children list- Parameters:
list- list of child objects- Returns:
- true if process succeeded
-
writeRtfContent
protected void writeRtfContent() throws java.io.IOExceptionwrite RTF code of all our children- Specified by:
writeRtfContentin classRtfElement- Throws:
java.io.IOException- for I/O problems
-
toString
public java.lang.String toString()
minimal debugging display- Overrides:
toStringin classRtfElement- Returns:
- String representation of object contents
-
okToWriteRtf
protected boolean okToWriteRtf()
Description copied from class:RtfElementcan be overridden to suppress all RTF output- Overrides:
okToWriteRtfin classRtfElement- Returns:
- false if empty or if our options block writing
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmptyin classRtfElement- Returns:
- true if this element would generate no "useful" RTF content, i.e. (for RtfContainer) true if it has no children where isEmpty() is false
-
-