org.apache.maven.doxia.module.rtf
Class RtfSink

java.lang.Object
  org.apache.maven.doxia.sink.SinkAdapter
      org.apache.maven.doxia.module.rtf.RtfSink

All Implemented Interfaces:

Sink

public class RtfSink

extends SinkAdapter

Plexus component:

role:

"org.apache.maven.doxia.sink.Sink"

role-hint:

"rtf"

Field Summary

static double	DEFAULT_BOTTOM_MARGIN
static int	DEFAULT_CHAR_SET
static int	DEFAULT_CODE_PAGE
static String	DEFAULT_DATA_FORMAT
static int	DEFAULT_FONT_SIZE
static String	DEFAULT_IMAGE_FORMAT
static String	DEFAULT_IMAGE_TYPE
static double	DEFAULT_LEFT_MARGIN
static double	DEFAULT_PAPER_HEIGHT
static double	DEFAULT_PAPER_WIDTH
static int	DEFAULT_RESOLUTION
static double	DEFAULT_RIGHT_MARGIN
static int	DEFAULT_SPACING
static double	DEFAULT_TOP_MARGIN
static String	IMG_DATA_ASCII
static String	IMG_DATA_RAW
static String	IMG_FORMAT_BMP
static String	IMG_FORMAT_WMF
static String	IMG_TYPE_PALETTE
static String	IMG_TYPE_RGB
protected OutputStream	stream
static int	STYLE_BOLD
static int	STYLE_ITALIC
static int	STYLE_ROMAN
static int	STYLE_TYPEWRITER
protected PrintWriter	writer

Fields inherited from interface org.apache.maven.doxia.sink.Sink

NUMBERING_DECIMAL, NUMBERING_LOWER_ALPHA, NUMBERING_LOWER_ROMAN, NUMBERING_UPPER_ALPHA, NUMBERING_UPPER_ROMAN, ROLE, SECTION_LEVEL_1, SECTION_LEVEL_2, SECTION_LEVEL_3, SECTION_LEVEL_4, SECTION_LEVEL_5

Constructor Summary

RtfSink()

RtfSink(OutputStream output)

RtfSink(OutputStream output, String encoding)

Method Summary

void	anchor_()
void	anchor(String name)
void	author_()
void	author()
void	body_()
void	body()
void	bold_()
void	bold()
void	close()
void	date_()
void	date()
void	definedTerm_()
void	definedTerm()
void	definition_()
void	definition()
void	definitionList_()
void	definitionList()
void	definitionListItem_()
void	definitionListItem()
void	figure_()
void	figure()
void	figureCaption_()
void	figureCaption()
void	figureGraphics(String name)
void	flush()
void	head_()
void	head()
void	horizontalRule()
void	italic_()
void	italic()
void	lineBreak()
void	link_()
void	link(String name)
void	list_()
void	list()
void	listItem_()
void	listItem()
void	monospaced_()
void	monospaced()
void	nonBreakingSpace()
void	numberedList_()
void	numberedList(int numbering)
void	numberedListItem_()
void	numberedListItem()
void	pageBreak()
void	paragraph_()
void	paragraph()
void	section1_()
void	section1()
void	section2_()
void	section2()
void	section3_()
void	section3()
void	section4_()
void	section4()
void	section5_()
void	section5()
void	sectionTitle_()
void	sectionTitle()
void	setBottomMargin(double margin)
void	setCharSet(int cs)
void	setCodePage(int cp)
void	setFontSize(int size)
void	setImageCompression(boolean compression)
void	setImageDataFormat(String format)
void	setImageFormat(String format)
void	setImageType(String type)
void	setLeftMargin(double margin)
void	setPaperSize(double width, double height)
void	setResolution(int resolution)
void	setRightMargin(double margin)
void	setSpacing(int spacing)
void	setTopMargin(double margin)
void	table_()
void	table()
void	tableCaption_()
void	tableCaption()
void	tableCell_()
void	tableCell()
void	tableHeaderCell_()
void	tableHeaderCell()
void	tableRow_()
void	tableRow()
void	tableRows_()
void	tableRows(int[] justification, boolean grid)
void	text(String text)
void	title_()
void	title()
void	verbatim_()
void	verbatim(boolean boxed)

Methods inherited from class org.apache.maven.doxia.sink.SinkAdapter

rawText, sectionTitle1_, sectionTitle1, sectionTitle2_, sectionTitle2, sectionTitle3_, sectionTitle3, sectionTitle4_, sectionTitle4, sectionTitle5_, sectionTitle5, tableCell, tableHeaderCell

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PAPER_WIDTH

public static final double DEFAULT_PAPER_WIDTH

See Also:

Constant Field Values

DEFAULT_PAPER_HEIGHT

public static final double DEFAULT_PAPER_HEIGHT

See Also:

Constant Field Values

DEFAULT_TOP_MARGIN

public static final double DEFAULT_TOP_MARGIN

See Also:

Constant Field Values

DEFAULT_BOTTOM_MARGIN

public static final double DEFAULT_BOTTOM_MARGIN

See Also:

Constant Field Values

DEFAULT_LEFT_MARGIN

public static final double DEFAULT_LEFT_MARGIN

See Also:

Constant Field Values

DEFAULT_RIGHT_MARGIN

public static final double DEFAULT_RIGHT_MARGIN

See Also:

Constant Field Values

DEFAULT_FONT_SIZE

public static final int DEFAULT_FONT_SIZE

See Also:

Constant Field Values

DEFAULT_SPACING

public static final int DEFAULT_SPACING

See Also:

Constant Field Values

DEFAULT_RESOLUTION

public static final int DEFAULT_RESOLUTION

See Also:

Constant Field Values

DEFAULT_IMAGE_FORMAT

public static final String DEFAULT_IMAGE_FORMAT

See Also:

Constant Field Values

DEFAULT_IMAGE_TYPE

public static final String DEFAULT_IMAGE_TYPE

See Also:

Constant Field Values

DEFAULT_DATA_FORMAT

public static final String DEFAULT_DATA_FORMAT

See Also:

Constant Field Values

DEFAULT_CODE_PAGE

public static final int DEFAULT_CODE_PAGE

See Also:

Constant Field Values

DEFAULT_CHAR_SET

public static final int DEFAULT_CHAR_SET

See Also:

Constant Field Values

IMG_FORMAT_BMP

public static final String IMG_FORMAT_BMP

See Also:

Constant Field Values

IMG_FORMAT_WMF

public static final String IMG_FORMAT_WMF

See Also:

Constant Field Values

IMG_TYPE_PALETTE

public static final String IMG_TYPE_PALETTE

See Also:

Constant Field Values

IMG_TYPE_RGB

public static final String IMG_TYPE_RGB

See Also:

Constant Field Values

IMG_DATA_ASCII

public static final String IMG_DATA_ASCII

See Also:

Constant Field Values

IMG_DATA_RAW

public static final String IMG_DATA_RAW

See Also:

Constant Field Values

STYLE_ROMAN

public static final int STYLE_ROMAN

See Also:

Constant Field Values

STYLE_ITALIC

public static final int STYLE_ITALIC

See Also:

Constant Field Values

STYLE_BOLD

public static final int STYLE_BOLD

See Also:

Constant Field Values

STYLE_TYPEWRITER

public static final int STYLE_TYPEWRITER

See Also:

Constant Field Values

writer

protected PrintWriter writer

stream

protected OutputStream stream

Constructor Detail

RtfSink

public RtfSink()
        throws IOException

RtfSink

public RtfSink(OutputStream output)
        throws IOException

RtfSink

public RtfSink(OutputStream output,
               String encoding)
        throws IOException

Method Detail

setPaperSize

public void setPaperSize(double width,
                         double height)

setTopMargin

public void setTopMargin(double margin)

setBottomMargin

public void setBottomMargin(double margin)

setLeftMargin

public void setLeftMargin(double margin)

setRightMargin

public void setRightMargin(double margin)

setFontSize

public void setFontSize(int size)

setSpacing

public void setSpacing(int spacing)

setResolution

public void setResolution(int resolution)

setImageFormat

public void setImageFormat(String format)

setImageType

public void setImageType(String type)

setImageDataFormat

public void setImageDataFormat(String format)

setImageCompression

public void setImageCompression(boolean compression)

setCodePage

public void setCodePage(int cp)

setCharSet

public void setCharSet(int cs)

head

public void head()

head_

public void head_()

title

public void title()

title_

public void title_()

author

public void author()

author_

public void author_()

date

public void date()

date_

public void date_()

body

public void body()

body_

public void body_()

section1

public void section1()

section1_

public void section1_()

section2

public void section2()

section2_

public void section2_()

section3

public void section3()

section3_

public void section3_()

section4

public void section4()

section4_

public void section4_()

section5

public void section5()

section5_

public void section5_()

sectionTitle

public void sectionTitle()

sectionTitle_

public void sectionTitle_()

list

public void list()

list_

public void list_()

listItem

public void listItem()

listItem_

public void listItem_()

numberedList

public void numberedList(int numbering)

numberedList_

public void numberedList_()

numberedListItem

public void numberedListItem()

numberedListItem_

public void numberedListItem_()

definitionList

public void definitionList()

definitionList_

public void definitionList_()

definitionListItem

public void definitionListItem()

definitionListItem_

public void definitionListItem_()

definedTerm

public void definedTerm()

definedTerm_

public void definedTerm_()

definition

public void definition()

definition_

public void definition_()

table

public void table()

table_

public void table_()

tableRows

public void tableRows(int[] justification,
                      boolean grid)

tableRows_

public void tableRows_()

tableRow

public void tableRow()

tableRow_

public void tableRow_()

tableHeaderCell

public void tableHeaderCell()

tableHeaderCell_

public void tableHeaderCell_()

tableCell

public void tableCell()

tableCell_

public void tableCell_()

tableCaption

public void tableCaption()

tableCaption_

public void tableCaption_()

paragraph

public void paragraph()

paragraph_

public void paragraph_()

verbatim

public void verbatim(boolean boxed)

verbatim_

public void verbatim_()

figure

public void figure()

figure_

public void figure_()

figureGraphics

public void figureGraphics(String name)

figureCaption

public void figureCaption()

figureCaption_

public void figureCaption_()

horizontalRule

public void horizontalRule()

pageBreak

public void pageBreak()

anchor

public void anchor(String name)

anchor_

public void anchor_()

link

public void link(String name)

link_

public void link_()

italic

public void italic()

italic_

public void italic_()

bold

public void bold()

bold_

public void bold_()

monospaced

public void monospaced()

monospaced_

public void monospaced_()

lineBreak

public void lineBreak()

nonBreakingSpace

public void nonBreakingSpace()

text

public void text(String text)

flush

public void flush()

close

public void close()