RtfSink (Doxia :: RTF Module 1.5 API)

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

All Implemented Interfaces:

org.apache.maven.doxia.logging.LogEnabled, Markup, TextMarkup, Sink
```
public class RtfSink
extends AbstractTextSink
```
RTF Sink implementation.

Since:

1.0

Version:

$Id: RtfSink.java 1438269 2013-01-24 23:47:50Z olamy $

Field Summary

Fields
Modifier and Type	Field and 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 String`	`DEFAULT_DATA_FORMAT` Data format, ascii
`static int`	`DEFAULT_FONT_SIZE` Font size, 10 pts
`static String`	`DEFAULT_IMAGE_FORMAT` Image format, bmp
`static 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 String`	`IMG_DATA_ASCII` Constant `IMG_DATA_ASCII="ascii"`
`static String`	`IMG_DATA_RAW` Constant `IMG_DATA_RAW="raw"`
`static String`	`IMG_FORMAT_BMP` Constant `IMG_FORMAT_BMP="bmp"`
`static String`	`IMG_FORMAT_WMF` Constant `IMG_FORMAT_WMF="wmf"`
`static String`	`IMG_TYPE_PALETTE` Constant `IMG_TYPE_PALETTE="palette"`
`static 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 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 PrintWriter`	`writer`

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

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

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`RtfSink()` Constructor for RtfSink.
`protected`	`RtfSink(OutputStream output)` Constructor for RtfSink.
`protected`	`RtfSink(OutputStream output, String encoding)` Constructor for RtfSink.

Method Summary

Methods
Modifier and Type	Method and Description
`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()`
`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_()`
`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)` 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(String format)` Setter for the field `imageDataFormat`.
`void`	`setImageFormat(String format)` Setter for the field `imageFormat`.
`void`	`setImageType(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_()`
`void`	`tableRows(int[] justification, boolean grid)`
`void`	`text(String text)`
`void`	`title_()`
`void`	`title()`
`protected int`	`toTwips(double length, int unit)` toTwips.
`void`	`unknown(String name, Object[] requiredParams, SinkEventAttributes attributes)` Unkown events just log a warning message but are ignored otherwise.
`void`	`verbatim_()`
`void`	`verbatim(boolean boxed)`

Methods inherited from class org.apache.maven.doxia.sink.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, sectionTitle_, sectionTitle, sectionTitle1_, sectionTitle1, sectionTitle2_, sectionTitle2, sectionTitle3_, sectionTitle3, sectionTitle4_, sectionTitle4, sectionTitle5_, sectionTitle5, table, tableCaption, tableCell, tableCell, tableHeaderCell, tableHeaderCell, tableRow, text, title, verbatim

Methods inherited from class org.apache.maven.doxia.sink.AbstractSink
enableLogging, getLog, unifyEOLs

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
```
    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 String DEFAULT_IMAGE_FORMAT
```
    Image format, bmp
    
    See Also:
    Constant Field Values
  - DEFAULT_IMAGE_TYPE
```
public static final String DEFAULT_IMAGE_TYPE
```
    Image type, palette
    
    See Also:
    Constant Field Values
  - DEFAULT_DATA_FORMAT
```
public static final 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 String IMG_FORMAT_BMP
```
    Constant IMG_FORMAT_BMP="bmp"
    
    See Also:
    Constant Field Values
  - IMG_FORMAT_WMF
```
public static final String IMG_FORMAT_WMF
```
    Constant IMG_FORMAT_WMF="wmf"
    
    See Also:
    Constant Field Values
  - IMG_TYPE_PALETTE
```
public static final String IMG_TYPE_PALETTE
```
    Constant IMG_TYPE_PALETTE="palette"
    
    See Also:
    Constant Field Values
  - IMG_TYPE_RGB
```
public static final String IMG_TYPE_RGB
```
    Constant IMG_TYPE_RGB="rgb"
    
    See Also:
    Constant Field Values
  - IMG_DATA_ASCII
```
public static final String IMG_DATA_ASCII
```
    Constant IMG_DATA_ASCII="ascii"
    
    See Also:
    Constant Field Values
  - IMG_DATA_RAW
```
public static final 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 PrintWriter writer
```
  - stream
```
protected OutputStream stream
```
- Constructor Detail
  - RtfSink
```
protected RtfSink()
           throws IOException
```
    Constructor for RtfSink.
    
    Throws:
    
    IOException - if any
  - RtfSink
```
protected RtfSink(OutputStream output)
           throws IOException
```
    Constructor for RtfSink.
    
    Parameters:
    output - not null
    
    Throws:
    
    IOException - if any
  - RtfSink
```
protected RtfSink(OutputStream output,
       String encoding)
           throws IOException
```
    Constructor for RtfSink.
    
    Parameters:
    output - not null
    encoding - a valid charset
    
    Throws:
    
    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(String format)
```
    Setter for the field imageFormat.
    
    Parameters:
    format -
  - setImageType
```
public void setImageType(String type)
```
    Setter for the field imageType.
    
    Parameters:
    type -
  - setImageDataFormat
```
public void setImageDataFormat(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()
```
    Specified by:
    
    head in interface Sink
    
    Overrides:
    
    head in class SinkAdapter
  - head_
```
public void head_()
```
    Specified by:
    
    head_ in interface Sink
    
    Overrides:
    
    head_ in class SinkAdapter
  - toTwips
```
protected int toTwips(double length,
          int unit)
```
    toTwips.
    
    Parameters:
    length - a double.
    unit - a int.
    
    Returns:
    a int.
  - title
```
public void title()
```
    Specified by:
    
    title in interface Sink
    
    Overrides:
    
    title in class SinkAdapter
  - title_
```
public void title_()
```
    Specified by:
    
    title_ in interface Sink
    
    Overrides:
    
    title_ in class SinkAdapter
  - author
```
public void author()
```
    Specified by:
    
    author in interface Sink
    
    Overrides:
    
    author in class SinkAdapter
  - author_
```
public void author_()
```
    Specified by:
    
    author_ in interface Sink
    
    Overrides:
    
    author_ in class SinkAdapter
  - date
```
public void date()
```
    Specified by:
    
    date in interface Sink
    
    Overrides:
    
    date in class SinkAdapter
  - date_
```
public void date_()
```
    Specified by:
    
    date_ in interface Sink
    
    Overrides:
    
    date_ in class SinkAdapter
  - body
```
public void body()
```
    Specified by:
    
    body in interface Sink
    
    Overrides:
    
    body in class SinkAdapter
  - body_
```
public void body_()
```
    Specified by:
    
    body_ in interface Sink
    
    Overrides:
    
    body_ in class SinkAdapter
  - section1
```
public void section1()
```
    Specified by:
    
    section1 in interface Sink
    
    Overrides:
    
    section1 in class SinkAdapter
  - section1_
```
public void section1_()
```
    Specified by:
    
    section1_ in interface Sink
    
    Overrides:
    
    section1_ in class SinkAdapter
  - section2
```
public void section2()
```
    Specified by:
    
    section2 in interface Sink
    
    Overrides:
    
    section2 in class SinkAdapter
  - section2_
```
public void section2_()
```
    Specified by:
    
    section2_ in interface Sink
    
    Overrides:
    
    section2_ in class SinkAdapter
  - section3
```
public void section3()
```
    Specified by:
    
    section3 in interface Sink
    
    Overrides:
    
    section3 in class SinkAdapter
  - section3_
```
public void section3_()
```
    Specified by:
    
    section3_ in interface Sink
    
    Overrides:
    
    section3_ in class SinkAdapter
  - section4
```
public void section4()
```
    Specified by:
    
    section4 in interface Sink
    
    Overrides:
    
    section4 in class SinkAdapter
  - section4_
```
public void section4_()
```
    Specified by:
    
    section4_ in interface Sink
    
    Overrides:
    
    section4_ in class SinkAdapter
  - section5
```
public void section5()
```
    Specified by:
    
    section5 in interface Sink
    
    Overrides:
    
    section5 in class SinkAdapter
  - section5_
```
public void section5_()
```
    Specified by:
    
    section5_ in interface Sink
    
    Overrides:
    
    section5_ in class SinkAdapter
  - sectionTitle
```
public void sectionTitle()
```
    Specified by:
    
    sectionTitle in interface Sink
    
    Overrides:
    
    sectionTitle in class SinkAdapter
  - sectionTitle_
```
public void sectionTitle_()
```
    Specified by:
    
    sectionTitle_ in interface Sink
    
    Overrides:
    
    sectionTitle_ in class SinkAdapter
  - list
```
public void list()
```
    Specified by:
    
    list in interface Sink
    
    Overrides:
    
    list in class SinkAdapter
  - list_
```
public void list_()
```
    Specified by:
    
    list_ in interface Sink
    
    Overrides:
    
    list_ in class SinkAdapter
  - listItem
```
public void listItem()
```
    Specified by:
    
    listItem in interface Sink
    
    Overrides:
    
    listItem in class SinkAdapter
  - listItem_
```
public void listItem_()
```
    Specified by:
    
    listItem_ in interface Sink
    
    Overrides:
    
    listItem_ in class SinkAdapter
  - numberedList
```
public void numberedList(int numbering)
```
    Specified by:
    
    numberedList in interface Sink
    
    Overrides:
    
    numberedList in class SinkAdapter
  - numberedList_
```
public void numberedList_()
```
    Specified by:
    
    numberedList_ in interface Sink
    
    Overrides:
    
    numberedList_ in class SinkAdapter
  - numberedListItem
```
public void numberedListItem()
```
    Specified by:
    
    numberedListItem in interface Sink
    
    Overrides:
    
    numberedListItem in class SinkAdapter
  - numberedListItem_
```
public void numberedListItem_()
```
    Specified by:
    
    numberedListItem_ in interface Sink
    
    Overrides:
    
    numberedListItem_ in class SinkAdapter
  - definitionList
```
public void definitionList()
```
    Specified by:
    
    definitionList in interface Sink
    
    Overrides:
    
    definitionList in class SinkAdapter
  - definitionList_
```
public void definitionList_()
```
    Specified by:
    
    definitionList_ in interface Sink
    
    Overrides:
    
    definitionList_ in class SinkAdapter
  - definitionListItem
```
public void definitionListItem()
```
    Specified by:
    
    definitionListItem in interface Sink
    
    Overrides:
    
    definitionListItem in class SinkAdapter
  - definitionListItem_
```
public void definitionListItem_()
```
    Specified by:
    
    definitionListItem_ in interface Sink
    
    Overrides:
    
    definitionListItem_ in class SinkAdapter
  - definedTerm
```
public void definedTerm()
```
    Specified by:
    
    definedTerm in interface Sink
    
    Overrides:
    
    definedTerm in class SinkAdapter
  - definedTerm_
```
public void definedTerm_()
```
    Specified by:
    
    definedTerm_ in interface Sink
    
    Overrides:
    
    definedTerm_ in class SinkAdapter
  - definition
```
public void definition()
```
    Specified by:
    
    definition in interface Sink
    
    Overrides:
    
    definition in class SinkAdapter
  - definition_
```
public void definition_()
```
    Specified by:
    
    definition_ in interface Sink
    
    Overrides:
    
    definition_ in class SinkAdapter
  - table
```
public void table()
```
    Specified by:
    
    table in interface Sink
    
    Overrides:
    
    table in class SinkAdapter
  - table_
```
public void table_()
```
    Specified by:
    
    table_ in interface Sink
    
    Overrides:
    
    table_ in class SinkAdapter
  - tableRows
```
public void tableRows(int[] justification,
             boolean grid)
```
    Specified by:
    
    tableRows in interface Sink
    
    Overrides:
    
    tableRows in class SinkAdapter
  - tableRows_
```
public void tableRows_()
```
    Specified by:
    
    tableRows_ in interface Sink
    
    Overrides:
    
    tableRows_ in class SinkAdapter
  - tableRow
```
public void tableRow()
```
    Specified by:
    
    tableRow in interface Sink
    
    Overrides:
    
    tableRow in class SinkAdapter
  - tableRow_
```
public void tableRow_()
```
    Specified by:
    
    tableRow_ in interface Sink
    
    Overrides:
    
    tableRow_ in class SinkAdapter
  - tableHeaderCell
```
public void tableHeaderCell()
```
    Specified by:
    
    tableHeaderCell in interface Sink
    
    Overrides:
    
    tableHeaderCell in class SinkAdapter
  - tableHeaderCell_
```
public void tableHeaderCell_()
```
    Specified by:
    
    tableHeaderCell_ in interface Sink
    
    Overrides:
    
    tableHeaderCell_ in class SinkAdapter
  - tableCell
```
public void tableCell()
```
    Specified by:
    
    tableCell in interface Sink
    
    Overrides:
    
    tableCell in class SinkAdapter
  - tableCell_
```
public void tableCell_()
```
    Specified by:
    
    tableCell_ in interface Sink
    
    Overrides:
    
    tableCell_ in class SinkAdapter
  - tableCaption
```
public void tableCaption()
```
    Specified by:
    
    tableCaption in interface Sink
    
    Overrides:
    
    tableCaption in class SinkAdapter
  - tableCaption_
```
public void tableCaption_()
```
    Specified by:
    
    tableCaption_ in interface Sink
    
    Overrides:
    
    tableCaption_ in class SinkAdapter
  - paragraph
```
public void paragraph()
```
    Specified by:
    
    paragraph in interface Sink
    
    Overrides:
    
    paragraph in class SinkAdapter
  - paragraph_
```
public void paragraph_()
```
    Specified by:
    
    paragraph_ in interface Sink
    
    Overrides:
    
    paragraph_ in class SinkAdapter
  - verbatim
```
public void verbatim(boolean boxed)
```
    Specified by:
    
    verbatim in interface Sink
    
    Overrides:
    
    verbatim in class SinkAdapter
  - verbatim_
```
public void verbatim_()
```
    Specified by:
    
    verbatim_ in interface Sink
    
    Overrides:
    
    verbatim_ in class SinkAdapter
  - figure
```
public void figure()
```
    Specified by:
    
    figure in interface Sink
    
    Overrides:
    
    figure in class SinkAdapter
  - figure_
```
public void figure_()
```
    Specified by:
    
    figure_ in interface Sink
    
    Overrides:
    
    figure_ in class SinkAdapter
  - figureGraphics
```
public void figureGraphics(String name)
```
    Specified by:
    
    figureGraphics in interface Sink
    
    Overrides:
    
    figureGraphics in class SinkAdapter
  - figureCaption
```
public void figureCaption()
```
    Specified by:
    
    figureCaption in interface Sink
    
    Overrides:
    
    figureCaption in class SinkAdapter
  - figureCaption_
```
public void figureCaption_()
```
    Specified by:
    
    figureCaption_ in interface Sink
    
    Overrides:
    
    figureCaption_ in class SinkAdapter
  - horizontalRule
```
public void horizontalRule()
```
    Specified by:
    
    horizontalRule in interface Sink
    
    Overrides:
    
    horizontalRule in class SinkAdapter
  - pageBreak
```
public void pageBreak()
```
    Specified by:
    
    pageBreak in interface Sink
    
    Overrides:
    
    pageBreak in class SinkAdapter
  - anchor
```
public void anchor(String name)
```
    Specified by:
    
    anchor in interface Sink
    
    Overrides:
    
    anchor in class SinkAdapter
  - anchor_
```
public void anchor_()
```
    Specified by:
    
    anchor_ in interface Sink
    
    Overrides:
    
    anchor_ in class SinkAdapter
  - link
```
public void link(String name)
```
    Specified by:
    
    link in interface Sink
    
    Overrides:
    
    link in class SinkAdapter
  - link_
```
public void link_()
```
    Specified by:
    
    link_ in interface Sink
    
    Overrides:
    
    link_ in class SinkAdapter
  - italic
```
public void italic()
```
    Specified by:
    
    italic in interface Sink
    
    Overrides:
    
    italic in class SinkAdapter
  - italic_
```
public void italic_()
```
    Specified by:
    
    italic_ in interface Sink
    
    Overrides:
    
    italic_ in class SinkAdapter
  - bold
```
public void bold()
```
    Specified by:
    
    bold in interface Sink
    
    Overrides:
    
    bold in class SinkAdapter
  - bold_
```
public void bold_()
```
    Specified by:
    
    bold_ in interface Sink
    
    Overrides:
    
    bold_ in class SinkAdapter
  - monospaced
```
public void monospaced()
```
    Specified by:
    
    monospaced in interface Sink
    
    Overrides:
    
    monospaced in class SinkAdapter
  - monospaced_
```
public void monospaced_()
```
    Specified by:
    
    monospaced_ in interface Sink
    
    Overrides:
    
    monospaced_ in class SinkAdapter
  - lineBreak
```
public void lineBreak()
```
    Specified by:
    
    lineBreak in interface Sink
    
    Overrides:
    
    lineBreak in class SinkAdapter
  - nonBreakingSpace
```
public void nonBreakingSpace()
```
    Specified by:
    
    nonBreakingSpace in interface Sink
    
    Overrides:
    
    nonBreakingSpace in class SinkAdapter
  - text
```
public void text(String text)
```
    Specified by:
    
    text in interface Sink
    
    Overrides:
    
    text in class SinkAdapter
  - unknown
```
public void unknown(String name,
           Object[] requiredParams,
           SinkEventAttributes attributes)
```
    Unkown events just log a warning message but are ignored otherwise.
    
    Specified by:
    
    unknown in interface Sink
    
    Overrides:
    
    unknown in class 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()
```
    Specified by:
    
    flush in interface Sink
    
    Overrides:
    
    flush in class SinkAdapter
  - close
```
public void close()
```
    Specified by:
    
    close in interface Sink
    
    Overrides:
    
    close in class SinkAdapter
  - init
```
protected void init()
```
    Overrides:
    
    init in class AbstractSink

Class RtfSink

Field Summary

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

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_PAPER_WIDTH

DEFAULT_PAPER_HEIGHT

DEFAULT_TOP_MARGIN

DEFAULT_BOTTOM_MARGIN

DEFAULT_LEFT_MARGIN

DEFAULT_RIGHT_MARGIN

DEFAULT_FONT_SIZE

DEFAULT_SPACING

DEFAULT_RESOLUTION

DEFAULT_IMAGE_FORMAT

DEFAULT_IMAGE_TYPE

DEFAULT_DATA_FORMAT

DEFAULT_CODE_PAGE

DEFAULT_CHAR_SET

IMG_FORMAT_BMP

IMG_FORMAT_WMF

IMG_TYPE_PALETTE

IMG_TYPE_RGB

IMG_DATA_ASCII

IMG_DATA_RAW

STYLE_ROMAN

STYLE_ITALIC

STYLE_BOLD

STYLE_TYPEWRITER

fontSize

indentation

space

writer

stream

Constructor Detail

RtfSink

RtfSink

RtfSink

Method Detail

setPaperSize

setTopMargin

setBottomMargin

setLeftMargin

setRightMargin

setFontSize

setSpacing

setResolution

setImageFormat

setImageType

setImageDataFormat

setImageCompression

setCodePage

setCharSet

head

head_

toTwips

title

title_

author

author_

date

date_

body

body_

section1

section1_

section2

section2_

section3

section3_

section4

section4_

section5

section5_