Class RtfSection

java.lang.Object

com.lowagie.text.rtf.RtfElement

com.lowagie.text.rtf.text.RtfSection

All Implemented Interfaces:

RtfBasicElement

Direct Known Subclasses:

RtfChapter

public class RtfSection
extends RtfElement

The RtfSection wraps a Section element. INTERNAL CLASS

Version:

$Id: RtfSection.java 3373 2008-05-12 16:21:24Z xlv $

Field Summary

Fields

Modifier and Type	Field	Description
protected final ArrayList<RtfBasicElement>	items	The sub-items of this RtfSection
protected RtfParagraph	title	The title paragraph of this RtfSection

Fields inherited from class RtfElement

document, inHeader, inTable

Fields inherited from interface RtfBasicElement

CLOSE_GROUP, COMMA_DELIMITER, DELIMITER, OPEN_GROUP, TWIPS_FACTOR

Constructor Summary

Constructors

Constructor	Description
RtfSection(RtfDocument doc, com.lowagie.text.Section section)	Constructs a RtfSection for a given Section.

Method Summary

Modifier and Type	Method	Description
void	setInHeader(boolean inHeader)	Sets whether this RtfSection is in a header.
void	setInTable(boolean inTable)	Sets whether this RtfSection is in a table.
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.
void	writeContent(OutputStream result)	Write this RtfSection and its contents

Methods inherited from class RtfElement

intToByteArray, isInTable, setRtfDocument

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

title

protected RtfParagraph title

The title paragraph of this RtfSection

items

protected final ArrayList<RtfBasicElement> items

The sub-items of this RtfSection

Constructor Details

RtfSection

public RtfSection(RtfDocument doc,
 com.lowagie.text.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 Details

writeContent

public void writeContent(OutputStream result)
                  throws IOException

Write this RtfSection and its contents

Specified by:

writeContent in interface RtfBasicElement

Specified by:

writeContent in class RtfElement

Parameters:

result - The OutputStream to write the content to

Throws:

IOException

setInTable

public void setInTable(boolean inTable)

Sets whether this RtfSection is in a table. Sets the correct inTable setting for all child elements.

Specified by:

setInTable in interface RtfBasicElement

Overrides:

setInTable in class RtfElement

Parameters:

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

setInHeader

public void setInHeader(boolean inHeader)

Sets whether this RtfSection is in a header. Sets the correct inTable setting for all child elements.

Specified by:

setInHeader in interface RtfBasicElement

Overrides:

setInHeader in class RtfElement

Parameters:

inHeader - True if this RtfSection is in a header, 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.