org.apache.maven.doxia.module.rtf

Class RtfSink

Implemented Interfaces:
Sink

public class RtfSink
extends SinkAdapter

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
static int
STYLE_BOLD
static int
STYLE_ITALIC
static int
STYLE_ROMAN
static int
STYLE_TYPEWRITER
protected OutputStream
stream
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

Constructor Summary

RtfSink()
RtfSink(OutputStream output)
RtfSink(OutputStream output, String encoding)

Method Summary

void
anchor(String name)
void
anchor_()
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
definitionList()
void
definitionListItem()
void
definitionListItem_()
void
definitionList_()
void
definition_()
void
figure()
void
figureCaption()
void
figureCaption_()
void
figureGraphics(String name)
void
figure_()
void
flush()
void
head()
void
head_()
void
horizontalRule()
void
italic()
void
italic_()
void
lineBreak()
void
link(String name)
void
link_()
void
list()
void
listItem()
void
listItem_()
void
list_()
void
monospaced()
void
monospaced_()
void
nonBreakingSpace()
void
numberedList(int numbering)
void
numberedListItem()
void
numberedListItem_()
void
numberedList_()
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
tableCaption()
void
tableCaption_()
void
tableCell()
void
tableCell_()
void
tableRow()
void
tableRow_()
void
tableRows(int[] justification, boolean grid)
void
tableRows_()
void
table_()
void
text(String text)
void
title()
void
title_()
void
verbatim(boolean boxed)
void
verbatim_()

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

anchor, anchor_, author, author_, body, body_, bold, bold_, close, date, date_, definedTerm, definedTerm_, definition, definitionList, definitionListItem, definitionListItem_, definitionList_, definition_, figure, figureCaption, figureCaption_, figureGraphics, figure_, flush, head, head_, horizontalRule, italic, italic_, lineBreak, link, link_, list, listItem, listItem_, list_, monospaced, monospaced_, nonBreakingSpace, numberedList, numberedListItem, numberedListItem_, numberedList_, pageBreak, paragraph, paragraph_, rawText, section1, section1_, section2, section2_, section3, section3_, section4, section4_, section5, section5_, sectionTitle, sectionTitle1, sectionTitle1_, sectionTitle2, sectionTitle2_, sectionTitle3, sectionTitle3_, sectionTitle4, sectionTitle4_, sectionTitle5, sectionTitle5_, sectionTitle_, table, tableCaption, tableCaption_, tableCell, tableCell, tableCell_, tableHeaderCell, tableHeaderCell, tableHeaderCell_, tableRow, tableRow_, tableRows, tableRows_, table_, text, title, title_, verbatim, verbatim_

Field Details

DEFAULT_BOTTOM_MARGIN

public static final double DEFAULT_BOTTOM_MARGIN
Field Value:
2.0

DEFAULT_CHAR_SET

public static final int DEFAULT_CHAR_SET
Field Value:
0

DEFAULT_CODE_PAGE

public static final int DEFAULT_CODE_PAGE
Field Value:
1252

DEFAULT_DATA_FORMAT

public static final String DEFAULT_DATA_FORMAT

DEFAULT_FONT_SIZE

public static final int DEFAULT_FONT_SIZE
Field Value:
10

DEFAULT_IMAGE_FORMAT

public static final String DEFAULT_IMAGE_FORMAT

DEFAULT_IMAGE_TYPE

public static final String DEFAULT_IMAGE_TYPE

DEFAULT_LEFT_MARGIN

public static final double DEFAULT_LEFT_MARGIN
Field Value:
2.0

DEFAULT_PAPER_HEIGHT

public static final double DEFAULT_PAPER_HEIGHT
Field Value:
29.0

DEFAULT_PAPER_WIDTH

public static final double DEFAULT_PAPER_WIDTH
Field Value:
21.0

DEFAULT_RESOLUTION

public static final int DEFAULT_RESOLUTION
Field Value:
72

DEFAULT_RIGHT_MARGIN

public static final double DEFAULT_RIGHT_MARGIN
Field Value:
2.0

DEFAULT_SPACING

public static final int DEFAULT_SPACING
Field Value:
10

DEFAULT_TOP_MARGIN

public static final double DEFAULT_TOP_MARGIN
Field Value:
2.0

IMG_DATA_ASCII

public static final String IMG_DATA_ASCII

IMG_DATA_RAW

public static final String IMG_DATA_RAW

IMG_FORMAT_BMP

public static final String IMG_FORMAT_BMP

IMG_FORMAT_WMF

public static final String IMG_FORMAT_WMF

IMG_TYPE_PALETTE

public static final String IMG_TYPE_PALETTE

IMG_TYPE_RGB

public static final String IMG_TYPE_RGB

STYLE_BOLD

public static final int STYLE_BOLD
Field Value:
2

STYLE_ITALIC

public static final int STYLE_ITALIC
Field Value:
1

STYLE_ROMAN

public static final int STYLE_ROMAN
Field Value:
0

STYLE_TYPEWRITER

public static final int STYLE_TYPEWRITER
Field Value:
3

stream

protected OutputStream stream

writer

protected PrintWriter writer

Constructor Details

RtfSink

public RtfSink()
            throws IOException

RtfSink

public RtfSink(OutputStream output)
            throws IOException

RtfSink

public RtfSink(OutputStream output,
               String encoding)
            throws IOException

Method Details

anchor

public void anchor(String name)
Specified by:
anchor in interface Sink
Overrides:
anchor in interface SinkAdapter

anchor_

public void anchor_()
Specified by:
anchor_ in interface Sink
Overrides:
anchor_ in interface SinkAdapter

author

public void author()
Specified by:
author in interface Sink
Overrides:
author in interface SinkAdapter

author_

public void author_()
Specified by:
author_ in interface Sink
Overrides:
author_ in interface SinkAdapter

body

public void body()
Specified by:
body in interface Sink
Overrides:
body in interface SinkAdapter

body_

public void body_()
Specified by:
body_ in interface Sink
Overrides:
body_ in interface SinkAdapter

bold

public void bold()
Specified by:
bold in interface Sink
Overrides:
bold in interface SinkAdapter

bold_

public void bold_()
Specified by:
bold_ in interface Sink
Overrides:
bold_ in interface SinkAdapter

close

public void close()
Specified by:
close in interface Sink
Overrides:
close in interface SinkAdapter

date

public void date()
Specified by:
date in interface Sink
Overrides:
date in interface SinkAdapter

date_

public void date_()
Specified by:
date_ in interface Sink
Overrides:
date_ in interface SinkAdapter

definedTerm

public void definedTerm()
Specified by:
definedTerm in interface Sink
Overrides:
definedTerm in interface SinkAdapter

definedTerm_

public void definedTerm_()
Specified by:
definedTerm_ in interface Sink
Overrides:
definedTerm_ in interface SinkAdapter

definition

public void definition()
Specified by:
definition in interface Sink
Overrides:
definition in interface SinkAdapter

definitionList

public void definitionList()
Specified by:
definitionList in interface Sink
Overrides:
definitionList in interface SinkAdapter

definitionListItem

public void definitionListItem()
Specified by:
definitionListItem in interface Sink
Overrides:
definitionListItem in interface SinkAdapter

definitionListItem_

public void definitionListItem_()
Specified by:
definitionListItem_ in interface Sink
Overrides:
definitionListItem_ in interface SinkAdapter

definitionList_

public void definitionList_()
Specified by:
definitionList_ in interface Sink
Overrides:
definitionList_ in interface SinkAdapter

definition_

public void definition_()
Specified by:
definition_ in interface Sink
Overrides:
definition_ in interface SinkAdapter

figure

public void figure()
Specified by:
figure in interface Sink
Overrides:
figure in interface SinkAdapter

figureCaption

public void figureCaption()
Specified by:
figureCaption in interface Sink
Overrides:
figureCaption in interface SinkAdapter

figureCaption_

public void figureCaption_()
Specified by:
figureCaption_ in interface Sink
Overrides:
figureCaption_ in interface SinkAdapter

figureGraphics

public void figureGraphics(String name)
Specified by:
figureGraphics in interface Sink
Overrides:
figureGraphics in interface SinkAdapter

figure_

public void figure_()
Specified by:
figure_ in interface Sink
Overrides:
figure_ in interface SinkAdapter

flush

public void flush()
Specified by:
flush in interface Sink
Overrides:
flush in interface SinkAdapter

head

public void head()
Specified by:
head in interface Sink
Overrides:
head in interface SinkAdapter

head_

public void head_()
Specified by:
head_ in interface Sink
Overrides:
head_ in interface SinkAdapter

horizontalRule

public void horizontalRule()
Specified by:
horizontalRule in interface Sink
Overrides:
horizontalRule in interface SinkAdapter

italic

public void italic()
Specified by:
italic in interface Sink
Overrides:
italic in interface SinkAdapter

italic_

public void italic_()
Specified by:
italic_ in interface Sink
Overrides:
italic_ in interface SinkAdapter

lineBreak

public void lineBreak()
Specified by:
lineBreak in interface Sink
Overrides:
lineBreak in interface SinkAdapter

link

public void link(String name)
Specified by:
link in interface Sink
Overrides:
link in interface SinkAdapter

link_

public void link_()
Specified by:
link_ in interface Sink
Overrides:
link_ in interface SinkAdapter

list

public void list()
Specified by:
list in interface Sink
Overrides:
list in interface SinkAdapter

listItem

public void listItem()
Specified by:
listItem in interface Sink
Overrides:
listItem in interface SinkAdapter

listItem_

public void listItem_()
Specified by:
listItem_ in interface Sink
Overrides:
listItem_ in interface SinkAdapter

list_

public void list_()
Specified by:
list_ in interface Sink
Overrides:
list_ in interface SinkAdapter

monospaced

public void monospaced()
Specified by:
monospaced in interface Sink
Overrides:
monospaced in interface SinkAdapter

monospaced_

public void monospaced_()
Specified by:
monospaced_ in interface Sink
Overrides:
monospaced_ in interface SinkAdapter

nonBreakingSpace

public void nonBreakingSpace()
Specified by:
nonBreakingSpace in interface Sink
Overrides:
nonBreakingSpace in interface SinkAdapter

numberedList

public void numberedList(int numbering)
Specified by:
numberedList in interface Sink
Overrides:
numberedList in interface SinkAdapter

numberedListItem

public void numberedListItem()
Specified by:
numberedListItem in interface Sink
Overrides:
numberedListItem in interface SinkAdapter

numberedListItem_

public void numberedListItem_()
Specified by:
numberedListItem_ in interface Sink
Overrides:
numberedListItem_ in interface SinkAdapter

numberedList_

public void numberedList_()
Specified by:
numberedList_ in interface Sink
Overrides:
numberedList_ in interface SinkAdapter

pageBreak

public void pageBreak()
Specified by:
pageBreak in interface Sink
Overrides:
pageBreak in interface SinkAdapter

paragraph

public void paragraph()
Specified by:
paragraph in interface Sink
Overrides:
paragraph in interface SinkAdapter

paragraph_

public void paragraph_()
Specified by:
paragraph_ in interface Sink
Overrides:
paragraph_ in interface SinkAdapter

section1

public void section1()
Specified by:
section1 in interface Sink
Overrides:
section1 in interface SinkAdapter

section1_

public void section1_()
Specified by:
section1_ in interface Sink
Overrides:
section1_ in interface SinkAdapter

section2

public void section2()
Specified by:
section2 in interface Sink
Overrides:
section2 in interface SinkAdapter

section2_

public void section2_()
Specified by:
section2_ in interface Sink
Overrides:
section2_ in interface SinkAdapter

section3

public void section3()
Specified by:
section3 in interface Sink
Overrides:
section3 in interface SinkAdapter

section3_

public void section3_()
Specified by:
section3_ in interface Sink
Overrides:
section3_ in interface SinkAdapter

section4

public void section4()
Specified by:
section4 in interface Sink
Overrides:
section4 in interface SinkAdapter

section4_

public void section4_()
Specified by:
section4_ in interface Sink
Overrides:
section4_ in interface SinkAdapter

section5

public void section5()
Specified by:
section5 in interface Sink
Overrides:
section5 in interface SinkAdapter

section5_

public void section5_()
Specified by:
section5_ in interface Sink
Overrides:
section5_ in interface SinkAdapter

sectionTitle

public void sectionTitle()
Specified by:
sectionTitle in interface Sink
Overrides:
sectionTitle in interface SinkAdapter

sectionTitle_

public void sectionTitle_()
Specified by:
sectionTitle_ in interface Sink
Overrides:
sectionTitle_ in interface SinkAdapter

setBottomMargin

public void setBottomMargin(double margin)

setCharSet

public void setCharSet(int cs)

setCodePage

public void setCodePage(int cp)

setFontSize

public void setFontSize(int size)

setImageCompression

public void setImageCompression(boolean compression)

setImageDataFormat

public void setImageDataFormat(String format)

setImageFormat

public void setImageFormat(String format)

setImageType

public void setImageType(String type)

setLeftMargin

public void setLeftMargin(double margin)

setPaperSize

public void setPaperSize(double width,
                         double height)

setResolution

public void setResolution(int resolution)

setRightMargin

public void setRightMargin(double margin)

setSpacing

public void setSpacing(int spacing)

setTopMargin

public void setTopMargin(double margin)

table

public void table()
Specified by:
table in interface Sink
Overrides:
table in interface SinkAdapter

tableCaption

public void tableCaption()
Specified by:
tableCaption in interface Sink
Overrides:
tableCaption in interface SinkAdapter

tableCaption_

public void tableCaption_()
Specified by:
tableCaption_ in interface Sink
Overrides:
tableCaption_ in interface SinkAdapter

tableCell

public void tableCell()
Specified by:
tableCell in interface Sink
Overrides:
tableCell in interface SinkAdapter

tableCell_

public void tableCell_()
Specified by:
tableCell_ in interface Sink
Overrides:
tableCell_ in interface SinkAdapter

tableRow

public void tableRow()
Specified by:
tableRow in interface Sink
Overrides:
tableRow in interface SinkAdapter

tableRow_

public void tableRow_()
Specified by:
tableRow_ in interface Sink
Overrides:
tableRow_ in interface SinkAdapter

tableRows

public void tableRows(int[] justification,
                      boolean grid)
Specified by:
tableRows in interface Sink
Overrides:
tableRows in interface SinkAdapter

tableRows_

public void tableRows_()
Specified by:
tableRows_ in interface Sink
Overrides:
tableRows_ in interface SinkAdapter

table_

public void table_()
Specified by:
table_ in interface Sink
Overrides:
table_ in interface SinkAdapter

text

public void text(String text)
Specified by:
text in interface Sink
Overrides:
text in interface SinkAdapter

title

public void title()
Specified by:
title in interface Sink
Overrides:
title in interface SinkAdapter

title_

public void title_()
Specified by:
title_ in interface Sink
Overrides:
title_ in interface SinkAdapter

verbatim

public void verbatim(boolean boxed)
Specified by:
verbatim in interface Sink
Overrides:
verbatim in interface SinkAdapter

verbatim_

public void verbatim_()
Specified by:
verbatim_ in interface Sink
Overrides:
verbatim_ in interface SinkAdapter