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
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 Summary
FieldsModifier and TypeFieldDescriptionKeep track of the closing tags for inline events.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
ConstructorsModifierConstructorDescriptionprotected
Constructor, initialize the Writer.protected
Constructor, initialize the Writer and tells which encoding is used.protected
Constructor, initialize the Writer and tells which encoding and languageId are used. -
Method Summary
Modifier and TypeMethodDescriptionvoid
void
void
anchor_()
void
author()
void
author
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
author_()
void
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
(String headerText, boolean chapterNumber) Writes a chapter heading.void
close()
void
protected void
Writes content, escaping special characters.void
date()
void
date
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
date_()
void
void
definedTerm
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
void
void
definition
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
void
void
definitionList
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
void
void
definitionListItem
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
void
Writes the end of a FO document, flushes and closes the stream.static String
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
void
figureCaption
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
void
figureGraphics
(String name) void
figureGraphics
(String src, org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
flush()
protected String
Returns the current chapter number as a string.protected FoConfiguration
Returns the configuration object of this sink.void
head()
void
head
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
head_()
void
void
horizontalRule
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) protected void
init()
void
inline()
void
inline
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
inline_()
protected boolean
isFigure()
Flags if we are inside a figure.void
italic()
void
italic_()
void
void
lineBreak
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
void
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
void
Load configuration parameters from a File.protected void
logMessage
(String key, String msg) If debug mode is enabled, log themsg
as is, otherwise add unique msg inwarnMessages
.void
void
void
void
numberedList
(int numbering) void
numberedList
(int numbering, org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
void
void
numberedListItem
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
void
void
void
paragraph
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
protected void
Writes a fo:bookmark-tree.void
protected void
regionAfter
(String footerText) Writes a 'xsl-region-after' block.protected void
regionBefore
(String headerText) Writes a 'xsl-region-before' block.protected void
Resets the section counter to 0.void
section
(int level, org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
section_
(int level) void
section1()
void
void
section2()
void
void
section3()
void
void
section4()
void
void
section5()
void
void
void
sectionTitle
(int level, org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
void
sectionTitle_
(int level) void
void
void
void
void
void
void
void
void
void
protected void
startPageSequence
(String initPageNumber, String headerText, String footerText) Starts a page sequence.void
table()
void
table
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
table_()
void
void
tableCaption
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
void
void
void
tableCell
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
void
void
tableHeaderCell
(String width) void
tableHeaderCell
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
void
tableRow()
void
tableRow
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
void
tableRows
(int[] justification, boolean grid) void
void
void
void
title()
void
title
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
title_()
void
unknown
(String name, 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
protected void
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
protected void
Writes a text, appending EOL.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.protected void
writeStartTag
(HTML.Tag t, MutableAttributeSet att, boolean isSimpleTag) Methods inherited from class org.apache.maven.doxia.sink.impl.AbstractXmlSink
getNameSpace, setInsertNewline, setNameSpace, writeEOL, writeSimpleTag, writeSimpleTag, writeStartTag, writeStartTag
Methods inherited from class org.apache.maven.doxia.sink.impl.SinkAdapter
address, address, address_, article, article, article_, blockquote, blockquote, blockquote_, content, content, content_, data, data, data_, division, division, division_, footer, footer, footer_, header, header, header_, lineBreakOpportunity, lineBreakOpportunity, navigation, navigation, navigation_, section6, section6_, sectionTitle6, sectionTitle6_, sidebar, sidebar, sidebar_, time, time, time_
Methods inherited from class org.apache.maven.doxia.sink.impl.AbstractSink
enableLogging, getLog, unifyEOLs
-
Field Details
-
inlineStack
Keep track of the closing tags for inline events. -
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
Constructor, initialize the Writer.- Parameters:
writer
- not null writer to write the result. Should be an UTF-8 Writer. You could usenewXmlWriter
methods fromWriterFactory
.
-
FoSink
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 notnull
.
-
FoSink
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 notnull
.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
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 interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
head
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
head
public void head()- Specified by:
head
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
head
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
head_
public void head_()- Specified by:
head_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
head_
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
title
public void title(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
title
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
title
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
title
public void title()- Specified by:
title
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
title
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
title_
public void title_()- Specified by:
title_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
title_
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
author
public void author(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
author
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
author
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
author
public void author()- Specified by:
author
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
author
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
author_
public void author_()- Specified by:
author_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
author_
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
date
public void date(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
date
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
date
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
date
public void date()- Specified by:
date
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
date
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
date_
public void date_()- Specified by:
date_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
date_
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
body
public void body(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
body
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
body
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
body
public void body()- Specified by:
body
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
body
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
body_
public void body_()- Specified by:
body_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
body_
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
sectionTitle
public void sectionTitle()- Specified by:
sectionTitle
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
sectionTitle
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
sectionTitle_
public void sectionTitle_()- Specified by:
sectionTitle_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
sectionTitle_
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
section
public void section(int level, org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
section
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
section
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
section_
public void section_(int level) - Specified by:
section_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
section_
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
sectionTitle
public void sectionTitle(int level, org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
sectionTitle
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
sectionTitle
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
sectionTitle_
public void sectionTitle_(int level) - Specified by:
sectionTitle_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
sectionTitle_
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
section1
public void section1()- Specified by:
section1
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
section1
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
sectionTitle1
public void sectionTitle1()- Specified by:
sectionTitle1
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
sectionTitle1
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
sectionTitle1_
public void sectionTitle1_()- Specified by:
sectionTitle1_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
sectionTitle1_
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
section1_
public void section1_()- Specified by:
section1_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
section1_
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
section2
public void section2()- Specified by:
section2
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
section2
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
sectionTitle2
public void sectionTitle2()- Specified by:
sectionTitle2
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
sectionTitle2
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
sectionTitle2_
public void sectionTitle2_()- Specified by:
sectionTitle2_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
sectionTitle2_
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
section2_
public void section2_()- Specified by:
section2_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
section2_
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
section3
public void section3()- Specified by:
section3
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
section3
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
sectionTitle3
public void sectionTitle3()- Specified by:
sectionTitle3
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
sectionTitle3
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
sectionTitle3_
public void sectionTitle3_()- Specified by:
sectionTitle3_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
sectionTitle3_
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
section3_
public void section3_()- Specified by:
section3_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
section3_
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
section4
public void section4()- Specified by:
section4
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
section4
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
sectionTitle4
public void sectionTitle4()- Specified by:
sectionTitle4
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
sectionTitle4
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
sectionTitle4_
public void sectionTitle4_()- Specified by:
sectionTitle4_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
sectionTitle4_
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
section4_
public void section4_()- Specified by:
section4_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
section4_
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
section5
public void section5()- Specified by:
section5
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
section5
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
sectionTitle5
public void sectionTitle5()- Specified by:
sectionTitle5
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
sectionTitle5
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
sectionTitle5_
public void sectionTitle5_()- Specified by:
sectionTitle5_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
sectionTitle5_
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
section5_
public void section5_()- Specified by:
section5_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
section5_
in classorg.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
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 interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
list
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
list
public void list()- Specified by:
list
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
list
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
list_
public void list_()- Specified by:
list_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
list_
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
listItem
public void listItem(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
listItem
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
listItem
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
listItem
public void listItem()- Specified by:
listItem
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
listItem
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
listItem_
public void listItem_()- Specified by:
listItem_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
listItem_
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
numberedList
public void numberedList(int numbering, org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
numberedList
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
numberedList
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
numberedList
public void numberedList(int numbering) - Specified by:
numberedList
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
numberedList
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
numberedList_
public void numberedList_()- Specified by:
numberedList_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
numberedList_
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
numberedListItem
public void numberedListItem(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
numberedListItem
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
numberedListItem
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
numberedListItem
public void numberedListItem()- Specified by:
numberedListItem
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
numberedListItem
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
numberedListItem_
public void numberedListItem_()- Specified by:
numberedListItem_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
numberedListItem_
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
definitionList
public void definitionList(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
definitionList
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
definitionList
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
definitionList
public void definitionList()- Specified by:
definitionList
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
definitionList
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
definitionList_
public void definitionList_()- Specified by:
definitionList_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
definitionList_
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
definitionListItem
public void definitionListItem(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
definitionListItem
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
definitionListItem
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
definitionListItem
public void definitionListItem()- Specified by:
definitionListItem
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
definitionListItem
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
definitionListItem_
public void definitionListItem_()- Specified by:
definitionListItem_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
definitionListItem_
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
definedTerm
public void definedTerm(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
definedTerm
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
definedTerm
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
definedTerm
public void definedTerm()- Specified by:
definedTerm
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
definedTerm
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
definedTerm_
public void definedTerm_()- Specified by:
definedTerm_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
definedTerm_
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
definition
public void definition(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
definition
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
definition
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
definition
public void definition()- Specified by:
definition
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
definition
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
definition_
public void definition_()- Specified by:
definition_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
definition_
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
figure
public void figure(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
figure
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
figure
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
figure
public void figure()- Specified by:
figure
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
figure
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
figure_
public void figure_()- Specified by:
figure_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
figure_
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
figureGraphics
- Specified by:
figureGraphics
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
figureGraphics
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
figureGraphics
- Specified by:
figureGraphics
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
figureGraphics
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
isFigure
protected boolean isFigure()Flags if we are inside a figure. -
figureCaption
public void figureCaption(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
figureCaption
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
figureCaption
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
figureCaption
public void figureCaption()- Specified by:
figureCaption
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
figureCaption
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
figureCaption_
public void figureCaption_()- Specified by:
figureCaption_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
figureCaption_
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
paragraph
public void paragraph()- Specified by:
paragraph
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
paragraph
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
paragraph
public void paragraph(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
paragraph
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
paragraph
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
paragraph_
public void paragraph_()- Specified by:
paragraph_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
paragraph_
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
verbatim
public void verbatim(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
verbatim
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
verbatim
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
- Parameters:
attributes
- aSinkEventAttributes
object.
-
verbatim
public void verbatim(boolean boxed) - Specified by:
verbatim
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
verbatim
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
verbatim_
public void verbatim_()- Specified by:
verbatim_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
verbatim_
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
horizontalRule
public void horizontalRule(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
horizontalRule
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
horizontalRule
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
horizontalRule
public void horizontalRule()- Specified by:
horizontalRule
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
horizontalRule
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
pageBreak
public void pageBreak()- Specified by:
pageBreak
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
pageBreak
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
table
public void table(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
table
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
table
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
table
public void table()- Specified by:
table
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
table
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
table_
public void table_()- Specified by:
table_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
table_
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
tableRows
public void tableRows(int[] justification, boolean grid) - Specified by:
tableRows
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
tableRows
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
tableRows_
public void tableRows_()- Specified by:
tableRows_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
tableRows_
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
tableRow
public void tableRow(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
tableRow
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
tableRow
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
tableRow
public void tableRow()- Specified by:
tableRow
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
tableRow
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
tableRow_
public void tableRow_()- Specified by:
tableRow_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
tableRow_
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
tableCell
public void tableCell(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
tableCell
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
tableCell
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
tableCell
public void tableCell()- Specified by:
tableCell
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
tableCell
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
tableCell
- Specified by:
tableCell
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
tableCell
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
tableHeaderCell
public void tableHeaderCell(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
tableHeaderCell
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
tableHeaderCell
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
tableHeaderCell
public void tableHeaderCell()- Specified by:
tableHeaderCell
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
tableHeaderCell
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
tableHeaderCell
- Specified by:
tableHeaderCell
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
tableHeaderCell
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
tableCell_
public void tableCell_()- Specified by:
tableCell_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
tableCell_
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
tableHeaderCell_
public void tableHeaderCell_()- Specified by:
tableHeaderCell_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
tableHeaderCell_
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
tableCaption
public void tableCaption(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
tableCaption
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
tableCaption
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
tableCaption
public void tableCaption()- Specified by:
tableCaption
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
tableCaption
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
tableCaption_
public void tableCaption_()- Specified by:
tableCaption_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
tableCaption_
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
anchor
- Specified by:
anchor
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
anchor
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
anchor
- Specified by:
anchor
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
anchor
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
anchor_
public void anchor_()- Specified by:
anchor_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
anchor_
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
link
- Specified by:
link
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
link
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
link
- Specified by:
link
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
link
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
link_
public void link_()- Specified by:
link_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
link_
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
inline
public void inline()- Specified by:
inline
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
inline
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
inline
public void inline(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
inline
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
inline
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
inline_
public void inline_()- Specified by:
inline_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
inline_
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
italic
public void italic()- Specified by:
italic
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
italic
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
italic_
public void italic_()- Specified by:
italic_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
italic_
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
bold
public void bold()- Specified by:
bold
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
bold
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
bold_
public void bold_()- Specified by:
bold_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
bold_
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
monospaced
public void monospaced()- Specified by:
monospaced
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
monospaced
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
monospaced_
public void monospaced_()- Specified by:
monospaced_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
monospaced_
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
lineBreak
public void lineBreak(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
lineBreak
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
lineBreak
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
lineBreak
public void lineBreak()- Specified by:
lineBreak
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
lineBreak
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
nonBreakingSpace
public void nonBreakingSpace()- Specified by:
nonBreakingSpace
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
nonBreakingSpace
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
text
- Specified by:
text
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
text
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
text
- Specified by:
text
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
text
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
rawText
- Specified by:
rawText
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
rawText
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
flush
public void flush()- Specified by:
flush
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
flush
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
close
public void close()- Specified by:
close
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
close
in classorg.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 interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
unknown
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
- See Also:
-
Sink.unknown(String,Object[],SinkEventAttributes)
-
comment
- Specified by:
comment
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
comment
in classorg.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
Returns the configuration object of this sink.- Returns:
- The configuration object of this sink.
-
writeStartTag
Writes a start tag, prepending EOL.- Parameters:
tag
- The tag.attributeId
- An id identifying the attribute set.
-
writeStartTag
Writes a start tag, prepending EOL.- Parameters:
tag
- The tag.id
- An id to add.name
- The name (value) of the id.
-
writeStartTag
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
Writes an empty tag, prepending EOL.- Parameters:
tag
- The tag.id
- An id to add.name
- The name (value) of the id.
-
writeEmptyTag
Writes a simple tag, appending EOL.- Parameters:
tag
- The tag name.attributeId
- An id identifying the attribute set.
-
write
Writes a text, swallowing any exceptions.- Specified by:
write
in classorg.apache.maven.doxia.sink.impl.AbstractXmlSink
-
writeln
Writes a text, appending EOL.- Parameters:
text
- The text to write.
-
content
Writes content, escaping special characters.- Parameters:
text
- The text to write.
-
escaped
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
- Overrides:
writeStartTag
in classorg.apache.maven.doxia.sink.impl.AbstractXmlSink
-
writeEndTag
- Overrides:
writeEndTag
in classorg.apache.maven.doxia.sink.impl.AbstractXmlSink
- Parameters:
t
- aHTML.Tag
object.
-
startPageSequence
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
Writes a 'xsl-region-before' block.- Parameters:
headerText
- The text to write in the header, if null, nothing is written.
-
regionAfter
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
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
If debug mode is enabled, log themsg
as is, otherwise add unique msg inwarnMessages
.- Parameters:
key
- not nullmsg
- not null- Since:
- 1.1.1
- See Also:
-
init
protected void init()- Overrides:
init
in classorg.apache.maven.doxia.sink.impl.AbstractSink
-