org.apache.maven.doxia.module.fo
Class FoSink

java.lang.Object
  org.apache.maven.doxia.sink.AbstractSink
      org.apache.maven.doxia.sink.SinkAdapter
          org.apache.maven.doxia.sink.AbstractXmlSink
              org.apache.maven.doxia.module.fo.FoSink

All Implemented Interfaces:

LogEnabled, Markup, XmlMarkup, FoMarkup, Sink

Direct Known Subclasses:

FoAggregateSink

public class FoSink
extends 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 1091053 2011-04-11 12:55:07Z ltheussl $

Author:

ltheussl

Field Summary

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.

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

BANG, CDATA, DOCTYPE_START, ENTITY_START, XML_NAMESPACE

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

COLON, EOL, EQUAL, GREATER_THAN, LEFT_CURLY_BRACKET, LEFT_SQUARE_BRACKET, LESS_THAN, MINUS, PLUS, QUOTE, RIGHT_CURLY_BRACKET, RIGHT_SQUARE_BRACKET, SEMICOLON, SLASH, SPACE, STAR

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

JUSTIFY_CENTER, JUSTIFY_LEFT, JUSTIFY_RIGHT, NUMBERING_DECIMAL, NUMBERING_LOWER_ALPHA, NUMBERING_LOWER_ROMAN, NUMBERING_UPPER_ALPHA, NUMBERING_UPPER_ROMAN, ROLE, SECTION_LEVEL_1, SECTION_LEVEL_2, SECTION_LEVEL_3, SECTION_LEVEL_4, SECTION_LEVEL_5

Constructor Summary

protected	FoSink(Writer writer) Constructor, initialize the Writer.
protected	FoSink(Writer writer, String encoding) Constructor, initialize the Writer and tells which encoding is used.
protected	FoSink(Writer writer, String encoding, String languageId) Constructor, initialize the Writer and tells which encoding and languageId are used.

Method Summary

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

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

getNameSpace, setNameSpace, writeEOL, writeSimpleTag, writeSimpleTag, writeStartTag, writeStartTag

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

enableLogging, getLog, unifyEOLs

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

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 Detail

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 Detail

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

Specified by:

head in interface Sink

Overrides:

head in class SinkAdapter

head

public void head()

Specified by:

head in interface Sink

Overrides:

head in class SinkAdapter

head_

public void head_()

Specified by:

head_ in interface Sink

Overrides:

head_ in class SinkAdapter

title

public void title(SinkEventAttributes attributes)

Specified by:

title in interface Sink

Overrides:

title in class SinkAdapter

title

public void title()

Specified by:

title in interface Sink

Overrides:

title in class SinkAdapter

title_

public void title_()

Specified by:

title_ in interface Sink

Overrides:

title_ in class SinkAdapter

author

public void author(SinkEventAttributes attributes)

Specified by:

author in interface Sink

Overrides:

author in class SinkAdapter

author

public void author()

Specified by:

author in interface Sink

Overrides:

author in class SinkAdapter

author_

public void author_()

Specified by:

author_ in interface Sink

Overrides:

author_ in class SinkAdapter

date

public void date(SinkEventAttributes attributes)

Specified by:

date in interface Sink

Overrides:

date in class SinkAdapter

date

public void date()

Specified by:

date in interface Sink

Overrides:

date in class SinkAdapter

date_

public void date_()

Specified by:

date_ in interface Sink

Overrides:

date_ in class SinkAdapter

body

public void body(SinkEventAttributes attributes)

Specified by:

body in interface Sink

Overrides:

body in class SinkAdapter

body

public void body()

Specified by:

body in interface Sink

Overrides:

body in class SinkAdapter

body_

public void body_()

Specified by:

body_ in interface Sink

Overrides:

body_ in class SinkAdapter

sectionTitle

public void sectionTitle()

Specified by:

sectionTitle in interface Sink

Overrides:

sectionTitle in class SinkAdapter

sectionTitle_

public void sectionTitle_()

Specified by:

sectionTitle_ in interface Sink

Overrides:

sectionTitle_ in class SinkAdapter

section

public void section(int level,
                    SinkEventAttributes attributes)

Specified by:

section in interface Sink

Overrides:

section in class SinkAdapter

section_

public void section_(int level)

Specified by:

section_ in interface Sink

Overrides:

section_ in class SinkAdapter

sectionTitle

public void sectionTitle(int level,
                         SinkEventAttributes attributes)

Specified by:

sectionTitle in interface Sink

Overrides:

sectionTitle in class SinkAdapter

sectionTitle_

public void sectionTitle_(int level)

Specified by:

sectionTitle_ in interface Sink

Overrides:

sectionTitle_ in class SinkAdapter

section1

public void section1()

Specified by:

section1 in interface Sink

Overrides:

section1 in class SinkAdapter

sectionTitle1

public void sectionTitle1()

Specified by:

sectionTitle1 in interface Sink

Overrides:

sectionTitle1 in class SinkAdapter

sectionTitle1_

public void sectionTitle1_()

Specified by:

sectionTitle1_ in interface Sink

Overrides:

sectionTitle1_ in class SinkAdapter

section1_

public void section1_()

Specified by:

section1_ in interface Sink

Overrides:

section1_ in class SinkAdapter

section2

public void section2()

Specified by:

section2 in interface Sink

Overrides:

section2 in class SinkAdapter

sectionTitle2

public void sectionTitle2()

Specified by:

sectionTitle2 in interface Sink

Overrides:

sectionTitle2 in class SinkAdapter

sectionTitle2_

public void sectionTitle2_()

Specified by:

sectionTitle2_ in interface Sink

Overrides:

sectionTitle2_ in class SinkAdapter

section2_

public void section2_()

Specified by:

section2_ in interface Sink

Overrides:

section2_ in class SinkAdapter

section3

public void section3()

Specified by:

section3 in interface Sink

Overrides:

section3 in class SinkAdapter

sectionTitle3

public void sectionTitle3()

Specified by:

sectionTitle3 in interface Sink

Overrides:

sectionTitle3 in class SinkAdapter

sectionTitle3_

public void sectionTitle3_()

Specified by:

sectionTitle3_ in interface Sink

Overrides:

sectionTitle3_ in class SinkAdapter

section3_

public void section3_()

Specified by:

section3_ in interface Sink

Overrides:

section3_ in class SinkAdapter

section4

public void section4()

Specified by:

section4 in interface Sink

Overrides:

section4 in class SinkAdapter

sectionTitle4

public void sectionTitle4()

Specified by:

sectionTitle4 in interface Sink

Overrides:

sectionTitle4 in class SinkAdapter

sectionTitle4_

public void sectionTitle4_()

Specified by:

sectionTitle4_ in interface Sink

Overrides:

sectionTitle4_ in class SinkAdapter

section4_

public void section4_()

Specified by:

section4_ in interface Sink

Overrides:

section4_ in class SinkAdapter

section5

public void section5()

Specified by:

section5 in interface Sink

Overrides:

section5 in class SinkAdapter

sectionTitle5

public void sectionTitle5()

Specified by:

sectionTitle5 in interface Sink

Overrides:

sectionTitle5 in class SinkAdapter

sectionTitle5_

public void sectionTitle5_()

Specified by:

sectionTitle5_ in interface Sink

Overrides:

sectionTitle5_ in class SinkAdapter

section5_

public void section5_()

Specified by:

section5_ in interface Sink

Overrides:

section5_ in class 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(SinkEventAttributes attributes)

Specified by:

list in interface Sink

Overrides:

list in class SinkAdapter

list

public void list()

Specified by:

list in interface Sink

Overrides:

list in class SinkAdapter

list_

public void list_()

Specified by:

list_ in interface Sink

Overrides:

list_ in class SinkAdapter

listItem

public void listItem(SinkEventAttributes attributes)

Specified by:

listItem in interface Sink

Overrides:

listItem in class SinkAdapter

listItem

public void listItem()

Specified by:

listItem in interface Sink

Overrides:

listItem in class SinkAdapter

listItem_

public void listItem_()

Specified by:

listItem_ in interface Sink

Overrides:

listItem_ in class SinkAdapter

numberedList

public void numberedList(int numbering,
                         SinkEventAttributes attributes)

Specified by:

numberedList in interface Sink

Overrides:

numberedList in class SinkAdapter

numberedList

public void numberedList(int numbering)

Specified by:

numberedList in interface Sink

Overrides:

numberedList in class SinkAdapter

numberedList_

public void numberedList_()

Specified by:

numberedList_ in interface Sink

Overrides:

numberedList_ in class SinkAdapter

numberedListItem

public void numberedListItem(SinkEventAttributes attributes)

Specified by:

numberedListItem in interface Sink

Overrides:

numberedListItem in class SinkAdapter

numberedListItem

public void numberedListItem()

Specified by:

numberedListItem in interface Sink

Overrides:

numberedListItem in class SinkAdapter

numberedListItem_

public void numberedListItem_()

Specified by:

numberedListItem_ in interface Sink

Overrides:

numberedListItem_ in class SinkAdapter

definitionList

public void definitionList(SinkEventAttributes attributes)

Specified by:

definitionList in interface Sink

Overrides:

definitionList in class SinkAdapter

definitionList

public void definitionList()

Specified by:

definitionList in interface Sink

Overrides:

definitionList in class SinkAdapter

definitionList_

public void definitionList_()

Specified by:

definitionList_ in interface Sink

Overrides:

definitionList_ in class SinkAdapter

definitionListItem

public void definitionListItem(SinkEventAttributes attributes)

Specified by:

definitionListItem in interface Sink

Overrides:

definitionListItem in class SinkAdapter

definitionListItem

public void definitionListItem()

Specified by:

definitionListItem in interface Sink

Overrides:

definitionListItem in class SinkAdapter

definitionListItem_

public void definitionListItem_()

Specified by:

definitionListItem_ in interface Sink

Overrides:

definitionListItem_ in class SinkAdapter

definedTerm

public void definedTerm(SinkEventAttributes attributes)

Specified by:

definedTerm in interface Sink

Overrides:

definedTerm in class SinkAdapter

definedTerm

public void definedTerm()

Specified by:

definedTerm in interface Sink

Overrides:

definedTerm in class SinkAdapter

definedTerm_

public void definedTerm_()

Specified by:

definedTerm_ in interface Sink

Overrides:

definedTerm_ in class SinkAdapter

definition

public void definition(SinkEventAttributes attributes)

Specified by:

definition in interface Sink

Overrides:

definition in class SinkAdapter

definition

public void definition()

Specified by:

definition in interface Sink

Overrides:

definition in class SinkAdapter

definition_

public void definition_()

Specified by:

definition_ in interface Sink

Overrides:

definition_ in class SinkAdapter

figure

public void figure(SinkEventAttributes attributes)

Specified by:

figure in interface Sink

Overrides:

figure in class SinkAdapter

figure

public void figure()

Specified by:

figure in interface Sink

Overrides:

figure in class SinkAdapter

figure_

public void figure_()

Specified by:

figure_ in interface Sink

Overrides:

figure_ in class SinkAdapter

figureGraphics

public void figureGraphics(String name)

Specified by:

figureGraphics in interface Sink

Overrides:

figureGraphics in class SinkAdapter

figureGraphics

public void figureGraphics(String src,
                           SinkEventAttributes attributes)

Specified by:

figureGraphics in interface Sink

Overrides:

figureGraphics in class 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(SinkEventAttributes attributes)

Specified by:

figureCaption in interface Sink

Overrides:

figureCaption in class SinkAdapter

figureCaption

public void figureCaption()

Specified by:

figureCaption in interface Sink

Overrides:

figureCaption in class SinkAdapter

figureCaption_

public void figureCaption_()

Specified by:

figureCaption_ in interface Sink

Overrides:

figureCaption_ in class SinkAdapter

paragraph

public void paragraph()

Specified by:

paragraph in interface Sink

Overrides:

paragraph in class SinkAdapter

paragraph

public void paragraph(SinkEventAttributes attributes)

Specified by:

paragraph in interface Sink

Overrides:

paragraph in class SinkAdapter

paragraph_

public void paragraph_()

Specified by:

paragraph_ in interface Sink

Overrides:

paragraph_ in class SinkAdapter

verbatim

public void verbatim(SinkEventAttributes attributes)

Specified by:

verbatim in interface Sink

Overrides:

verbatim in class SinkAdapter

verbatim

public void verbatim(boolean boxed)

Specified by:

verbatim in interface Sink

Overrides:

verbatim in class SinkAdapter

verbatim_

public void verbatim_()

Specified by:

verbatim_ in interface Sink

Overrides:

verbatim_ in class SinkAdapter

horizontalRule

public void horizontalRule(SinkEventAttributes attributes)

Specified by:

horizontalRule in interface Sink

Overrides:

horizontalRule in class SinkAdapter

horizontalRule

public void horizontalRule()

Specified by:

horizontalRule in interface Sink

Overrides:

horizontalRule in class SinkAdapter

pageBreak

public void pageBreak()

Specified by:

pageBreak in interface Sink

Overrides:

pageBreak in class SinkAdapter

table

public void table(SinkEventAttributes attributes)

Specified by:

table in interface Sink

Overrides:

table in class SinkAdapter

table

public void table()

Specified by:

table in interface Sink

Overrides:

table in class SinkAdapter

table_

public void table_()

Specified by:

table_ in interface Sink

Overrides:

table_ in class SinkAdapter

tableRows

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

Specified by:

tableRows in interface Sink

Overrides:

tableRows in class SinkAdapter

tableRows_

public void tableRows_()

Specified by:

tableRows_ in interface Sink

Overrides:

tableRows_ in class SinkAdapter

tableRow

public void tableRow(SinkEventAttributes attributes)

Specified by:

tableRow in interface Sink

Overrides:

tableRow in class SinkAdapter

tableRow

public void tableRow()

Specified by:

tableRow in interface Sink

Overrides:

tableRow in class SinkAdapter

tableRow_

public void tableRow_()

Specified by:

tableRow_ in interface Sink

Overrides:

tableRow_ in class SinkAdapter

tableCell

public void tableCell(SinkEventAttributes attributes)

Specified by:

tableCell in interface Sink

Overrides:

tableCell in class SinkAdapter

tableCell

public void tableCell()

Specified by:

tableCell in interface Sink

Overrides:

tableCell in class SinkAdapter

tableCell

public void tableCell(String width)

Specified by:

tableCell in interface Sink

Overrides:

tableCell in class SinkAdapter

tableHeaderCell

public void tableHeaderCell(SinkEventAttributes attributes)

Specified by:

tableHeaderCell in interface Sink

Overrides:

tableHeaderCell in class SinkAdapter

tableHeaderCell

public void tableHeaderCell()

Specified by:

tableHeaderCell in interface Sink

Overrides:

tableHeaderCell in class SinkAdapter

tableHeaderCell

public void tableHeaderCell(String width)

Specified by:

tableHeaderCell in interface Sink

Overrides:

tableHeaderCell in class SinkAdapter

tableCell_

public void tableCell_()

Specified by:

tableCell_ in interface Sink

Overrides:

tableCell_ in class SinkAdapter

tableHeaderCell_

public void tableHeaderCell_()

Specified by:

tableHeaderCell_ in interface Sink

Overrides:

tableHeaderCell_ in class SinkAdapter

tableCaption

public void tableCaption(SinkEventAttributes attributes)

Specified by:

tableCaption in interface Sink

Overrides:

tableCaption in class SinkAdapter

tableCaption

public void tableCaption()

Specified by:

tableCaption in interface Sink

Overrides:

tableCaption in class SinkAdapter

tableCaption_

public void tableCaption_()

Specified by:

tableCaption_ in interface Sink

Overrides:

tableCaption_ in class SinkAdapter

anchor

public void anchor(String name,
                   SinkEventAttributes attributes)

Specified by:

anchor in interface Sink

Overrides:

anchor in class SinkAdapter

anchor

public void anchor(String name)

Specified by:

anchor in interface Sink

Overrides:

anchor in class SinkAdapter

anchor_

public void anchor_()

Specified by:

anchor_ in interface Sink

Overrides:

anchor_ in class SinkAdapter

link

public void link(String name,
                 SinkEventAttributes attributes)

Specified by:

link in interface Sink

Overrides:

link in class SinkAdapter

link

public void link(String name)

Specified by:

link in interface Sink

Overrides:

link in class SinkAdapter

link_

public void link_()

Specified by:

link_ in interface Sink

Overrides:

link_ in class SinkAdapter

italic

public void italic()

Specified by:

italic in interface Sink

Overrides:

italic in class SinkAdapter

italic_

public void italic_()

Specified by:

italic_ in interface Sink

Overrides:

italic_ in class SinkAdapter

bold

public void bold()

Specified by:

bold in interface Sink

Overrides:

bold in class SinkAdapter

bold_

public void bold_()

Specified by:

bold_ in interface Sink

Overrides:

bold_ in class SinkAdapter

monospaced

public void monospaced()

Specified by:

monospaced in interface Sink

Overrides:

monospaced in class SinkAdapter

monospaced_

public void monospaced_()

Specified by:

monospaced_ in interface Sink

Overrides:

monospaced_ in class SinkAdapter

lineBreak

public void lineBreak(SinkEventAttributes attributes)

Specified by:

lineBreak in interface Sink

Overrides:

lineBreak in class SinkAdapter

lineBreak

public void lineBreak()

Specified by:

lineBreak in interface Sink

Overrides:

lineBreak in class SinkAdapter

nonBreakingSpace

public void nonBreakingSpace()

Specified by:

nonBreakingSpace in interface Sink

Overrides:

nonBreakingSpace in class SinkAdapter

text

public void text(String text,
                 SinkEventAttributes attributes)

Specified by:

text in interface Sink

Overrides:

text in class SinkAdapter

text

public void text(String text)

Specified by:

text in interface Sink

Overrides:

text in class SinkAdapter

rawText

public void rawText(String text)

Specified by:

rawText in interface Sink

Overrides:

rawText in class SinkAdapter

flush

public void flush()

Specified by:

flush in interface Sink

Overrides:

flush in class SinkAdapter

close

public void close()

Specified by:

close in interface Sink

Overrides:

close in class SinkAdapter

unknown

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

Unkown events just log a warning message but are ignored otherwise.

Specified by:

unknown in interface Sink

Overrides:

unknown in class SinkAdapter

See Also:

Sink.unknown(String,Object[],SinkEventAttributes)

comment

public void comment(String comment)

Specified by:

comment in interface Sink

Overrides:

comment in class 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 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 AbstractXmlSink

writeEndTag

protected void writeEndTag(HTML.Tag t)

Overrides:

writeEndTag in class AbstractXmlSink

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:

close()

init

protected void init()

Overrides:

init in class AbstractSink