Package org.apache.maven.doxia.module.fo

Class FoSink

java.lang.Object
org.apache.maven.doxia.sink.impl.AbstractSink
org.apache.maven.doxia.sink.impl.SinkAdapter
org.apache.maven.doxia.sink.impl.AbstractXmlSink
org.apache.maven.doxia.module.fo.FoSink
All Implemented Interfaces:
org.apache.maven.doxia.logging.LogEnabled, org.apache.maven.doxia.markup.Markup, org.apache.maven.doxia.markup.XmlMarkup, FoMarkup, org.apache.maven.doxia.sink.Sink
Direct Known Subclasses:
FoAggregateSink
public class FoSink extends org.apache.maven.doxia.sink.impl.AbstractXmlSink implements FoMarkup
A Doxia Sink that produces a FO model. The usage is similar to the following: 
 FoSink sink = new FoSink( writer );
 sink.beginDocument();
 ...
 sink.endDocument();
Since:
1.1
Author:
ltheussl

  • Field Details

    • inlineStack

      protected Stack<List<HTML.Tag>> inlineStack
      Keep track of the closing tags for inline events.

    • warnMessages

      protected Map<String,Set<String>> warnMessages
      Map of warn messages with a String as key to describe the error type and a Set as value. Using to reduce warn messages.

  • Constructor Details

    • FoSink

      protected FoSink(Writer writer)
      Constructor, initialize the Writer.
      Parameters:
      writer - not null writer to write the result. Should be an UTF-8 Writer. You could use newXmlWriter methods from WriterFactory.

    • FoSink

      protected FoSink(Writer writer, String encoding)
      Constructor, initialize the Writer and tells which encoding is used.
      Parameters:
      writer - not null writer to write the result.
      encoding - the encoding used, that should be written to the generated HTML content if not null.

    • FoSink

      protected FoSink(Writer writer, String encoding, String languageId)
      Constructor, initialize the Writer and tells which encoding and languageId are used.
      Parameters:
      writer - not null writer to write the result.
      encoding - the encoding used, that should be written to the generated HTML content if not null.
      languageId - language identifier for the root element as defined by IETF BCP 47, Tags for the Identification of Languages; in addition, the empty string may be specified.

  • Method Details

    • load

      public void load(File configFile) throws IOException
      Load configuration parameters from a File.
      Parameters:
      configFile - the configuration file.
      Throws:
      IOException - if the File cannot be read or some error occurs when initializing the configuration parameters.
      Since:
      1.1.1

    • head

      public void head(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      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

    • 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

    • title

      public void title(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      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

    • 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(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      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

    • 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(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      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

    • 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(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      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

    • 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

    • 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

    • section

      public void section(int level, org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      Specified by:
      section in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      section in class org.apache.maven.doxia.sink.impl.SinkAdapter

    • section_

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

    • sectionTitle

      public void sectionTitle(int level, org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      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_(int level)
      Specified by:
      sectionTitle_ in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      sectionTitle_ 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

    • sectionTitle1

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

    • sectionTitle1_

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

    • sectionTitle2

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

    • sectionTitle2_

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

    • sectionTitle3

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

    • sectionTitle3_

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

    • sectionTitle4

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

    • sectionTitle4_

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

    • sectionTitle5

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

    • sectionTitle5_

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

    • resetSectionCounter

      protected void resetSectionCounter()
      Resets the section counter to 0. Only useful for overriding classes, like AggregateSink, the FoSink puts everything into one chapter.

    • getChapterString

      protected String getChapterString()
      Returns the current chapter number as a string. By default does nothing, gets overridden by AggregateSink.
      Returns:
      an empty String.

    • list

      public void list(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      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

    • 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(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      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

    • 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, org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      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(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(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      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

    • 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(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      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

    • 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(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      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

    • 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(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      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

    • 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(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      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

    • 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

    • figure

      public void figure(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      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

    • 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

    • figureGraphics

      public void figureGraphics(String src, org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      Specified by:
      figureGraphics in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      figureGraphics in class org.apache.maven.doxia.sink.impl.SinkAdapter

    • isFigure

      protected boolean isFigure()
      Flags if we are inside a figure.
      Returns:
      True if we are between figure() and figure_() calls.

    • figureCaption

      public void figureCaption(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      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

    • 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

    • 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(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      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(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      Specified by:
      verbatim in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      verbatim in class org.apache.maven.doxia.sink.impl.SinkAdapter
      Parameters:
      attributes - a SinkEventAttributes object.

    • 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

    • horizontalRule

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

    • table

      public void table(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      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

    • 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(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      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

    • 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

    • tableCell

      public void tableCell(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      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

    • tableCell

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

    • tableHeaderCell

      public void tableHeaderCell(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      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

    • tableHeaderCell

      public void tableHeaderCell(String width)
      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

    • 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

    • tableCaption

      public void tableCaption(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      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

    • 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

    • anchor

      public void anchor(String name, org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      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(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, org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      Specified by:
      link in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      link 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(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      Specified by:
      lineBreak in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      lineBreak 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, org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      Specified by:
      text in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      text 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

    • rawText

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

    • 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

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

    • comment

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

    • beginDocument

      public void beginDocument()
      Writes the beginning of a FO document.

    • endDocument

      public void endDocument()
      Writes the end of a FO document, flushes and closes the stream.

    • getFoConfiguration

      protected FoConfiguration getFoConfiguration()
      Returns the configuration object of this sink.
      Returns:
      The configuration object of this sink.

    • writeStartTag

      protected void writeStartTag(HTML.Tag tag, String attributeId)
      Writes a start tag, prepending EOL.
      Parameters:
      tag - The tag.
      attributeId - An id identifying the attribute set.

    • writeStartTag

      protected void writeStartTag(HTML.Tag tag, String id, String name)
      Writes a start tag, prepending EOL.
      Parameters:
      tag - The tag.
      id - An id to add.
      name - The name (value) of the id.

    • writeStartTag

      protected void writeStartTag(HTML.Tag tag, String id, String name, String attributeId)
      Writes a start tag, prepending EOL.
      Parameters:
      tag - The tag.
      id - An id to add.
      name - The name (value) of the id.
      attributeId - An id identifying the attribute set.

    • writeEmptyTag

      protected void writeEmptyTag(HTML.Tag tag, String id, String name)
      Writes an empty tag, prepending EOL.
      Parameters:
      tag - The tag.
      id - An id to add.
      name - The name (value) of the id.

    • writeEmptyTag

      protected void writeEmptyTag(HTML.Tag tag, String attributeId)
      Writes a simple tag, appending EOL.
      Parameters:
      tag - The tag name.
      attributeId - An id identifying the attribute set.

    • write

      protected void write(String text)
      Writes a text, swallowing any exceptions.
      Specified by:
      write in class org.apache.maven.doxia.sink.impl.AbstractXmlSink

    • writeln

      protected void writeln(String text)
      Writes a text, appending EOL.
      Parameters:
      text - The text to write.

    • content

      protected void content(String text)
      Writes content, escaping special characters.
      Parameters:
      text - The text to write.

    • escaped

      public static String escaped(String text, boolean verb)
      Escapes special characters so that the text can be included in a fo file.
      Parameters:
      text - The text to process.
      verb - In verbatim mode, white space and newlines are escaped.
      Returns:
      The text with special characters escaped.

    • writeStartTag

      protected void writeStartTag(HTML.Tag t, MutableAttributeSet att, boolean isSimpleTag)
      Overrides:
      writeStartTag in class org.apache.maven.doxia.sink.impl.AbstractXmlSink

    • writeEndTag

      protected void writeEndTag(HTML.Tag t)
      Overrides:
      writeEndTag in class org.apache.maven.doxia.sink.impl.AbstractXmlSink
      Parameters:
      t - a HTML.Tag object.

    • startPageSequence

      protected void startPageSequence(String initPageNumber, String headerText, String footerText)
      Starts a page sequence.
      Parameters:
      initPageNumber - The initial page number. Should be either "0" (for the first page) or "auto".
      headerText - The text to write in the header, if null, nothing is written.
      footerText - The text to write in the footer, if null, nothing is written.

    • regionBefore

      protected void regionBefore(String headerText)
      Writes a 'xsl-region-before' block.
      Parameters:
      headerText - The text to write in the header, if null, nothing is written.

    • regionAfter

      protected void regionAfter(String footerText)
      Writes a 'xsl-region-after' block. By default does nothing, gets overridden by AggregateSink.
      Parameters:
      footerText - The text to write in the footer, if null, nothing is written.

    • chapterHeading

      protected void chapterHeading(String headerText, boolean chapterNumber)
      Writes a chapter heading. By default does nothing, gets overridden by AggregateSink.
      Parameters:
      headerText - The text to write in the header, if null, the current document title is written.
      chapterNumber - True if the chapter number should be written in front of the text.

    • pdfBookmarks

      protected void pdfBookmarks()
      Writes a fo:bookmark-tree. By default does nothing, gets overridden by AggregateSink.

    • logMessage

      protected void logMessage(String key, String msg)
      If debug mode is enabled, log the msg as is, otherwise add unique msg in warnMessages.
      Parameters:
      key - not null
      msg - not null
      Since:
      1.1.1
      See Also:

    • init

      protected void init()
      Overrides:
      init in class org.apache.maven.doxia.sink.impl.AbstractSink