RtfSink (Doxia 1.0-alpha-10 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.SinkAdapter
      org.apache.maven.doxia.module.rtf.RtfSink

All Implemented Interfaces:: Sink

public class RtfSink
extends SinkAdapter
extends SinkAdapter

Field Summary
`static double`	`DEFAULT_BOTTOM_MARGIN`
`static int`	`DEFAULT_CHAR_SET`
`static int`	`DEFAULT_CODE_PAGE`
`static java.lang.String`	`DEFAULT_DATA_FORMAT`
`static int`	`DEFAULT_FONT_SIZE`
`static java.lang.String`	`DEFAULT_IMAGE_FORMAT`
`static java.lang.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 java.lang.String`	`IMG_DATA_ASCII`
`static java.lang.String`	`IMG_DATA_RAW`
`static java.lang.String`	`IMG_FORMAT_BMP`
`static java.lang.String`	`IMG_FORMAT_WMF`
`static java.lang.String`	`IMG_TYPE_PALETTE`
`static java.lang.String`	`IMG_TYPE_RGB`
`protected java.io.OutputStream`	`stream`
`static int`	`STYLE_BOLD`
`static int`	`STYLE_ITALIC`
`static int`	`STYLE_ROMAN`
`static int`	`STYLE_TYPEWRITER`
`protected java.io.PrintWriter`	`writer`

Fields inherited from interface org.apache.maven.doxia.sink.Sink
`NUMBERING_DECIMAL, NUMBERING_LOWER_ALPHA, NUMBERING_LOWER_ROMAN, NUMBERING_UPPER_ALPHA, NUMBERING_UPPER_ROMAN, ROLE, SECTION_LEVEL_1, SECTION_LEVEL_2, SECTION_LEVEL_3, SECTION_LEVEL_4, SECTION_LEVEL_5`

Constructor Summary
`RtfSink()`
`RtfSink(java.io.OutputStream output)`
`RtfSink(java.io.OutputStream output, java.lang.String encoding)`

Method Summary
`void`	`anchor_()` Ending an anchor element.
`void`	`anchor(java.lang.String name)` Starting an element which defines an anchor.
`void`	`author_()` Ending the author element.
`void`	`author()` Starting the author element which is used to identify the author of the document.
`void`	`body_()` Ending the body element.
`void`	`body()` Starting the body of a document which contains the document's content.
`void`	`bold_()` Ending a bold element.
`void`	`bold()` Starting a bold element.
`void`	`close()` Close the writer or the stream, if needed.
`void`	`date_()` Ending the date element.
`void`	`date()` Starting the date element which is used to identify the date of the document.
`void`	`definedTerm_()` Starting a definition term element within a definition list.
`void`	`definedTerm()` Starting a definition term element within a definition list.
`void`	`definition_()` Ending a definition element within a definition list.
`void`	`definition()` Starting a definition element within a definition list.
`void`	`definitionList_()` Ending a definition list element.
`void`	`definitionList()` Starting a definition list element.
`void`	`definitionListItem_()` Ending a list item element within a definition list.
`void`	`definitionListItem()` Starting a list item element within a definition list.
`void`	`figure_()` Ending a basic image embedding element.
`void`	`figure()` Starting a basic image embedding element.
`void`	`figureCaption_()` Ending a caption of an image.
`void`	`figureCaption()` Starting a caption of an image element.
`void`	`figureGraphics(java.lang.String name)` Adding a source of a graphic.
`void`	`flush()` Flush the writer or the stream, if needed.
`void`	`head_()` Ending the head element.
`void`	`head()` Starting the head element which contains information about the current document, such as its title, that is not considered document content.
`void`	`horizontalRule()` Adding a separator of sections from a text to each other.
`void`	`italic_()` Ending an italic element.
`void`	`italic()` Starting an italic element.
`void`	`lineBreak()` Adding a line breaks.
`void`	`link_()` Ending a link element.
`void`	`link(java.lang.String name)` Starting an element which defines a link.
`void`	`list_()` Ending an unordered list element.
`void`	`list()` Starting an unordered list element.
`void`	`listItem_()` Ending a list item element within an unordered list.
`void`	`listItem()` Starting a list item element within an unordered list.
`void`	`monospaced_()` Ending a monospaced element.
`void`	`monospaced()` Starting a monospaced element.
`void`	`nonBreakingSpace()` Adding a non breaking space, ie a space without any special formatting operations.
`void`	`numberedList_()` Ending an ordered list element.
`void`	`numberedList(int numbering)` Starting an ordered list element.
`void`	`numberedListItem_()` Ending a list item element within an ordered list.
`void`	`numberedListItem()` Starting a list item element within an ordered list.
`void`	`pageBreak()` Adding a new page separator.
`void`	`paragraph_()` Ending a paragraph element.
`void`	`paragraph()` Starting an element which represents a paragraph.
`void`	`section1_()` Ending a first heading element.
`void`	`section1()` Starting a first heading element which contains the topic of the section.
`void`	`section2_()` Ending a second heading element.
`void`	`section2()` Starting a second heading element which contains the topic of the section.
`void`	`section3_()` Ending a third heading element.
`void`	`section3()` Starting a third heading element which contains the topic of the section.
`void`	`section4_()` Ending a 4th heading element.
`void`	`section4()` Starting a 4th heading element which contains the topic of the section.
`void`	`section5_()` Ending a 5th heading element.
`void`	`section5()` Starting a 5th heading element which contains the topic of the section.
`void`	`sectionTitle_()` Ending a title heading element.
`void`	`sectionTitle()` Starting a title heading element.
`void`	`setBottomMargin(double margin)`
`void`	`setCharSet(int cs)`
`void`	`setCodePage(int cp)`
`void`	`setFontSize(int size)`
`void`	`setImageCompression(boolean compression)`
`void`	`setImageDataFormat(java.lang.String format)`
`void`	`setImageFormat(java.lang.String format)`
`void`	`setImageType(java.lang.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_()` Ending a table element.
`void`	`table()` Starting a table element for marking up tabular information in a document.
`void`	`tableCaption_()` Ending a caption element of a table.
`void`	`tableCaption()` Starting a caption element of a table.
`void`	`tableCell_()` Ending a cell element.
`void`	`tableCell()` Starting a cell element which defines a cell that contains data.
`void`	`tableHeaderCell_()` Ending a cell header element.
`void`	`tableHeaderCell()` Starting a cell element which defines a cell that contains header information.
`void`	`tableRow_()` Ending a row element.
`void`	`tableRow()` Starting a row element which acts as a container for a row of table cells.
`void`	`tableRows_()` Ending an element contains rows of table data.
`void`	`tableRows(int[] justification, boolean grid)` Starting an element contains rows of table data.
`void`	`text(java.lang.String text)` Adding a text.
`void`	`title_()` Ending the title element.
`void`	`title()` Starting the title element which is used to identify the document.
`void`	`verbatim_()` Ending a verbatim element.
`void`	`verbatim(boolean boxed)` Starting an element which indicates that whitespace in the enclosed text has semantic relevance.

Methods inherited from class org.apache.maven.doxia.sink.SinkAdapter
`rawText, sectionTitle1_, sectionTitle1, sectionTitle2_, sectionTitle2, sectionTitle3_, sectionTitle3, sectionTitle4_, sectionTitle4, sectionTitle5_, sectionTitle5, tableCell, tableHeaderCell`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

DEFAULT_PAPER_WIDTH

public static final double DEFAULT_PAPER_WIDTH

See Also:: Constant Field Values

DEFAULT_PAPER_HEIGHT

public static final double DEFAULT_PAPER_HEIGHT

See Also:: Constant Field Values

DEFAULT_TOP_MARGIN

public static final double DEFAULT_TOP_MARGIN

See Also:: Constant Field Values

DEFAULT_BOTTOM_MARGIN

public static final double DEFAULT_BOTTOM_MARGIN

See Also:: Constant Field Values

DEFAULT_LEFT_MARGIN

public static final double DEFAULT_LEFT_MARGIN

See Also:: Constant Field Values

DEFAULT_RIGHT_MARGIN

public static final double DEFAULT_RIGHT_MARGIN

See Also:: Constant Field Values

DEFAULT_FONT_SIZE

public static final int DEFAULT_FONT_SIZE

See Also:: Constant Field Values

DEFAULT_SPACING

public static final int DEFAULT_SPACING

See Also:: Constant Field Values

DEFAULT_RESOLUTION

public static final int DEFAULT_RESOLUTION

See Also:: Constant Field Values

DEFAULT_IMAGE_FORMAT

public static final java.lang.String DEFAULT_IMAGE_FORMAT

See Also:: Constant Field Values

DEFAULT_IMAGE_TYPE

public static final java.lang.String DEFAULT_IMAGE_TYPE

See Also:: Constant Field Values

DEFAULT_DATA_FORMAT

public static final java.lang.String DEFAULT_DATA_FORMAT

See Also:: Constant Field Values

DEFAULT_CODE_PAGE

public static final int DEFAULT_CODE_PAGE

See Also:: Constant Field Values

DEFAULT_CHAR_SET

public static final int DEFAULT_CHAR_SET

See Also:: Constant Field Values

IMG_FORMAT_BMP

public static final java.lang.String IMG_FORMAT_BMP

See Also:: Constant Field Values

IMG_FORMAT_WMF

public static final java.lang.String IMG_FORMAT_WMF

See Also:: Constant Field Values

IMG_TYPE_PALETTE

public static final java.lang.String IMG_TYPE_PALETTE

See Also:: Constant Field Values

IMG_TYPE_RGB

public static final java.lang.String IMG_TYPE_RGB

See Also:: Constant Field Values

IMG_DATA_ASCII

public static final java.lang.String IMG_DATA_ASCII

See Also:: Constant Field Values

IMG_DATA_RAW

public static final java.lang.String IMG_DATA_RAW

See Also:: Constant Field Values

STYLE_ROMAN

public static final int STYLE_ROMAN

See Also:: Constant Field Values

STYLE_ITALIC

public static final int STYLE_ITALIC

See Also:: Constant Field Values

STYLE_BOLD

public static final int STYLE_BOLD

See Also:: Constant Field Values

STYLE_TYPEWRITER

public static final int STYLE_TYPEWRITER

See Also:: Constant Field Values

writer

protected java.io.PrintWriter writer

stream

protected java.io.OutputStream stream

Constructor Detail

RtfSink

public RtfSink()
        throws java.io.IOException

Throws:: java.io.IOException

RtfSink

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

Throws:: java.io.IOException

RtfSink

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

Throws:: java.io.IOException

Method Detail

setPaperSize

public void setPaperSize(double width,
                         double height)

setTopMargin

public void setTopMargin(double margin)

setBottomMargin

public void setBottomMargin(double margin)

setLeftMargin

public void setLeftMargin(double margin)

setRightMargin

public void setRightMargin(double margin)

setFontSize

public void setFontSize(int size)

setSpacing

public void setSpacing(int spacing)

setResolution

public void setResolution(int resolution)

setImageFormat

public void setImageFormat(java.lang.String format)

setImageType

public void setImageType(java.lang.String type)

setImageDataFormat

public void setImageDataFormat(java.lang.String format)

setImageCompression

public void setImageCompression(boolean compression)

setCodePage

public void setCodePage(int cp)