com.lowagie.text.rtf

Interface RtfBasicElement

public interface RtfBasicElement extends RtfElementInterface

The RtfBasicElement interface defines the interface for elements that can be added to the RtfWriter.

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

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

Field Summary
static byte[]CLOSE_GROUP
Constant for the end of an rtf group
static byte[]COMMA_DELIMITER
Constant for a comma delimiter in rtf
static byte[]DELIMITER
Constant for a delimiter in rtf
static byte[]OPEN_GROUP
Constant for the beginning of a rtf group
static doubleTWIPS_FACTOR
The factor to use for translating from iText to rtf measurements
Method Summary
voidsetInHeader(boolean inHeader)
Sets whether this RtfBasicElement is in a header
voidsetInTable(boolean inTable)
Sets whether this RtfBasicElement is in a table
voidsetRtfDocument(RtfDocument doc)
Sets the RtfDocument this RtfElement belongs to
voidwriteContent(OutputStream out)
Writes the element content to the given output stream.

Field Detail

CLOSE_GROUP

public static final byte[] CLOSE_GROUP
Constant for the end of an rtf group

COMMA_DELIMITER

public static final byte[] COMMA_DELIMITER
Constant for a comma delimiter in rtf

DELIMITER

public static final byte[] DELIMITER
Constant for a delimiter in rtf

OPEN_GROUP

public static final byte[] OPEN_GROUP
Constant for the beginning of a rtf group

TWIPS_FACTOR

public static final double TWIPS_FACTOR
The factor to use for translating from iText to rtf measurements

Method Detail

setInHeader

public void setInHeader(boolean inHeader)
Sets whether this RtfBasicElement is in a header

Parameters: inHeader Whether this RtfBasicElement is in a header

setInTable

public void setInTable(boolean inTable)
Sets whether this RtfBasicElement is in a table

Parameters: inTable Whether this RtfBasicElement is in a table

setRtfDocument

public void setRtfDocument(RtfDocument doc)
Sets the RtfDocument this RtfElement belongs to

Parameters: doc The @link{com.lowagie.text.rtf.document.RtfDocument} this RtfElement belongs to

writeContent

public void writeContent(OutputStream out)
Writes the element content to the given output stream.

Parameters: out The OutputStream to write the content to