com.lowagie.text.rtf

Interface RtfBasicElement

public interface RtfBasicElement

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

Version: $Id: RtfBasicElement.java 2808 2007-05-30 10:58:16Z psoares33 $

Author: Mark Hall (mhall@edu.uni-klu.ac.at) 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 measurments
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
byte[]write()
Return the content of the Element in a byte array
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 measurments

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 RtfDocument to use

write

public byte[] write()

Deprecated: replaced by writeContent

Return the content of the Element in a byte array

Returns: The byte array containing the data

writeContent

public void writeContent(OutputStream out)
Writes the element content to the given output stream. This method replaces the write method which is now deprecated.

Parameters: out