com.lowagie.text.rtf.text
Class RtfParagraph

java.lang.Object
  com.lowagie.text.rtf.RtfElement
      com.lowagie.text.rtf.text.RtfPhrase
          com.lowagie.text.rtf.text.RtfParagraph

All Implemented Interfaces:

RtfBasicElement, RtfElementInterface

Direct Known Subclasses:

RtfListItem

public class RtfParagraph
extends RtfPhrase

The RtfParagraph is an extension of the RtfPhrase that adds alignment and indentation properties. It wraps a Paragraph.

Version:

$Id: RtfParagraph.java 3670 2009-02-01 09:13:48Z blowagie $

Author:

Mark Hall (Mark.Hall@mail.room3b.eu), Thomas Bickel (tmb99@inode.at)

Field Summary

static byte[]	PARAGRAPH Constant for the end of a paragraph
protected RtfParagraphStyle	paragraphStyle An optional RtfParagraphStyle to use for styling.

Fields inherited from class com.lowagie.text.rtf.text.RtfPhrase

chunks, IN_TABLE, LINE_SPACING, PARAGRAPH_DEFAULTS, PLAIN

Fields inherited from class com.lowagie.text.rtf.RtfElement

document, inHeader, inTable

Fields inherited from interface com.lowagie.text.rtf.RtfBasicElement

CLOSE_GROUP, COMMA_DELIMITER, DELIMITER, OPEN_GROUP, TWIPS_FACTOR

Constructor Summary

RtfParagraph(RtfDocument doc, Paragraph paragraph)
Constructs a RtfParagraph belonging to a RtfDocument based on a Paragraph.

Method Summary

int	getIndentLeft() Gets the left indentation of this RtfParagraph.
int	getIndentRight() Gets the right indentation of this RtfParagraph.
void	setIndentLeft(int indentLeft) Sets the left indentation of this RtfParagraph.
void	setIndentRight(int indentRight) Sets the right indentation of this RtfParagraph.
void	setKeepTogetherWithNext(boolean keepTogetherWithNext) Set whether this RtfParagraph must stay on the same page as the next one.
void	writeContent(java.io.OutputStream result) Writes the content of this RtfParagraph.

Methods inherited from class com.lowagie.text.rtf.text.RtfPhrase

setInHeader, setInTable, setRtfDocument

Methods inherited from class com.lowagie.text.rtf.RtfElement

intToByteArray, isInTable

Methods inherited from class java.lang.Object

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

Field Detail

PARAGRAPH

public static final byte[] PARAGRAPH

Constant for the end of a paragraph

paragraphStyle

protected RtfParagraphStyle paragraphStyle

An optional RtfParagraphStyle to use for styling.

Constructor Detail

RtfParagraph

public RtfParagraph(RtfDocument doc,
                    Paragraph paragraph)

Constructs a RtfParagraph belonging to a RtfDocument based on a Paragraph.

Parameters:

doc - The RtfDocument this RtfParagraph belongs to

paragraph - The Paragraph that this RtfParagraph is based on

Method Detail

setKeepTogetherWithNext

public void setKeepTogetherWithNext(boolean keepTogetherWithNext)

Set whether this RtfParagraph must stay on the same page as the next one.

Parameters:

keepTogetherWithNext - Whether this RtfParagraph must keep together with the next.

writeContent

public void writeContent(java.io.OutputStream result)
                  throws java.io.IOException

Writes the content of this RtfParagraph. First paragraph specific data is written and then the RtfChunks of this RtfParagraph are added.

Specified by:

writeContent in interface RtfBasicElement

Overrides:

writeContent in class RtfPhrase

Parameters:

result - The OutputStream to write the content to

Throws:

java.io.IOException

getIndentLeft

public int getIndentLeft()

Gets the left indentation of this RtfParagraph.

Returns:

The left indentation.

setIndentLeft

public void setIndentLeft(int indentLeft)

Sets the left indentation of this RtfParagraph.

Parameters:

indentLeft - The left indentation to use.

getIndentRight

public int getIndentRight()

Gets the right indentation of this RtfParagraph.

Returns:

The right indentation.

setIndentRight

public void setIndentRight(int indentRight)

Sets the right indentation of this RtfParagraph.

Parameters:

indentRight - The right indentation to use.