com.lowagie.text.rtf.text

Class RtfSection

public class RtfSection extends RtfElement

The RtfSection wraps a Section element. INTERNAL CLASS

Version: $Id: RtfSection.java 2776 2007-05-23 20:01:40Z hallm $

Author: Mark Hall (mhall@edu.uni-klu.ac.at) Thomas Bickel (tmb99@inode.at)

Field Summary
protected ArrayListitems
The sub-items of this RtfSection
protected RtfParagraphtitle
The title paragraph of this RtfSection
Constructor Summary
RtfSection(RtfDocument doc, Section section)
Constructs a RtfSection for a given Section.
Method Summary
voidsetInHeader(boolean inHeader)
Sets whether this RtfSection is in a header.
voidsetInTable(boolean inTable)
Sets whether this RtfSection is in a table.
voidupdateIndentation(float indentLeft, float indentRight, float indentContent)
Updates the left, right and content indentation of all RtfParagraph and RtfSection elements that this RtfSection contains.
byte[]write()
Write this RtfSection and its contents
voidwriteContent(OutputStream result)
Write this RtfSection and its contents

Field Detail

items

protected ArrayList items
The sub-items of this RtfSection

title

protected RtfParagraph title
The title paragraph of this RtfSection

Constructor Detail

RtfSection

public RtfSection(RtfDocument doc, Section section)
Constructs a RtfSection for a given Section. If the autogenerateTOCEntries property of the RtfDocument is set and the title is not empty then a TOC entry is generated for the title.

Parameters: doc The RtfDocument this RtfSection belongs to section The Section this RtfSection is based on

Method Detail

setInHeader

public void setInHeader(boolean inHeader)
Sets whether this RtfSection is in a header. Sets the correct inTable setting for all child elements.

Parameters: inHeader True if this RtfSection is in a header, false otherwise

setInTable

public void setInTable(boolean inTable)
Sets whether this RtfSection is in a table. Sets the correct inTable setting for all child elements.

Parameters: inTable True if this RtfSection is in a table, false otherwise

updateIndentation

private void updateIndentation(float indentLeft, float indentRight, float indentContent)
Updates the left, right and content indentation of all RtfParagraph and RtfSection elements that this RtfSection contains.

Parameters: indentLeft The left indentation to add. indentRight The right indentation to add. indentContent The content indentation to add.

write

public byte[] write()

Deprecated: replaced by writeContent

Write this RtfSection and its contents

Returns: A byte array with the RtfSection and its contents

writeContent

public void writeContent(OutputStream result)
Write this RtfSection and its contents