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
All Implemented Interfaces:
org.apache.maven.doxia.logging.LogEnabled, org.apache.maven.doxia.markup.Markup, org.apache.maven.doxia.markup.TextMarkup, org.apache.maven.doxia.sink.Sink

public class RtfSink extends org.apache.maven.doxia.sink.impl.AbstractTextSink
RTF Sink implementation.
Since:
1.0
  • Field Details

    • DEFAULT_PAPER_WIDTH

      public static final double DEFAULT_PAPER_WIDTH
      Paper width, 21 cm
      See Also:
    • DEFAULT_PAPER_HEIGHT

      public static final double DEFAULT_PAPER_HEIGHT
      Paper height, 29.7 cm
      See Also:
    • DEFAULT_TOP_MARGIN

      public static final double DEFAULT_TOP_MARGIN
      Paper top margin, 2 cm
      See Also:
    • DEFAULT_BOTTOM_MARGIN

      public static final double DEFAULT_BOTTOM_MARGIN
      Paper bottom margin, 2 cm
      See Also:
    • DEFAULT_LEFT_MARGIN

      public static final double DEFAULT_LEFT_MARGIN
      Paper left margin, 2 cm
      See Also:
    • DEFAULT_RIGHT_MARGIN

      public static final double DEFAULT_RIGHT_MARGIN
      Paper right margin, 2 cm
      See Also:
    • DEFAULT_FONT_SIZE

      public static final int DEFAULT_FONT_SIZE
      Font size, 10 pts
      See Also:
    • DEFAULT_SPACING

      public static final int DEFAULT_SPACING
      Spacing, 10 pts
      See Also:
    • DEFAULT_RESOLUTION

      public static final int DEFAULT_RESOLUTION
      Resolution, 72 dpi
      See Also:
    • DEFAULT_IMAGE_FORMAT

      public static final String DEFAULT_IMAGE_FORMAT
      Image format, bmp
      See Also:
    • DEFAULT_IMAGE_TYPE

      public static final String DEFAULT_IMAGE_TYPE
      Image type, palette
      See Also:
    • DEFAULT_DATA_FORMAT

      public static final String DEFAULT_DATA_FORMAT
      Data format, ascii
      See Also:
    • DEFAULT_CODE_PAGE

      public static final int DEFAULT_CODE_PAGE
      Codepage, 1252
      See Also:
    • DEFAULT_CHAR_SET

      public static final int DEFAULT_CHAR_SET
      Constant DEFAULT_CHAR_SET=0
      See Also:
    • IMG_FORMAT_BMP

      public static final String IMG_FORMAT_BMP
      Constant IMG_FORMAT_BMP="bmp"
      See Also:
    • IMG_FORMAT_WMF

      public static final String IMG_FORMAT_WMF
      Constant IMG_FORMAT_WMF="wmf"
      See Also:
    • IMG_TYPE_PALETTE

      public static final String IMG_TYPE_PALETTE
      Constant IMG_TYPE_PALETTE="palette"
      See Also:
    • IMG_TYPE_RGB

      public static final String IMG_TYPE_RGB
      Constant IMG_TYPE_RGB="rgb"
      See Also:
    • IMG_DATA_ASCII

      public static final String IMG_DATA_ASCII
      Constant IMG_DATA_ASCII="ascii"
      See Also:
    • IMG_DATA_RAW

      public static final String IMG_DATA_RAW
      Constant IMG_DATA_RAW="raw"
      See Also:
    • STYLE_ROMAN

      public static final int STYLE_ROMAN
      Constant STYLE_ROMAN=0
      See Also:
    • STYLE_ITALIC

      public static final int STYLE_ITALIC
      Constant STYLE_ITALIC=1
      See Also:
    • STYLE_BOLD

      public static final int STYLE_BOLD
      Constant STYLE_BOLD=2
      See Also:
    • STYLE_TYPEWRITER

      public static final int STYLE_TYPEWRITER
      Constant STYLE_TYPEWRITER=3
      See Also:
    • 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
    • inlineStack

      protected Stack<List<Integer>> inlineStack
      Keep track of the closing tags for inline events.
  • Constructor Details

  • Method Details

    • 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 - a String object.
    • setImageType

      public void setImageType(String type)

      Setter for the field imageType.

      Parameters:
      type - a String object.
    • setImageDataFormat

      public void setImageDataFormat(String format)

      Setter for the field imageDataFormat.

      Parameters:
      format - a String object.
    • setImageCompression

      public void setImageCompression(boolean compression)

      Setter for the field imageCompression.

      Parameters:
      compression - a boolean.
    • setCodePage

      public void setCodePage(int cp)

      Setter for the field codePage.

      Parameters:
      cp - a int.
    • setCharSet

      public void setCharSet(int cs)

      Setter for the field charSet.

      Parameters:
      cs - a int.
    • head

      public void head()
      Specified by:
      head in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      head in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • head_

      public void head_()
      Specified by:
      head_ in interface org.apache.maven.doxia.sink.Sink
      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()
      Specified by:
      title in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      title in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • title_

      public void title_()
      Specified by:
      title_ in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      title_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • author

      public void author()
      Specified by:
      author in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      author in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • author_

      public void author_()
      Specified by:
      author_ in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      author_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • date

      public void date()
      Specified by:
      date in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      date in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • date_

      public void date_()
      Specified by:
      date_ in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      date_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • body

      public void body()
      Specified by:
      body in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      body in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • body_

      public void body_()
      Specified by:
      body_ in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      body_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • section1

      public void section1()
      Specified by:
      section1 in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      section1 in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • section1_

      public void section1_()
      Specified by:
      section1_ in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      section1_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • section2

      public void section2()
      Specified by:
      section2 in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      section2 in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • section2_

      public void section2_()
      Specified by:
      section2_ in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      section2_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • section3

      public void section3()
      Specified by:
      section3 in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      section3 in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • section3_

      public void section3_()
      Specified by:
      section3_ in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      section3_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • section4

      public void section4()
      Specified by:
      section4 in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      section4 in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • section4_

      public void section4_()
      Specified by:
      section4_ in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      section4_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • section5

      public void section5()
      Specified by:
      section5 in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      section5 in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • section5_

      public void section5_()
      Specified by:
      section5_ in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      section5_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • sectionTitle

      public void sectionTitle()
      Specified by:
      sectionTitle in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      sectionTitle in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • sectionTitle_

      public void sectionTitle_()
      Specified by:
      sectionTitle_ in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      sectionTitle_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • list

      public void list()
      Specified by:
      list in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      list in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • list_

      public void list_()
      Specified by:
      list_ in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      list_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • listItem

      public void listItem()
      Specified by:
      listItem in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      listItem in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • listItem_

      public void listItem_()
      Specified by:
      listItem_ in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      listItem_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • numberedList

      public void numberedList(int numbering)
      Specified by:
      numberedList in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      numberedList in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • numberedList_

      public void numberedList_()
      Specified by:
      numberedList_ in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      numberedList_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • numberedListItem

      public void numberedListItem()
      Specified by:
      numberedListItem in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      numberedListItem in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • numberedListItem_

      public void numberedListItem_()
      Specified by:
      numberedListItem_ in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      numberedListItem_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • definitionList

      public void definitionList()
      Specified by:
      definitionList in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      definitionList in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • definitionList_

      public void definitionList_()
      Specified by:
      definitionList_ in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      definitionList_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • definitionListItem

      public void definitionListItem()
      Specified by:
      definitionListItem in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      definitionListItem in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • definitionListItem_

      public void definitionListItem_()
      Specified by:
      definitionListItem_ in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      definitionListItem_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • definedTerm

      public void definedTerm()
      Specified by:
      definedTerm in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      definedTerm in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • definedTerm_

      public void definedTerm_()
      Specified by:
      definedTerm_ in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      definedTerm_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • definition

      public void definition()
      Specified by:
      definition in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      definition in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • definition_

      public void definition_()
      Specified by:
      definition_ in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      definition_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • table

      public void table()
      Specified by:
      table in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      table in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • table_

      public void table_()
      Specified by:
      table_ in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      table_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • tableRows

      public void tableRows(int[] justification, boolean grid)
      Specified by:
      tableRows in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      tableRows in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • tableRows_

      public void tableRows_()
      Specified by:
      tableRows_ in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      tableRows_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • tableRow

      public void tableRow()
      Specified by:
      tableRow in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      tableRow in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • tableRow_

      public void tableRow_()
      Specified by:
      tableRow_ in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      tableRow_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • tableHeaderCell

      public void tableHeaderCell()
      Specified by:
      tableHeaderCell in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      tableHeaderCell in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • tableHeaderCell_

      public void tableHeaderCell_()
      Specified by:
      tableHeaderCell_ in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      tableHeaderCell_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • tableCell

      public void tableCell()
      Specified by:
      tableCell in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      tableCell in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • tableCell_

      public void tableCell_()
      Specified by:
      tableCell_ in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      tableCell_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • tableCaption

      public void tableCaption()
      Specified by:
      tableCaption in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      tableCaption in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • tableCaption_

      public void tableCaption_()
      Specified by:
      tableCaption_ in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      tableCaption_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • paragraph

      public void paragraph()
      Specified by:
      paragraph in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      paragraph in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • paragraph_

      public void paragraph_()
      Specified by:
      paragraph_ in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      paragraph_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • verbatim

      public void verbatim(boolean boxed)
      Specified by:
      verbatim in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      verbatim in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • verbatim_

      public void verbatim_()
      Specified by:
      verbatim_ in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      verbatim_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • figure

      public void figure()
      Specified by:
      figure in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      figure in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • figure_

      public void figure_()
      Specified by:
      figure_ in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      figure_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • figureGraphics

      public void figureGraphics(String name)
      Specified by:
      figureGraphics in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      figureGraphics in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • figureCaption

      public void figureCaption()
      Specified by:
      figureCaption in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      figureCaption in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • figureCaption_

      public void figureCaption_()
      Specified by:
      figureCaption_ in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      figureCaption_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • horizontalRule

      public void horizontalRule()
      Specified by:
      horizontalRule in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      horizontalRule in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • pageBreak

      public void pageBreak()
      Specified by:
      pageBreak in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      pageBreak in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • anchor

      public void anchor(String name)
      Specified by:
      anchor in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      anchor in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • anchor_

      public void anchor_()
      Specified by:
      anchor_ in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      anchor_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • link

      public void link(String name)
      Specified by:
      link in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      link in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • inline

      public void inline()
      Specified by:
      inline in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      inline in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • inline

      public void inline(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      Specified by:
      inline in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      inline in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • inline_

      public void inline_()
      Specified by:
      inline_ in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      inline_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • italic

      public void italic()
      Specified by:
      italic in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      italic in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • italic_

      public void italic_()
      Specified by:
      italic_ in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      italic_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • bold

      public void bold()
      Specified by:
      bold in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      bold in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • bold_

      public void bold_()
      Specified by:
      bold_ in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      bold_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • monospaced

      public void monospaced()
      Specified by:
      monospaced in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      monospaced in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • monospaced_

      public void monospaced_()
      Specified by:
      monospaced_ in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      monospaced_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • lineBreak

      public void lineBreak()
      Specified by:
      lineBreak in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      lineBreak in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • nonBreakingSpace

      public void nonBreakingSpace()
      Specified by:
      nonBreakingSpace in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      nonBreakingSpace in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • text

      public void text(String text)
      Specified by:
      text in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      text in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • unknown

      public void unknown(String name, Object[] requiredParams, org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      Unkown events just log a warning message but are ignored otherwise.
      Specified by:
      unknown in interface org.apache.maven.doxia.sink.Sink
      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()
      Specified by:
      flush in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      flush in class org.apache.maven.doxia.sink.impl.SinkAdapter
    • close

      public void close()
      Specified by:
      close in interface org.apache.maven.doxia.sink.Sink
      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