com.lowagie.text.rtf.graphic

Class RtfImage

java.lang.Object

com.lowagie.text.rtf.RtfElement

com.lowagie.text.rtf.graphic.RtfImage

All Implemented Interfaces:

RtfBasicElement, RtfElementInterface

public class RtfImage
extends RtfElement

The RtfImage contains one image. Supported image types are jpeg, png, wmf, bmp.

Version:

$Id: RtfImage.java 4065 2009-09-16 23:09:11Z psoares33 $

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
static byte[]	byte2charLUT lookup table used for converting bytes to hex chars.

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

Constructors

Constructor and Description
RtfImage(RtfDocument doc, Image image) Constructs a RtfImage for an Image.

Method Summary

Methods

Modifier and Type	Method and Description
void	setAlignment(int alignment) Sets the alignment of this RtfImage.
void	setTopLevelElement(boolean topLevelElement) Set whether this RtfImage should behave like a top level element and enclose itself in a paragraph.
void	writeContent(OutputStream result) Writes the RtfImage content

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

intToByteArray, isInTable, setInHeader, setInTable, setRtfDocument

Methods inherited from class java.lang.Object

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

Field Detail

byte2charLUT

public static final byte[] byte2charLUT

lookup table used for converting bytes to hex chars. TODO Should probably be refactored into a helper class

Constructor Detail

RtfImage

public RtfImage(RtfDocument doc,
        Image image)
         throws DocumentException

Constructs a RtfImage for an Image.

Parameters:

doc - The RtfDocument this RtfImage belongs to

image - The Image that this RtfImage wraps

Throws:

DocumentException - If an error occurred accessing the image content

Method Detail

writeContent

public void writeContent(OutputStream result)
                  throws IOException

Writes the RtfImage content

Specified by:

writeContent in interface RtfBasicElement

Specified by:

writeContent in class RtfElement

Parameters:

result - The OutputStream to write the content to

Throws:

IOException

setAlignment

public void setAlignment(int alignment)

Sets the alignment of this RtfImage. Uses the alignments from com.lowagie.text.Element.

Parameters:

alignment - The alignment to use.

setTopLevelElement

public void setTopLevelElement(boolean topLevelElement)

Set whether this RtfImage should behave like a top level element and enclose itself in a paragraph.

Parameters:

topLevelElement - Whether to behave like a top level element.