Package org.apache.maven.doxia.module.rtf

Class RtfSink

java.lang.Object

org.apache.maven.doxia.sink.impl.AbstractSink

org.apache.maven.doxia.sink.impl.SinkAdapter

org.apache.maven.doxia.sink.impl.AbstractTextSink

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

public class RtfSink
extends org.apache.maven.doxia.sink.impl.AbstractTextSink

RTF Sink implementation.

Since:

1.0

Version:

$Id: RtfSink.java 1726411 2016-01-23 16:34:09Z hboutemy $

Field Summary

Fields

Modifier and Type	Field	Description
static double	DEFAULT_BOTTOM_MARGIN	Paper bottom margin, 2 cm
static int	DEFAULT_CHAR_SET	Constant DEFAULT_CHAR_SET=0
static int	DEFAULT_CODE_PAGE	Codepage, 1252
static java.lang.String	DEFAULT_DATA_FORMAT	Data format, ascii
static int	DEFAULT_FONT_SIZE	Font size, 10 pts
static java.lang.String	DEFAULT_IMAGE_FORMAT	Image format, bmp
static java.lang.String	DEFAULT_IMAGE_TYPE	Image type, palette
static double	DEFAULT_LEFT_MARGIN	Paper left margin, 2 cm
static double	DEFAULT_PAPER_HEIGHT	Paper height, 29.7 cm
static double	DEFAULT_PAPER_WIDTH	Paper width, 21 cm
static int	DEFAULT_RESOLUTION	Resolution, 72 dpi
static double	DEFAULT_RIGHT_MARGIN	Paper right margin, 2 cm
static int	DEFAULT_SPACING	Spacing, 10 pts
static double	DEFAULT_TOP_MARGIN	Paper top margin, 2 cm
protected int	fontSize
static java.lang.String	IMG_DATA_ASCII	Constant IMG_DATA_ASCII="ascii"
static java.lang.String	IMG_DATA_RAW	Constant IMG_DATA_RAW="raw"
static java.lang.String	IMG_FORMAT_BMP	Constant IMG_FORMAT_BMP="bmp"
static java.lang.String	IMG_FORMAT_WMF	Constant IMG_FORMAT_WMF="wmf"
static java.lang.String	IMG_TYPE_PALETTE	Constant IMG_TYPE_PALETTE="palette"
static java.lang.String	IMG_TYPE_RGB	Constant IMG_TYPE_RGB="rgb"
protected org.apache.maven.doxia.module.rtf.RtfSink.Indentation	indentation
protected org.apache.maven.doxia.module.rtf.RtfSink.Space	space
protected java.io.OutputStream	stream
static int	STYLE_BOLD	Constant STYLE_BOLD=2
static int	STYLE_ITALIC	Constant STYLE_ITALIC=1
static int	STYLE_ROMAN	Constant STYLE_ROMAN=0
static int	STYLE_TYPEWRITER	Constant STYLE_TYPEWRITER=3
protected java.io.PrintWriter	writer

Fields inherited from interface org.apache.maven.doxia.markup.Markup

COLON, EOL, EQUAL, GREATER_THAN, LEFT_CURLY_BRACKET, LEFT_SQUARE_BRACKET, LESS_THAN, MINUS, PLUS, QUOTE, RIGHT_CURLY_BRACKET, RIGHT_SQUARE_BRACKET, SEMICOLON, SLASH, SPACE, STAR

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

JUSTIFY_CENTER, JUSTIFY_LEFT, JUSTIFY_RIGHT, 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, SECTION_LEVEL_6

Fields inherited from interface org.apache.maven.doxia.markup.TextMarkup

PIPE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RtfSink()	Constructor for RtfSink.
protected	RtfSink(java.io.OutputStream output)	Constructor for RtfSink.
protected	RtfSink(java.io.OutputStream output, java.lang.String encoding)	Constructor for RtfSink.

Method Summary

Modifier and Type	Method	Description
void	anchor(java.lang.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	definition_()
void	definitionList()
void	definitionList_()
void	definitionListItem()
void	definitionListItem_()
void	figure()
void	figure_()
void	figureCaption()
void	figureCaption_()
void	figureGraphics(java.lang.String name)
void	flush()
protected org.apache.maven.doxia.module.rtf.Font	getFont(int style, int size)	getFont.
void	head()
void	head_()
void	horizontalRule()
protected void	init()
void	italic()
void	italic_()
void	lineBreak()
void	link(java.lang.String name)
void	link_()
void	list()
void	list_()
void	listItem()
void	listItem_()
void	monospaced()
void	monospaced_()
void	nonBreakingSpace()
void	numberedList(int numbering)
void	numberedList_()
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)	Setter for the field bottomMargin.
void	setCharSet(int cs)	Setter for the field charSet.
void	setCodePage(int cp)	Setter for the field codePage.
void	setFontSize(int size)	Setter for the field fontSize.
void	setImageCompression(boolean compression)	Setter for the field imageCompression.
void	setImageDataFormat(java.lang.String format)	Setter for the field imageDataFormat.
void	setImageFormat(java.lang.String format)	Setter for the field imageFormat.
void	setImageType(java.lang.String type)	Setter for the field imageType.
void	setLeftMargin(double margin)	Setter for the field leftMargin.
void	setPaperSize(double width, double height)	setPaperSize.
void	setResolution(int resolution)	Setter for the field resolution.
void	setRightMargin(double margin)	Setter for the field rightMargin.
void	setSpacing(int spacing)	setSpacing.
void	setTopMargin(double margin)	Setter for the field topMargin.
void	table()
void	table_()
void	tableCaption()
void	tableCaption_()
void	tableCell()
void	tableCell_()
void	tableHeaderCell()
void	tableHeaderCell_()
void	tableRow()
void	tableRow_()
void	tableRows(int[] justification, boolean grid)
void	tableRows_()
void	text(java.lang.String text)
void	title()
void	title_()
protected int	toTwips(double length, int unit)	toTwips.
void	unknown(java.lang.String name, java.lang.Object[] requiredParams, org.apache.maven.doxia.sink.SinkEventAttributes attributes)	Unkown events just log a warning message but are ignored otherwise.
void	verbatim(boolean boxed)
void	verbatim_()

Methods inherited from class org.apache.maven.doxia.sink.impl.AbstractSink

enableLogging, getLog, unifyEOLs

Methods inherited from class java.lang.Object

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

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

anchor, author, body, comment, date, definedTerm, definition, definitionList, definitionListItem, figure, figureCaption, figureGraphics, head, horizontalRule, lineBreak, link, list, listItem, numberedList, numberedListItem, paragraph, rawText, section, section_, section6, section6_, sectionTitle, sectionTitle_, sectionTitle1, sectionTitle1_, sectionTitle2, sectionTitle2_, sectionTitle3, sectionTitle3_, sectionTitle4, sectionTitle4_, sectionTitle5, sectionTitle5_, sectionTitle6, sectionTitle6_, table, tableCaption, tableCell, tableCell, tableHeaderCell, tableHeaderCell, tableRow, text, title, verbatim

Field Detail

DEFAULT_PAPER_WIDTH

public static final double DEFAULT_PAPER_WIDTH

Paper width, 21 cm

See Also:

Constant Field Values

DEFAULT_PAPER_HEIGHT

public static final double DEFAULT_PAPER_HEIGHT

Paper height, 29.7 cm

See Also:

Constant Field Values

DEFAULT_TOP_MARGIN

public static final double DEFAULT_TOP_MARGIN

Paper top margin, 2 cm

See Also:

Constant Field Values

DEFAULT_BOTTOM_MARGIN

public static final double DEFAULT_BOTTOM_MARGIN

Paper bottom margin, 2 cm

See Also:

Constant Field Values

DEFAULT_LEFT_MARGIN

public static final double DEFAULT_LEFT_MARGIN

Paper left margin, 2 cm

See Also:

Constant Field Values

DEFAULT_RIGHT_MARGIN

public static final double DEFAULT_RIGHT_MARGIN

Paper right margin, 2 cm

See Also:

Constant Field Values

DEFAULT_FONT_SIZE

public static final int DEFAULT_FONT_SIZE

Font size, 10 pts

See Also:

Constant Field Values

DEFAULT_SPACING

public static final int DEFAULT_SPACING

Spacing, 10 pts

See Also:

Constant Field Values

DEFAULT_RESOLUTION

public static final int DEFAULT_RESOLUTION

Resolution, 72 dpi

See Also:

Constant Field Values

DEFAULT_IMAGE_FORMAT

public static final java.lang.String DEFAULT_IMAGE_FORMAT

Image format, bmp

See Also:

Constant Field Values

DEFAULT_IMAGE_TYPE

public static final java.lang.String DEFAULT_IMAGE_TYPE

Image type, palette

See Also:

Constant Field Values

DEFAULT_DATA_FORMAT

public static final java.lang.String DEFAULT_DATA_FORMAT

Data format, ascii

See Also:

Constant Field Values

DEFAULT_CODE_PAGE

public static final int DEFAULT_CODE_PAGE

Codepage, 1252

See Also:

Constant Field Values

DEFAULT_CHAR_SET

public static final int DEFAULT_CHAR_SET

Constant DEFAULT_CHAR_SET=0

See Also:

Constant Field Values

IMG_FORMAT_BMP

public static final java.lang.String IMG_FORMAT_BMP

Constant IMG_FORMAT_BMP="bmp"

See Also:

Constant Field Values

IMG_FORMAT_WMF

public static final java.lang.String IMG_FORMAT_WMF

Constant IMG_FORMAT_WMF="wmf"

See Also:

Constant Field Values

IMG_TYPE_PALETTE

public static final java.lang.String IMG_TYPE_PALETTE

Constant IMG_TYPE_PALETTE="palette"

See Also:

Constant Field Values

IMG_TYPE_RGB

public static final java.lang.String IMG_TYPE_RGB

Constant IMG_TYPE_RGB="rgb"

See Also:

Constant Field Values

IMG_DATA_ASCII

public static final java.lang.String IMG_DATA_ASCII

Constant IMG_DATA_ASCII="ascii"

See Also:

Constant Field Values

IMG_DATA_RAW

public static final java.lang.String IMG_DATA_RAW

Constant IMG_DATA_RAW="raw"

See Also:

Constant Field Values

STYLE_ROMAN

public static final int STYLE_ROMAN

Constant STYLE_ROMAN=0

See Also:

Constant Field Values

STYLE_ITALIC

public static final int STYLE_ITALIC

Constant STYLE_ITALIC=1

See Also:

Constant Field Values

STYLE_BOLD

public static final int STYLE_BOLD

Constant STYLE_BOLD=2

See Also:

Constant Field Values

STYLE_TYPEWRITER

public static final int STYLE_TYPEWRITER

Constant STYLE_TYPEWRITER=3

See Also:

Constant Field Values

fontSize

protected int fontSize

indentation

protected org.apache.maven.doxia.module.rtf.RtfSink.Indentation indentation

space

protected org.apache.maven.doxia.module.rtf.RtfSink.Space space

writer

protected java.io.PrintWriter writer

stream

protected java.io.OutputStream stream

Constructor Detail

RtfSink

protected RtfSink()
           throws java.io.IOException

Constructor for RtfSink.

Throws:

java.io.IOException - if any

RtfSink

protected RtfSink(java.io.OutputStream output)
           throws java.io.IOException

Constructor for RtfSink.

Parameters:

output - not null

Throws:

java.io.IOException - if any

RtfSink

protected RtfSink(java.io.OutputStream output,
                  java.lang.String encoding)
           throws java.io.IOException

Constructor for RtfSink.

Parameters:

output - not null

encoding - a valid charset

Throws:

java.io.IOException - if any

Method Detail

setPaperSize

public void setPaperSize(double width,
                         double height)

setPaperSize.

Parameters:

width - in cm.

height - in cm.

setTopMargin

public void setTopMargin(double margin)

Setter for the field topMargin.

Parameters:

margin - margin.

setBottomMargin

public void setBottomMargin(double margin)

Setter for the field bottomMargin.

Parameters:

margin - margin.

setLeftMargin

public void setLeftMargin(double margin)

Setter for the field leftMargin.

Parameters:

margin - margin

setRightMargin

public void setRightMargin(double margin)

Setter for the field rightMargin.

Parameters:

margin - margin

setFontSize

public void setFontSize(int size)

Setter for the field fontSize.

Parameters:

size - in pts

setSpacing

public void setSpacing(int spacing)

setSpacing.

Parameters:

spacing - in pts.

setResolution

public void setResolution(int resolution)

Setter for the field resolution.

Parameters:

resolution - in dpi

setImageFormat

public void setImageFormat(java.lang.String format)

Setter for the field imageFormat.

Parameters:

format -

setImageType

public void setImageType(java.lang.String type)

Setter for the field imageType.

Parameters:

type -

setImageDataFormat

public void setImageDataFormat(java.lang.String format)

Setter for the field imageDataFormat.

Parameters:

format -

setImageCompression

public void setImageCompression(boolean compression)

Setter for the field imageCompression.

Parameters:

compression -

setCodePage

public void setCodePage(int cp)

Setter for the field codePage.

Parameters:

cp -

setCharSet

public void setCharSet(int cs)

Setter for the field charSet.

Parameters:

cs -

head

public void head()

Overrides:

head in class org.apache.maven.doxia.sink.impl.SinkAdapter

head_

public void head_()

Overrides:

head_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

toTwips

protected int toTwips(double length,
                      int unit)

toTwips.

Parameters:

length - a double.

unit - a int.

Returns:

a int.

title

public void title()

Overrides:

title in class org.apache.maven.doxia.sink.impl.SinkAdapter

title_

public void title_()

Overrides:

title_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

author

public void author()

Overrides:

author in class org.apache.maven.doxia.sink.impl.SinkAdapter

author_

public void author_()

Overrides:

author_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

date

public void date()

Overrides:

date in class org.apache.maven.doxia.sink.impl.SinkAdapter

date_

public void date_()

Overrides:

date_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

body

public void body()

Overrides:

body in class org.apache.maven.doxia.sink.impl.SinkAdapter

body_

public void body_()

Overrides:

body_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

section1

public void section1()

Overrides:

section1 in class org.apache.maven.doxia.sink.impl.SinkAdapter

section1_

public void section1_()

Overrides:

section1_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

section2

public void section2()

Overrides:

section2 in class org.apache.maven.doxia.sink.impl.SinkAdapter

section2_

public void section2_()

Overrides:

section2_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

section3

public void section3()

Overrides:

section3 in class org.apache.maven.doxia.sink.impl.SinkAdapter

section3_

public void section3_()

Overrides:

section3_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

section4

public void section4()

Overrides:

section4 in class org.apache.maven.doxia.sink.impl.SinkAdapter

section4_

public void section4_()

Overrides:

section4_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

section5

public void section5()

Overrides:

section5 in class org.apache.maven.doxia.sink.impl.SinkAdapter

section5_

public void section5_()

Overrides:

section5_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

sectionTitle

public void sectionTitle()

Overrides:

sectionTitle in class org.apache.maven.doxia.sink.impl.SinkAdapter

sectionTitle_

public void sectionTitle_()

Overrides:

sectionTitle_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

list

public void list()

Overrides:

list in class org.apache.maven.doxia.sink.impl.SinkAdapter

list_

public void list_()

Overrides:

list_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

listItem

public void listItem()

Overrides:

listItem in class org.apache.maven.doxia.sink.impl.SinkAdapter

listItem_

public void listItem_()

Overrides:

listItem_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

numberedList

public void numberedList(int numbering)

Overrides:

numberedList in class org.apache.maven.doxia.sink.impl.SinkAdapter

numberedList_

public void numberedList_()

Overrides:

numberedList_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

numberedListItem

public void numberedListItem()

Overrides:

numberedListItem in class org.apache.maven.doxia.sink.impl.SinkAdapter

numberedListItem_

public void numberedListItem_()

Overrides:

numberedListItem_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

definitionList

public void definitionList()

Overrides:

definitionList in class org.apache.maven.doxia.sink.impl.SinkAdapter

definitionList_

public void definitionList_()

Overrides:

definitionList_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

definitionListItem

public void definitionListItem()

Overrides:

definitionListItem in class org.apache.maven.doxia.sink.impl.SinkAdapter

definitionListItem_

public void definitionListItem_()

Overrides:

definitionListItem_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

definedTerm

public void definedTerm()

Overrides:

definedTerm in class org.apache.maven.doxia.sink.impl.SinkAdapter

definedTerm_

public void definedTerm_()

Overrides:

definedTerm_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

definition

public void definition()

Overrides:

definition in class org.apache.maven.doxia.sink.impl.SinkAdapter

definition_

public void definition_()

Overrides:

definition_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

table

public void table()

Overrides:

table in class org.apache.maven.doxia.sink.impl.SinkAdapter

table_

public void table_()

Overrides:

table_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

tableRows

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

Overrides:

tableRows in class org.apache.maven.doxia.sink.impl.SinkAdapter

tableRows_

public void tableRows_()

Overrides:

tableRows_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

tableRow

public void tableRow()

Overrides:

tableRow in class org.apache.maven.doxia.sink.impl.SinkAdapter

tableRow_

public void tableRow_()

Overrides:

tableRow_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

tableHeaderCell

public void tableHeaderCell()

Overrides:

tableHeaderCell in class org.apache.maven.doxia.sink.impl.SinkAdapter

tableHeaderCell_

public void tableHeaderCell_()

Overrides:

tableHeaderCell_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

tableCell

public void tableCell()

Overrides:

tableCell in class org.apache.maven.doxia.sink.impl.SinkAdapter

tableCell_

public void tableCell_()

Overrides:

tableCell_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

tableCaption

public void tableCaption()

Overrides:

tableCaption in class org.apache.maven.doxia.sink.impl.SinkAdapter

tableCaption_

public void tableCaption_()

Overrides:

tableCaption_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

paragraph

public void paragraph()

Overrides:

paragraph in class org.apache.maven.doxia.sink.impl.SinkAdapter

paragraph_

public void paragraph_()

Overrides:

paragraph_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

verbatim

public void verbatim(boolean boxed)

Overrides:

verbatim in class org.apache.maven.doxia.sink.impl.SinkAdapter

verbatim_

public void verbatim_()

Overrides:

verbatim_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

figure

public void figure()

Overrides:

figure in class org.apache.maven.doxia.sink.impl.SinkAdapter

figure_

public void figure_()

Overrides:

figure_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

figureGraphics

public void figureGraphics(java.lang.String name)

Overrides:

figureGraphics in class org.apache.maven.doxia.sink.impl.SinkAdapter

figureCaption

public void figureCaption()

Overrides:

figureCaption in class org.apache.maven.doxia.sink.impl.SinkAdapter

figureCaption_

public void figureCaption_()

Overrides:

figureCaption_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

horizontalRule

public void horizontalRule()

Overrides:

horizontalRule in class org.apache.maven.doxia.sink.impl.SinkAdapter

pageBreak

public void pageBreak()

Overrides:

pageBreak in class org.apache.maven.doxia.sink.impl.SinkAdapter

anchor

public void anchor(java.lang.String name)

Overrides:

anchor in class org.apache.maven.doxia.sink.impl.SinkAdapter

anchor_

public void anchor_()

Overrides:

anchor_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

link

public void link(java.lang.String name)

Overrides:

link in class org.apache.maven.doxia.sink.impl.SinkAdapter

link_

public void link_()

Overrides:

link_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

italic

public void italic()

Overrides:

italic in class org.apache.maven.doxia.sink.impl.SinkAdapter

italic_

public void italic_()

Overrides:

italic_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

bold

public void bold()

Overrides:

bold in class org.apache.maven.doxia.sink.impl.SinkAdapter

bold_

public void bold_()

Overrides:

bold_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

monospaced

public void monospaced()

Overrides:

monospaced in class org.apache.maven.doxia.sink.impl.SinkAdapter

monospaced_

public void monospaced_()

Overrides:

monospaced_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

lineBreak

public void lineBreak()

Overrides:

lineBreak in class org.apache.maven.doxia.sink.impl.SinkAdapter

nonBreakingSpace

public void nonBreakingSpace()

Overrides:

nonBreakingSpace in class org.apache.maven.doxia.sink.impl.SinkAdapter

text

public void text(java.lang.String text)

Overrides:

text in class org.apache.maven.doxia.sink.impl.SinkAdapter

unknown

public void unknown(java.lang.String name,
                    java.lang.Object[] requiredParams,
                    org.apache.maven.doxia.sink.SinkEventAttributes attributes)

Unkown events just log a warning message but are ignored otherwise.

Overrides:

unknown in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

Sink.unknown(String,Object[],SinkEventAttributes)

getFont

protected org.apache.maven.doxia.module.rtf.Font getFont(int style,
                                                         int size)

getFont.

Parameters:

style - a int.

size - a int.

Returns:

a Font object.

flush

public void flush()

Overrides:

flush in class org.apache.maven.doxia.sink.impl.SinkAdapter

close

public void close()

Overrides:

close in class org.apache.maven.doxia.sink.impl.SinkAdapter

init

protected void init()

Overrides:

init in class org.apache.maven.doxia.sink.impl.AbstractSink