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.markup.Markup, org.apache.maven.doxia.markup.XmlMarkup, FoMarkup

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

Version:

$Id: FoSink.java 1726411 2016-01-23 16:34:09Z hboutemy $

Author:

ltheussl

Field Summary

Fields
Modifier and Type	Field	Description
`protected java.util.Map<java.lang.String,java.util.Set<java.lang.String>>`	`warnMessages`	Map of warn messages with a String as key to describe the error type and a Set as value.

Fields inherited from interface org.apache.maven.doxia.module.fo.FoMarkup
BASIC_LINK_TAG, BLOCK_TAG, BOOKMARK_TAG, BOOKMARK_TITLE_TAG, BOOKMARK_TREE_TAG, FLOW_TAG, FO_NAMESPACE, INLINE_TAG, LAYOUT_MASTER_SET_TAG, LEADER_TAG, LIST_BLOCK_TAG, LIST_ITEM_BODY_TAG, LIST_ITEM_LABEL_TAG, LIST_ITEM_TAG, PAGE_NUMBER_CITATION_TAG, PAGE_NUMBER_TAG, PAGE_SEQUENCE_TAG, REGION_AFTER_TAG, REGION_BEFORE_TAG, REGION_BODY_TAG, ROOT_TAG, SIMPLE_PAGE_MASTER_TAG, STATIC_CONTENT_TAG, TABLE_AND_CAPTION_TAG, TABLE_BODY_TAG, TABLE_CAPTION_TAG, TABLE_CELL_TAG, TABLE_COLUMN_TAG, TABLE_ROW_TAG, TABLE_TAG

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, SECTION_LEVEL_6

Fields inherited from interface org.apache.maven.doxia.markup.XmlMarkup
BANG, CDATA, DOCTYPE_START, ENTITY_START, XML_NAMESPACE

Constructor Summary

Constructors
Modifier	Constructor	Description
`protected`	`FoSink(java.io.Writer writer)`	Constructor, initialize the Writer.
`protected`	`FoSink(java.io.Writer writer, java.lang.String encoding)`	Constructor, initialize the Writer and tells which encoding is used.
`protected`	`FoSink(java.io.Writer writer, java.lang.String encoding, java.lang.String languageId)`	Constructor, initialize the Writer and tells which encoding and languageId are used.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`anchor(java.lang.String name)`
`void`	`anchor(java.lang.String name, org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`anchor_()`
`void`	`author()`
`void`	`author(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`author_()`
`void`	`beginDocument()`	Writes the beginning of a FO document.
`void`	`body()`
`void`	`body(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`body_()`
`void`	`bold()`
`void`	`bold_()`
`protected void`	`chapterHeading(java.lang.String headerText, boolean chapterNumber)`	Writes a chapter heading.
`void`	`close()`
`void`	`comment(java.lang.String comment)`
`protected void`	`content(java.lang.String text)`	Writes content, escaping special characters.
`void`	`date()`
`void`	`date(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`date_()`
`void`	`definedTerm()`
`void`	`definedTerm(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`definedTerm_()`
`void`	`definition()`
`void`	`definition(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`definition_()`
`void`	`definitionList()`
`void`	`definitionList(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`definitionList_()`
`void`	`definitionListItem()`
`void`	`definitionListItem(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`definitionListItem_()`
`void`	`endDocument()`	Writes the end of a FO document, flushes and closes the stream.
`static java.lang.String`	`escaped(java.lang.String text, boolean verb)`	Escapes special characters so that the text can be included in a fo file.
`void`	`figure()`
`void`	`figure(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`figure_()`
`void`	`figureCaption()`
`void`	`figureCaption(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`figureCaption_()`
`void`	`figureGraphics(java.lang.String name)`
`void`	`figureGraphics(java.lang.String src, org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`flush()`
`protected java.lang.String`	`getChapterString()`	Returns the current chapter number as a string.
`protected FoConfiguration`	`getFoConfiguration()`	Returns the configuration object of this sink.
`void`	`head()`
`void`	`head(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`head_()`
`void`	`horizontalRule()`
`void`	`horizontalRule(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`protected void`	`init()`
`protected boolean`	`isFigure()`	Flags if we are inside a figure.
`void`	`italic()`
`void`	`italic_()`
`void`	`lineBreak()`
`void`	`lineBreak(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`link(java.lang.String name)`
`void`	`link(java.lang.String name, org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`link_()`
`void`	`list()`
`void`	`list(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`list_()`
`void`	`listItem()`
`void`	`listItem(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`listItem_()`
`void`	`load(java.io.File configFile)`	Load configuration parameters from a File.
`protected void`	`logMessage(java.lang.String key, java.lang.String msg)`	If debug mode is enabled, log the `msg` as is, otherwise add unique msg in `warnMessages`.
`void`	`monospaced()`
`void`	`monospaced_()`
`void`	`nonBreakingSpace()`
`void`	`numberedList(int numbering)`
`void`	`numberedList(int numbering, org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`numberedList_()`
`void`	`numberedListItem()`
`void`	`numberedListItem(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`numberedListItem_()`
`void`	`pageBreak()`
`void`	`paragraph()`
`void`	`paragraph(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`paragraph_()`
`protected void`	`pdfBookmarks()`	Writes a fo:bookmark-tree.
`void`	`rawText(java.lang.String text)`
`protected void`	`regionAfter(java.lang.String footerText)`	Writes a 'xsl-region-after' block.
`protected void`	`regionBefore(java.lang.String headerText)`	Writes a 'xsl-region-before' block.
`protected void`	`resetSectionCounter()`	Resets the section counter to 0.
`void`	`section(int level, org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`section_(int level)`
`void`	`section1()`
`void`	`section1_()`
`void`	`section2()`
`void`	`section2_()`
`void`	`section3()`
`void`	`section3_()`
`void`	`section4()`
`void`	`section4_()`
`void`	`section5()`
`void`	`section5_()`
`void`	`sectionTitle()`
`void`	`sectionTitle(int level, org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`sectionTitle_()`
`void`	`sectionTitle_(int level)`
`void`	`sectionTitle1()`
`void`	`sectionTitle1_()`
`void`	`sectionTitle2()`
`void`	`sectionTitle2_()`
`void`	`sectionTitle3()`
`void`	`sectionTitle3_()`
`void`	`sectionTitle4()`
`void`	`sectionTitle4_()`
`void`	`sectionTitle5()`
`void`	`sectionTitle5_()`
`protected void`	`startPageSequence(java.lang.String initPageNumber, java.lang.String headerText, java.lang.String footerText)`	Starts a page sequence.
`void`	`table()`
`void`	`table(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`table_()`
`void`	`tableCaption()`
`void`	`tableCaption(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`tableCaption_()`
`void`	`tableCell()`
`void`	`tableCell(java.lang.String width)`
`void`	`tableCell(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`tableCell_()`
`void`	`tableHeaderCell()`
`void`	`tableHeaderCell(java.lang.String width)`
`void`	`tableHeaderCell(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`tableHeaderCell_()`
`void`	`tableRow()`
`void`	`tableRow(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`tableRow_()`
`void`	`tableRows(int[] justification, boolean grid)`
`void`	`tableRows_()`
`void`	`text(java.lang.String text)`
`void`	`text(java.lang.String text, org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`title()`
`void`	`title(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`title_()`
`void`	`unknown(java.lang.String name, java.lang.Object[] requiredParams, org.apache.maven.doxia.sink.SinkEventAttributes attributes)`	Unkown events just log a warning message but are ignored otherwise.
`void`	`verbatim(boolean boxed)`
`void`	`verbatim(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`verbatim_()`
`protected void`	`write(java.lang.String text)`	Writes a text, swallowing any exceptions.
`protected void`	`writeEmptyTag(javax.swing.text.html.HTML.Tag tag, java.lang.String attributeId)`	Writes a simple tag, appending EOL.
`protected void`	`writeEmptyTag(javax.swing.text.html.HTML.Tag tag, java.lang.String id, java.lang.String name)`	Writes an empty tag, prepending EOL.
`protected void`	`writeEndTag(javax.swing.text.html.HTML.Tag t)`
`protected void`	`writeln(java.lang.String text)`	Writes a text, appending EOL.
`protected void`	`writeStartTag(javax.swing.text.html.HTML.Tag tag, java.lang.String attributeId)`	Writes a start tag, prepending EOL.
`protected void`	`writeStartTag(javax.swing.text.html.HTML.Tag tag, java.lang.String id, java.lang.String name)`	Writes a start tag, prepending EOL.
`protected void`	`writeStartTag(javax.swing.text.html.HTML.Tag tag, java.lang.String id, java.lang.String name, java.lang.String attributeId)`	Writes a start tag, prepending EOL.
`protected void`	`writeStartTag(javax.swing.text.html.HTML.Tag t, javax.swing.text.MutableAttributeSet att, boolean isSimpleTag)`

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

Methods inherited from class org.apache.maven.doxia.sink.impl.AbstractXmlSink
getNameSpace, setInsertNewline, setNameSpace, writeEOL, writeSimpleTag, writeSimpleTag, writeStartTag, writeStartTag

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

Methods inherited from class org.apache.maven.doxia.sink.impl.SinkAdapter
section6, section6_, sectionTitle6, sectionTitle6_

- Field Detail
  - warnMessages
```
protected java.util.Map<java.lang.String,java.util.Set<java.lang.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 Detail
  - FoSink
```
protected FoSink(java.io.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(java.io.Writer writer,
                 java.lang.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(java.io.Writer writer,
                 java.lang.String encoding,
                 java.lang.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 Detail
  - load
```
public void load(java.io.File configFile)
          throws java.io.IOException
```
    Load configuration parameters from a File.
    
    Parameters:
    
    configFile - the configuration file.
    
    Throws:
    
    java.io.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)
```
    Overrides:
    
    head in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - head
```
public void head()
```
    Overrides:
    
    head in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - head_
```
public void head_()
```
    Overrides:
    
    head_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - title
```
public void title(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
```
    Overrides:
    
    title in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - title
```
public void title()
```
    Overrides:
    
    title in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - title_
```
public void title_()
```
    Overrides:
    
    title_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - author
```
public void author(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
```
    Overrides:
    
    author in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - author
```
public void author()
```
    Overrides:
    
    author in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - author_
```
public void author_()
```
    Overrides:
    
    author_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - date
```
public void date(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
```
    Overrides:
    
    date in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - date
```
public void date()
```
    Overrides:
    
    date in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - date_
```
public void date_()
```
    Overrides:
    
    date_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - body
```
public void body(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
```
    Overrides:
    
    body in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - body
```
public void body()
```
    Overrides:
    
    body in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - body_
```
public void body_()
```
    Overrides:
    
    body_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - sectionTitle
```
public void sectionTitle()
```
    Overrides:
    
    sectionTitle in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - sectionTitle_
```
public void sectionTitle_()
```
    Overrides:
    
    sectionTitle_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - section
```
public void section(int level,
                    org.apache.maven.doxia.sink.SinkEventAttributes attributes)
```
    Overrides:
    
    section in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - section_
```
public void section_(int level)
```
    Overrides:
    
    section_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - sectionTitle
```
public void sectionTitle(int level,
                         org.apache.maven.doxia.sink.SinkEventAttributes attributes)
```
    Overrides:
    
    sectionTitle in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - sectionTitle_
```
public void sectionTitle_(int level)
```
    Overrides:
    
    sectionTitle_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - section1
```
public void section1()
```
    Overrides:
    
    section1 in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - sectionTitle1
```
public void sectionTitle1()
```
    Overrides:
    
    sectionTitle1 in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - sectionTitle1_
```
public void sectionTitle1_()
```
    Overrides:
    
    sectionTitle1_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - section1_
```
public void section1_()
```
    Overrides:
    
    section1_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - section2
```
public void section2()
```
    Overrides:
    
    section2 in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - sectionTitle2
```
public void sectionTitle2()
```
    Overrides:
    
    sectionTitle2 in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - sectionTitle2_
```
public void sectionTitle2_()
```
    Overrides:
    
    sectionTitle2_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - section2_
```
public void section2_()
```
    Overrides:
    
    section2_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - section3
```
public void section3()
```
    Overrides:
    
    section3 in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - sectionTitle3
```
public void sectionTitle3()
```
    Overrides:
    
    sectionTitle3 in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - sectionTitle3_
```
public void sectionTitle3_()
```
    Overrides:
    
    sectionTitle3_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - section3_
```
public void section3_()
```
    Overrides:
    
    section3_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - section4
```
public void section4()
```
    Overrides:
    
    section4 in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - sectionTitle4
```
public void sectionTitle4()
```
    Overrides:
    
    sectionTitle4 in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - sectionTitle4_
```
public void sectionTitle4_()
```
    Overrides:
    
    sectionTitle4_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - section4_
```
public void section4_()
```
    Overrides:
    
    section4_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - section5
```
public void section5()
```
    Overrides:
    
    section5 in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - sectionTitle5
```
public void sectionTitle5()
```
    Overrides:
    
    sectionTitle5 in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - sectionTitle5_
```
public void sectionTitle5_()
```
    Overrides:
    
    sectionTitle5_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - section5_
```
public void section5_()
```
    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 java.lang.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)
```
    Overrides:
    
    list in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - list
```
public void list()
```
    Overrides:
    
    list in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - list_
```
public void list_()
```
    Overrides:
    
    list_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - listItem
```
public void listItem(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
```
    Overrides:
    
    listItem in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - listItem
```
public void listItem()
```
    Overrides:
    
    listItem in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - listItem_
```
public void listItem_()
```
    Overrides:
    
    listItem_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - numberedList
```
public void numberedList(int numbering,
                         org.apache.maven.doxia.sink.SinkEventAttributes attributes)
```
    Overrides:
    
    numberedList in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - numberedList
```
public void numberedList(int numbering)
```
    Overrides:
    
    numberedList in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - numberedList_
```
public void numberedList_()
```
    Overrides:
    
    numberedList_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - numberedListItem
```
public void numberedListItem(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
```
    Overrides:
    
    numberedListItem in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - numberedListItem
```
public void numberedListItem()
```
    Overrides:
    
    numberedListItem in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - numberedListItem_
```
public void numberedListItem_()
```
    Overrides:
    
    numberedListItem_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - definitionList
```
public void definitionList(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
```
    Overrides:
    
    definitionList in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - definitionList
```
public void definitionList()
```
    Overrides:
    
    definitionList in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - definitionList_
```
public void definitionList_()
```
    Overrides:
    
    definitionList_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - definitionListItem
```
public void definitionListItem(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
```
    Overrides:
    
    definitionListItem in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - definitionListItem
```
public void definitionListItem()
```
    Overrides:
    
    definitionListItem in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - definitionListItem_
```
public void definitionListItem_()
```
    Overrides:
    
    definitionListItem_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - definedTerm
```
public void definedTerm(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
```
    Overrides:
    
    definedTerm in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - definedTerm
```
public void definedTerm()
```
    Overrides:
    
    definedTerm in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - definedTerm_
```
public void definedTerm_()
```
    Overrides:
    
    definedTerm_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - definition
```
public void definition(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
```
    Overrides:
    
    definition in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - definition
```
public void definition()
```
    Overrides:
    
    definition in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - definition_
```
public void definition_()
```
    Overrides:
    
    definition_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - figure
```
public void figure(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
```
    Overrides:
    
    figure in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - figure
```
public void figure()
```
    Overrides:
    
    figure in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - figure_
```
public void figure_()
```
    Overrides:
    
    figure_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - figureGraphics
```
public void figureGraphics(java.lang.String name)
```
    Overrides:
    
    figureGraphics in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - figureGraphics
```
public void figureGraphics(java.lang.String src,
                           org.apache.maven.doxia.sink.SinkEventAttributes attributes)
```
    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)
```
    Overrides:
    
    figureCaption in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - figureCaption
```
public void figureCaption()
```
    Overrides:
    
    figureCaption in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - figureCaption_
```
public void figureCaption_()
```
    Overrides:
    
    figureCaption_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - paragraph
```
public void paragraph()
```
    Overrides:
    
    paragraph in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - paragraph
```
public void paragraph(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
```
    Overrides:
    
    paragraph in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - paragraph_
```
public void paragraph_()
```
    Overrides:
    
    paragraph_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - verbatim
```
public void verbatim(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
```
    Overrides:
    
    verbatim in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - verbatim
```
public void verbatim(boolean boxed)
```
    Overrides:
    
    verbatim in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - verbatim_
```
public void verbatim_()
```
    Overrides:
    
    verbatim_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - horizontalRule
```
public void horizontalRule(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
```
    Overrides:
    
    horizontalRule in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - horizontalRule
```
public void horizontalRule()
```
    Overrides:
    
    horizontalRule in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - pageBreak
```
public void pageBreak()
```
    Overrides:
    
    pageBreak in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - table
```
public void table(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
```
    Overrides:
    
    table in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - table
```
public void table()
```
    Overrides:
    
    table in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - table_
```
public void table_()
```
    Overrides:
    
    table_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - tableRows
```
public void tableRows(int[] justification,
                      boolean grid)
```
    Overrides:
    
    tableRows in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - tableRows_
```
public void tableRows_()
```
    Overrides:
    
    tableRows_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - tableRow
```
public void tableRow(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
```
    Overrides:
    
    tableRow in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - tableRow
```
public void tableRow()
```
    Overrides:
    
    tableRow in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - tableRow_
```
public void tableRow_()
```
    Overrides:
    
    tableRow_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - tableCell
```
public void tableCell(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
```
    Overrides:
    
    tableCell in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - tableCell
```
public void tableCell()
```
    Overrides:
    
    tableCell in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - tableCell
```
public void tableCell(java.lang.String width)
```
    Overrides:
    
    tableCell in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - tableHeaderCell
```
public void tableHeaderCell(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
```
    Overrides:
    
    tableHeaderCell in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - tableHeaderCell
```
public void tableHeaderCell()
```
    Overrides:
    
    tableHeaderCell in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - tableHeaderCell
```
public void tableHeaderCell(java.lang.String width)
```
    Overrides:
    
    tableHeaderCell in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - tableCell_
```
public void tableCell_()
```
    Overrides:
    
    tableCell_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - tableHeaderCell_
```
public void tableHeaderCell_()
```
    Overrides:
    
    tableHeaderCell_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - tableCaption
```
public void tableCaption(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
```
    Overrides:
    
    tableCaption in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - tableCaption
```
public void tableCaption()
```
    Overrides:
    
    tableCaption in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - tableCaption_
```
public void tableCaption_()
```
    Overrides:
    
    tableCaption_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - anchor
```
public void anchor(java.lang.String name,
                   org.apache.maven.doxia.sink.SinkEventAttributes attributes)
```
    Overrides:
    
    anchor in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - anchor
```
public void anchor(java.lang.String name)
```
    Overrides:
    
    anchor in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - anchor_
```
public void anchor_()
```
    Overrides:
    
    anchor_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - link
```
public void link(java.lang.String name,
                 org.apache.maven.doxia.sink.SinkEventAttributes attributes)
```
    Overrides:
    
    link in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - link
```
public void link(java.lang.String name)
```
    Overrides:
    
    link in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - link_
```
public void link_()
```
    Overrides:
    
    link_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - italic
```
public void italic()
```
    Overrides:
    
    italic in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - italic_
```
public void italic_()
```
    Overrides:
    
    italic_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - bold
```
public void bold()
```
    Overrides:
    
    bold in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - bold_
```
public void bold_()
```
    Overrides:
    
    bold_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - monospaced
```
public void monospaced()
```
    Overrides:
    
    monospaced in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - monospaced_
```
public void monospaced_()
```
    Overrides:
    
    monospaced_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - lineBreak
```
public void lineBreak(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
```
    Overrides:
    
    lineBreak in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - lineBreak
```
public void lineBreak()
```
    Overrides:
    
    lineBreak in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - nonBreakingSpace
```
public void nonBreakingSpace()
```
    Overrides:
    
    nonBreakingSpace in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - text
```
public void text(java.lang.String text,
                 org.apache.maven.doxia.sink.SinkEventAttributes attributes)
```
    Overrides:
    
    text in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - text
```
public void text(java.lang.String text)
```
    Overrides:
    
    text in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - rawText
```
public void rawText(java.lang.String text)
```
    Overrides:
    
    rawText in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - flush
```
public void flush()
```
    Overrides:
    
    flush in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - close
```
public void close()
```
    Overrides:
    
    close in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - unknown
```
public void unknown(java.lang.String name,
                    java.lang.Object[] requiredParams,
                    org.apache.maven.doxia.sink.SinkEventAttributes attributes)
```
    Unkown events just log a warning message but are ignored otherwise.
    
    Overrides:
    
    unknown in class org.apache.maven.doxia.sink.impl.SinkAdapter
    
    See Also:
    
    Sink.unknown(String,Object[],SinkEventAttributes)
  - comment
```
public void comment(java.lang.String comment)
```
    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(javax.swing.text.html.HTML.Tag tag,
                             java.lang.String attributeId)
```
    Writes a start tag, prepending EOL.
    
    Parameters:
    
    tag - The tag.
    
    attributeId - An id identifying the attribute set.
  - writeStartTag
```
protected void writeStartTag(javax.swing.text.html.HTML.Tag tag,
                             java.lang.String id,
                             java.lang.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(javax.swing.text.html.HTML.Tag tag,
                             java.lang.String id,
                             java.lang.String name,
                             java.lang.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(javax.swing.text.html.HTML.Tag tag,
                             java.lang.String id,
                             java.lang.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(javax.swing.text.html.HTML.Tag tag,
                             java.lang.String attributeId)
```
    Writes a simple tag, appending EOL.
    
    Parameters:
    
    tag - The tag name.
    
    attributeId - An id identifying the attribute set.
  - write
```
protected void write(java.lang.String text)
```
    Writes a text, swallowing any exceptions.
    
    Specified by:
    
    write in class org.apache.maven.doxia.sink.impl.AbstractXmlSink
  - writeln
```
protected void writeln(java.lang.String text)
```
    Writes a text, appending EOL.
    
    Parameters:
    
    text - The text to write.
  - content
```
protected void content(java.lang.String text)
```
    Writes content, escaping special characters.
    
    Parameters:
    
    text - The text to write.
  - escaped
```
public static java.lang.String escaped(java.lang.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(javax.swing.text.html.HTML.Tag t,
                             javax.swing.text.MutableAttributeSet att,
                             boolean isSimpleTag)
```
    Overrides:
    
    writeStartTag in class org.apache.maven.doxia.sink.impl.AbstractXmlSink
  - writeEndTag
```
protected void writeEndTag(javax.swing.text.html.HTML.Tag t)
```
    Overrides:
    
    writeEndTag in class org.apache.maven.doxia.sink.impl.AbstractXmlSink
  - startPageSequence
```
protected void startPageSequence(java.lang.String initPageNumber,
                                 java.lang.String headerText,
                                 java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.String key,
                          java.lang.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:
    
    close()
  - init
```
protected void init()
```
    Overrides:
    
    init in class org.apache.maven.doxia.sink.impl.AbstractSink

Class FoSink

Field Summary

Fields inherited from interface org.apache.maven.doxia.module.fo.FoMarkup

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

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

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

Constructor Summary

Method Summary

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

Methods inherited from class org.apache.maven.doxia.sink.impl.AbstractXmlSink

Methods inherited from class java.lang.Object

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

Field Detail

warnMessages

Constructor Detail

FoSink

FoSink

FoSink

Method Detail

load

head

head

head_

title

title

title_

author

author

author_

date

date

date_

body

body

body_

sectionTitle

sectionTitle_

section

section_

sectionTitle

sectionTitle_

section1

sectionTitle1

sectionTitle1_

section1_

section2

sectionTitle2

sectionTitle2_

section2_

section3

sectionTitle3

sectionTitle3_

section3_

section4

sectionTitle4

sectionTitle4_

section4_

section5

sectionTitle5

sectionTitle5_

section5_

resetSectionCounter

getChapterString

list

list

list_

listItem

listItem

listItem_

numberedList

numberedList

numberedList_

numberedListItem

numberedListItem

numberedListItem_

definitionList

definitionList

definitionList_

definitionListItem

definitionListItem