RtfSink (Doxia 1.3 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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

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:: LogEnabled, Markup, TextMarkup, Sink

public class RtfSink
extends AbstractTextSink
extends AbstractTextSink

RTF Sink implementation.

Since:: 1.0
Version:: $Id: RtfSink.java 807178 2009-08-24 12:19:14Z vsiveton $

Field Summary
`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
`protected`	`RtfSink()` Constructor for RtfSink.
`protected`	`RtfSink(OutputStream output)` Constructor for RtfSink.
`protected`	`RtfSink(OutputStream output, String encoding)` Constructor for RtfSink.

Method Summary
`void`	`anchor_()` Ends an anchor element.
`void`	`anchor(String name)` Starts an element which defines an anchor.
`void`	`author_()` Ends an author element.
`void`	`author()` Starts an author element.
`void`	`body_()` Ends the body element.
`void`	`body()` Starts the body of a document.
`void`	`bold_()` Ends a bold element. Alternatively one may use `Sink.text(String,SinkEventAttributes)` with `STYLE` instead.
`void`	`bold()` Starts a bold element. Alternatively one may use `Sink.text(String,SinkEventAttributes)` with `STYLE` instead.
`void`	`close()` Close the writer or the stream, if needed. Closing a previously-closed Sink has no effect.
`void`	`date_()` Ends the date element.
`void`	`date()` Starts the date element. The date is recommended (but it is not a requirement) to be align to the ISO-8601 standard, i.e.: YYYY-MM-DD where YYYY is the year in the Gregorian calendar MM is the month of the year between 01 (January) and 12 (December) and DD is the day of the month between 01 and 31
`void`	`definedTerm_()` Starts a definition term element within a definition list.
`void`	`definedTerm()` Starts a definition term element within a definition list.
`void`	`definition_()` Ends a definition element within a definition list.
`void`	`definition()` Starts a definition element within a definition list.
`void`	`definitionList_()` Ends a definition list element.
`void`	`definitionList()` Starts a definition list element.
`void`	`definitionListItem_()` Ends a list item element within a definition list.
`void`	`definitionListItem()` Starts a list item element within a definition list.
`void`	`figure_()` Ends a basic image embedding element.
`void`	`figure()` Starts a basic image embedding element.
`void`	`figureCaption_()` Ends a caption of an image.
`void`	`figureCaption()` Starts a caption of an image element.
`void`	`figureGraphics(String name)` Adding a source of a graphic.
`void`	`flush()` Flush the writer or the stream, if needed. Flushing a previously-flushed Sink has no effect.
`protected org.apache.maven.doxia.module.rtf.Font`	`getFont(int style, int size)` getFont.
`void`	`head_()` Ends the head element.
`void`	`head()` Starts the head element.
`void`	`horizontalRule()` Adding a separator of sections from a text to each other.
`protected void`	`init()` This is called in `Sink.head()` or in `Sink.close()`, and can be used to set the sink into a clear state so it can be re-used.
`void`	`italic_()` Ends an italic element. Alternatively one may use `Sink.text(String,SinkEventAttributes)` with `STYLE` instead.
`void`	`italic()` Starts an italic element. Alternatively one may use `Sink.text(String,SinkEventAttributes)` with `STYLE` instead.
`void`	`lineBreak()` Adds a line break.
`void`	`link_()` Ends a link element.
`void`	`link(String name)` Starts an element which defines a link.
`void`	`list_()` Ends an unordered list element.
`void`	`list()` Starts an unordered list element.
`void`	`listItem_()` Ends a list item element within an unordered list.
`void`	`listItem()` Starts a list item element within an unordered list.
`void`	`monospaced_()` Ends a monospaced element. Alternatively one may use `Sink.text(String,SinkEventAttributes)` with `STYLE` instead.
`void`	`monospaced()` Starts a monospaced element. Alternatively one may use `Sink.text(String,SinkEventAttributes)` with `STYLE` instead.
`void`	`nonBreakingSpace()` Adding a non breaking space, ie a space without any special formatting operations.
`void`	`numberedList_()` Ends an ordered list element.
`void`	`numberedList(int numbering)` Starts an ordered list element.
`void`	`numberedListItem_()` Ends a list item element within an ordered list.
`void`	`numberedListItem()` Starts a list item element within an ordered list.
`void`	`pageBreak()` Adding a new page separator.
`void`	`paragraph_()` Ends a paragraph element.
`void`	`paragraph()` Starts an element which represents a paragraph.
`void`	`section1_()` Ends a first heading element.
`void`	`section1()` Starts a first heading element which contains the topic of the section.
`void`	`section2_()` Ends a second heading element.
`void`	`section2()` Starts a second heading element which contains the topic of the section. This has to be contained within a `Sink.section1()` element.
`void`	`section3_()` Ends a third heading element.
`void`	`section3()` Starts a third heading element which contains the topic of the section. This has to be contained within a `Sink.section2()` element.
`void`	`section4_()` Ends a 4th heading element.
`void`	`section4()` Starts a 4th heading element which contains the topic of the section. This has to be contained within a `Sink.section3()` element.
`void`	`section5_()` Ends a 5th heading element.
`void`	`section5()` Starts a 5th heading element which contains the topic of the section. This has to be contained within a `Sink.section4()` element.
`void`	`sectionTitle_()` Ends a title heading element.
`void`	`sectionTitle()` Starts a title heading element.
`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_()` Ends a table element.
`void`	`table()` Starts a table element for marking up tabular information in a document.
`void`	`tableCaption_()` Ends a caption element of a table.
`void`	`tableCaption()` Starts a caption element of a table.
`void`	`tableCell_()` Ends a cell element.
`void`	`tableCell()` Starts a cell element which defines a cell that contains data.
`void`	`tableHeaderCell_()` Ends a cell header element.
`void`	`tableHeaderCell()` Starts a cell element which defines a cell that contains header information.
`void`	`tableRow_()` Ends a row element.
`void`	`tableRow()` Starts a row element which acts as a container for a row of table cells.
`void`	`tableRows_()` Ends an element that contains rows of table data.
`void`	`tableRows(int[] justification, boolean grid)` Starts an element that contains rows of table data.
`void`	`text(String text)` Adding a text.
`void`	`title_()` Ends the title element.
`void`	`title()` Starts the title element.
`protected int`	`toTwips(double length, int unit)` toTwips.
`void`	`unknown(String name, Object[] requiredParams, SinkEventAttributes attributes)` Add an unknown event. This may be used by parsers to notify a general Sink about an event that doesn't fit into any event defined by the Sink API. Depending on the parameters, a Sink may decide whether or not to process the event, emit it as raw text, as a comment, log it, etc. Unkown events just log a warning message but are ignored otherwise.
`void`	`verbatim_()` Ends a verbatim element.
`void`	`verbatim(boolean boxed)` Starts an element which indicates that whitespace in the enclosed text has semantic relevance.

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.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

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()

Starts the head element.

Specified by:: head in interface Sink
Overrides:: head in class SinkAdapter

See Also:: Sink.head(SinkEventAttributes)

head_

public void head_()

Ends the head element.

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()

Starts the title element.

Specified by:: title in interface Sink
Overrides:: title in class SinkAdapter

See Also:: Sink.title(SinkEventAttributes)

title_

public void title_()

Ends the title element.

Specified by:: title_ in interface Sink
Overrides:: title_ in class SinkAdapter

author

public void author()

Starts an author element.

Specified by:: author in interface Sink
Overrides:: author in class SinkAdapter

See Also:: Sink.author(SinkEventAttributes)

author_

public void author_()

Ends an author element.

Specified by:: author_ in interface Sink
Overrides:: author_ in class SinkAdapter

date

public void date()

Starts the date element.
The date is recommended (but it is not a requirement) to be align to the ISO-8601 standard, i.e.:

 YYYY-MM-DD

where

YYYY is the year in the Gregorian calendar
MM is the month of the year between 01 (January) and 12 (December)
and DD is the day of the month between 01 and 31

Specified by:: date in interface Sink
Overrides:: date in class SinkAdapter

See Also:: Sink.date(SinkEventAttributes)

date_

public void date_()

Ends the date element.

Specified by:: date_ in interface Sink
Overrides:: date_ in class SinkAdapter

body

public void body()

Starts the body of a document.

Specified by:: body in interface Sink
Overrides:: body in class SinkAdapter

See Also:: Sink.body(SinkEventAttributes)

body_

public void body_()

Ends the body element.

Specified by:: body_ in interface Sink
Overrides:: body_ in class SinkAdapter

section1

public void section1()

Starts a first heading element which contains the topic of the section.

Specified by:: section1 in interface Sink
Overrides:: section1 in class SinkAdapter

See Also:: Sink.section(int,SinkEventAttributes)

section1_

public void section1_()

Ends a first heading element.

Specified by:: section1_ in interface Sink
Overrides:: section1_ in class SinkAdapter

section2

public void section2()

Starts a second heading element which contains the topic of the section. This has to be contained within a Sink.section1() element.

Specified by:: section2 in interface Sink
Overrides:: section2 in class SinkAdapter

See Also:: Sink.section(int,SinkEventAttributes)

section2_

public void section2_()

Ends a second heading element.

Specified by:: section2_ in interface Sink
Overrides:: section2_ in class SinkAdapter

section3

public void section3()

Starts a third heading element which contains the topic of the section. This has to be contained within a Sink.section2() element.

Specified by:: section3 in interface Sink
Overrides:: section3 in class SinkAdapter

See Also:: Sink.section(int,SinkEventAttributes)

section3_

public void section3_()

Ends a third heading element.

Specified by:: section3_ in interface Sink
Overrides:: section3_ in class SinkAdapter

section4

public void section4()

Starts a 4th heading element which contains the topic of the section. This has to be contained within a Sink.section3() element.

Specified by:: section4 in interface Sink
Overrides:: section4 in class SinkAdapter

See Also:: Sink.section(int,SinkEventAttributes)

section4_

public void section4_()

Ends a 4th heading element.

Specified by:: section4_ in interface Sink
Overrides:: section4_ in class SinkAdapter

section5

public void section5()

Starts a 5th heading element which contains the topic of the section. This has to be contained within a Sink.section4() element.

Specified by:: section5 in interface Sink
Overrides:: section5 in class SinkAdapter

See Also:: Sink.section(int,SinkEventAttributes)

section5_

public void section5_()

Ends a 5th heading element.

Specified by:: section5_ in interface Sink
Overrides:: section5_ in class SinkAdapter

sectionTitle

public void sectionTitle()

Starts a title heading element.

Specified by:: sectionTitle in interface Sink
Overrides:: sectionTitle in class SinkAdapter

sectionTitle_

public void sectionTitle_()

Ends a title heading element.

Specified by:: sectionTitle_ in interface Sink
Overrides:: sectionTitle_ in class SinkAdapter

list

public void list()

Starts an unordered list element.

Specified by:: list in interface Sink
Overrides:: list in class SinkAdapter

See Also:: Sink.list(SinkEventAttributes)

list_

public void list_()

Ends an unordered list element.

Specified by:: list_ in interface Sink
Overrides:: list_ in class SinkAdapter

listItem

public void listItem()

Starts a list item element within an unordered list.

Specified by:: listItem in interface Sink
Overrides:: listItem in class SinkAdapter

See Also:: Sink.listItem(SinkEventAttributes)

listItem_

public void listItem_()

Ends a list item element within an unordered list.

Specified by:: listItem_ in interface Sink
Overrides:: listItem_ in class SinkAdapter

numberedList

public void numberedList(int numbering)

Starts an ordered list element.

Specified by:: numberedList in interface Sink
Overrides:: numberedList in class SinkAdapter

Parameters:: numbering - the numbering style.
See Also:: Sink.numberedList(int,SinkEventAttributes)

numberedList_

public void numberedList_()

Ends an ordered list element.

Specified by:: numberedList_ in interface Sink
Overrides:: numberedList_ in class SinkAdapter

numberedListItem

public void numberedListItem()

Starts a list item element within an ordered list.

Specified by:: numberedListItem in interface Sink
Overrides:: numberedListItem in class SinkAdapter

See Also:: Sink.numberedListItem(SinkEventAttributes)

numberedListItem_

public void numberedListItem_()

Ends a list item element within an ordered list.

Specified by:: numberedListItem_ in interface Sink
Overrides:: numberedListItem_ in class SinkAdapter

definitionList

public void definitionList()

Starts a definition list element.

Specified by:: definitionList in interface Sink
Overrides:: definitionList in class SinkAdapter

See Also:: Sink.definitionList(SinkEventAttributes)

definitionList_

public void definitionList_()

Ends a definition list element.

Specified by:: definitionList_ in interface Sink
Overrides:: definitionList_ in class SinkAdapter

definitionListItem

public void definitionListItem()

Starts a list item element within a definition list.

Specified by:: definitionListItem in interface Sink
Overrides:: definitionListItem in class SinkAdapter

See Also:: Sink.definitionListItem(SinkEventAttributes)

definitionListItem_

public void definitionListItem_()

Ends a list item element within a definition list.

Specified by:: definitionListItem_ in interface Sink
Overrides:: definitionListItem_ in class SinkAdapter

definedTerm

public void definedTerm()

Starts a definition term element within a definition list.

Specified by:: definedTerm in interface Sink
Overrides:: definedTerm in class SinkAdapter

See Also:: Sink.definedTerm(SinkEventAttributes)

definedTerm_

public void definedTerm_()

Starts a definition term element within a definition list.

Specified by:: definedTerm_ in interface Sink
Overrides:: definedTerm_ in class SinkAdapter

definition

public void definition()

Starts a definition element within a definition list.

Specified by:: definition in interface Sink
Overrides:: definition in class SinkAdapter

See Also:: Sink.definition(SinkEventAttributes)

definition_

public void definition_()

Ends a definition element within a definition list.

Specified by:: definition_ in interface Sink
Overrides:: definition_ in class SinkAdapter

table

public void table()

Starts a table element for marking up tabular information in a document.

Specified by:: table in interface Sink
Overrides:: table in class SinkAdapter

See Also:: Sink.table(SinkEventAttributes)

table_

public void table_()

Ends a table element.

Specified by:: table_ in interface Sink
Overrides:: table_ in class SinkAdapter

tableRows

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

Starts an element that contains rows of table data.

Specified by:: tableRows in interface Sink
Overrides:: tableRows in class SinkAdapter

Parameters:: justification - the default justification of columns. This can be overridden by individual table rows or table cells. If null a left alignment is assumed by default. If this array has less elements than there are columns in the table then the value of the last array element will be taken as default for the remaining table cells.; grid - true to provide a grid, false otherwise.
See Also:: Sink.table(SinkEventAttributes), Sink.JUSTIFY_CENTER, Sink.JUSTIFY_LEFT, Sink.JUSTIFY_RIGHT

tableRows_

public void tableRows_()

Ends an element that contains rows of table data.

Specified by:: tableRows_ in interface Sink
Overrides:: tableRows_ in class SinkAdapter

tableRow

public void tableRow()

Starts a row element which acts as a container for a row of table cells.

Specified by:: tableRow in interface Sink
Overrides:: tableRow in class SinkAdapter

See Also:: Sink.tableRow(SinkEventAttributes)

tableRow_

public void tableRow_()

Ends a row element.

Specified by:: tableRow_ in interface Sink
Overrides:: tableRow_ in class SinkAdapter

tableHeaderCell

public void tableHeaderCell()

Starts a cell element which defines a cell that contains header information.

Specified by:: tableHeaderCell in interface Sink
Overrides:: tableHeaderCell in class SinkAdapter

See Also:: Sink.tableHeaderCell(SinkEventAttributes)

tableHeaderCell_

public void tableHeaderCell_()

Ends a cell header element.

Specified by:: tableHeaderCell_ in interface Sink
Overrides:: tableHeaderCell_ in class SinkAdapter

tableCell

public void tableCell()

Starts a cell element which defines a cell that contains data.

Specified by:: tableCell in interface Sink
Overrides:: tableCell in class SinkAdapter

See Also:: Sink.tableCell(SinkEventAttributes)

tableCell_

public void tableCell_()

Ends a cell element.

Specified by:: tableCell_ in interface Sink
Overrides:: tableCell_ in class SinkAdapter

tableCaption

public void tableCaption()

Starts a caption element of a table.

Specified by:: tableCaption in interface Sink
Overrides:: tableCaption in class SinkAdapter

See Also:: Sink.tableCaption(SinkEventAttributes)

tableCaption_

public void tableCaption_()

Ends a caption element of a table.

Specified by:: tableCaption_ in interface Sink
Overrides:: tableCaption_ in class SinkAdapter

paragraph

public void paragraph()

Starts an element which represents a paragraph.

Specified by:: paragraph in interface Sink
Overrides:: paragraph in class SinkAdapter

See Also:: Sink.paragraph(SinkEventAttributes)

paragraph_

public void paragraph_()

Ends a paragraph element.

Specified by:: paragraph_ in interface Sink
Overrides:: paragraph_ in class SinkAdapter

verbatim

public void verbatim(boolean boxed)

Starts an element which indicates that whitespace in the enclosed text has semantic relevance.

Specified by:: verbatim in interface Sink
Overrides:: verbatim in class SinkAdapter

Parameters:: boxed - true to add a box, false otherwise

verbatim_

public void verbatim_()

Ends a verbatim element.

Specified by:: verbatim_ in interface Sink
Overrides:: verbatim_ in class SinkAdapter

figure

public void figure()

Starts a basic image embedding element.

Specified by:: figure in interface Sink
Overrides:: figure in class SinkAdapter

See Also:: Sink.figure(SinkEventAttributes)

figure_

public void figure_()

Ends a basic image embedding element.

Specified by:: figure_ in interface Sink
Overrides:: figure_ in class SinkAdapter

figureGraphics

public void figureGraphics(String name)

Adding a source of a graphic.

Specified by:: figureGraphics in interface Sink
Overrides:: figureGraphics in class SinkAdapter

Parameters:: name - the source

figureCaption

public void figureCaption()

Starts a caption of an image element.

Specified by:: figureCaption in interface Sink
Overrides:: figureCaption in class SinkAdapter

See Also:: Sink.figureCaption(SinkEventAttributes)

figureCaption_

public void figureCaption_()

Ends a caption of an image.

Specified by:: figureCaption_ in interface Sink
Overrides:: figureCaption_ in class SinkAdapter

horizontalRule

public void horizontalRule()

Adding a separator of sections from a text to each other.

Specified by:: horizontalRule in interface Sink
Overrides:: horizontalRule in class SinkAdapter

See Also:: Sink.horizontalRule(SinkEventAttributes)

pageBreak

public void pageBreak()

Adding a new page separator.

Specified by:: pageBreak in interface Sink
Overrides:: pageBreak in class SinkAdapter

anchor

public void anchor(String name)

Starts an element which defines an anchor.

Specified by:: anchor in interface Sink
Overrides:: anchor in class SinkAdapter

Parameters:: name - the name of the anchor.
See Also:: Sink.anchor(String,SinkEventAttributes)

anchor_

public void anchor_()

Ends an anchor element.

Specified by:: anchor_ in interface Sink
Overrides:: anchor_ in class SinkAdapter

link

public void link(String name)

Starts an element which defines a link.

Specified by:: link in interface Sink
Overrides:: link in class SinkAdapter

Parameters:: name - the name of the link.
See Also:: Sink.link(String,SinkEventAttributes)

link_

public void link_()

Ends a link element.

Specified by:: link_ in interface Sink
Overrides:: link_ in class SinkAdapter

italic

public void italic()

Starts an italic element. Alternatively one may use Sink.text(String,SinkEventAttributes) with STYLE instead.

Specified by:: italic in interface Sink
Overrides:: italic in class SinkAdapter

italic_

public void italic_()

Ends an italic element. Alternatively one may use Sink.text(String,SinkEventAttributes) with STYLE instead.

Specified by:: italic_ in interface Sink
Overrides:: italic_ in class SinkAdapter

bold

public void bold()

Starts a bold element. Alternatively one may use Sink.text(String,SinkEventAttributes) with STYLE instead.

Specified by:: bold in interface Sink
Overrides:: bold in class SinkAdapter

bold_

public void bold_()

Ends a bold element. Alternatively one may use Sink.text(String,SinkEventAttributes) with STYLE instead.

Specified by:: bold_ in interface Sink
Overrides:: bold_ in class SinkAdapter

monospaced

public void monospaced()

Starts a monospaced element. Alternatively one may use Sink.text(String,SinkEventAttributes) with STYLE instead.

Specified by:: monospaced in interface Sink
Overrides:: monospaced in class SinkAdapter

monospaced_

public void monospaced_()

Ends a monospaced element. Alternatively one may use Sink.text(String,SinkEventAttributes) with STYLE instead.

Specified by:: monospaced_ in interface Sink
Overrides:: monospaced_ in class SinkAdapter

lineBreak

public void lineBreak()

Adds a line break.

Specified by:: lineBreak in interface Sink
Overrides:: lineBreak in class SinkAdapter

See Also:: Sink.lineBreak(SinkEventAttributes)

nonBreakingSpace

public void nonBreakingSpace()

Adding a non breaking space, ie a space without any special formatting operations.

Specified by:: nonBreakingSpace in interface Sink
Overrides:: nonBreakingSpace in class SinkAdapter

text

public void text(String text)

Adding a text.

Specified by:: text in interface Sink
Overrides:: text in class SinkAdapter

Parameters:: text - The text to write.
See Also:: Sink.text(String,SinkEventAttributes)

unknown

public void unknown(String name,
                    Object[] requiredParams,
                    SinkEventAttributes attributes)

Add an unknown event. This may be used by parsers to notify a general Sink about an event that doesn't fit into any event defined by the Sink API. Depending on the parameters, a Sink may decide whether or not to process the event, emit it as raw text, as a comment, log it, etc. Unkown events just log a warning message but are ignored otherwise.

Specified by:: unknown in interface Sink
Overrides:: unknown in class SinkAdapter

Parameters:: name - The name of the event.; requiredParams - An optional array of required parameters to the event. May be null.; attributes - A set of SinkEventAttributes, may be null.
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()

Flush the writer or the stream, if needed. Flushing a previously-flushed Sink has no effect.

Specified by:: flush in interface Sink
Overrides:: flush in class SinkAdapter

close

public void close()

Close the writer or the stream, if needed. Closing a previously-closed Sink has no effect.

Specified by:: close in interface Sink
Overrides:: close in class SinkAdapter

init

protected void init()

This is called in Sink.head() or in Sink.close(), and can be used to set the sink into a clear state so it can be re-used.

Overrides:: init in class AbstractSink

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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

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

RtfSink

RtfSink

RtfSink

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_

sectionTitle

sectionTitle_

list

list_

listItem

listItem_

numberedList

numberedList_

numberedListItem

numberedListItem_

definitionList

definitionList_

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