Package org.apache.maven.doxia.module.fo
Class FoSink
- java.lang.Object
-
- org.apache.maven.doxia.sink.impl.AbstractSink
-
- org.apache.maven.doxia.sink.impl.SinkAdapter
-
- org.apache.maven.doxia.sink.impl.AbstractXmlSink
-
- org.apache.maven.doxia.module.fo.FoSink
-
- All Implemented Interfaces:
org.apache.maven.doxia.logging.LogEnabled,org.apache.maven.doxia.markup.Markup,org.apache.maven.doxia.markup.XmlMarkup,FoMarkup,org.apache.maven.doxia.sink.Sink
- Direct Known Subclasses:
FoAggregateSink
public class FoSink extends org.apache.maven.doxia.sink.impl.AbstractXmlSink implements FoMarkup
A Doxia Sink that produces a FO model. The usage is similar to the following:FoSink sink = new FoSink( writer ); sink.beginDocument(); ... sink.endDocument();
- Since:
- 1.1
- Author:
- ltheussl
-
-
Field Summary
Fields Modifier and Type Field Description protected java.util.Stack<java.util.List<javax.swing.text.html.HTML.Tag>>inlineStackKeep track of the closing tags for inline events.protected java.util.Map<java.lang.String,java.util.Set<java.lang.String>>warnMessagesMap 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
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedFoSink(java.io.Writer writer)Constructor, initialize the Writer.protectedFoSink(java.io.Writer writer, java.lang.String encoding)Constructor, initialize the Writer and tells which encoding is used.protectedFoSink(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 voidanchor(java.lang.String name)voidanchor(java.lang.String name, org.apache.maven.doxia.sink.SinkEventAttributes attributes)voidanchor_()voidauthor()voidauthor(org.apache.maven.doxia.sink.SinkEventAttributes attributes)voidauthor_()voidbeginDocument()Writes the beginning of a FO document.voidbody()voidbody(org.apache.maven.doxia.sink.SinkEventAttributes attributes)voidbody_()voidbold()voidbold_()protected voidchapterHeading(java.lang.String headerText, boolean chapterNumber)Writes a chapter heading.voidclose()voidcomment(java.lang.String comment)protected voidcontent(java.lang.String text)Writes content, escaping special characters.voiddate()voiddate(org.apache.maven.doxia.sink.SinkEventAttributes attributes)voiddate_()voiddefinedTerm()voiddefinedTerm(org.apache.maven.doxia.sink.SinkEventAttributes attributes)voiddefinedTerm_()voiddefinition()voiddefinition(org.apache.maven.doxia.sink.SinkEventAttributes attributes)voiddefinition_()voiddefinitionList()voiddefinitionList(org.apache.maven.doxia.sink.SinkEventAttributes attributes)voiddefinitionList_()voiddefinitionListItem()voiddefinitionListItem(org.apache.maven.doxia.sink.SinkEventAttributes attributes)voiddefinitionListItem_()voidendDocument()Writes the end of a FO document, flushes and closes the stream.static java.lang.Stringescaped(java.lang.String text, boolean verb)Escapes special characters so that the text can be included in a fo file.voidfigure()voidfigure(org.apache.maven.doxia.sink.SinkEventAttributes attributes)voidfigure_()voidfigureCaption()voidfigureCaption(org.apache.maven.doxia.sink.SinkEventAttributes attributes)voidfigureCaption_()voidfigureGraphics(java.lang.String name)voidfigureGraphics(java.lang.String src, org.apache.maven.doxia.sink.SinkEventAttributes attributes)voidflush()protected java.lang.StringgetChapterString()Returns the current chapter number as a string.protected FoConfigurationgetFoConfiguration()Returns the configuration object of this sink.voidhead()voidhead(org.apache.maven.doxia.sink.SinkEventAttributes attributes)voidhead_()voidhorizontalRule()voidhorizontalRule(org.apache.maven.doxia.sink.SinkEventAttributes attributes)protected voidinit()voidinline()voidinline(org.apache.maven.doxia.sink.SinkEventAttributes attributes)voidinline_()protected booleanisFigure()Flags if we are inside a figure.voiditalic()voiditalic_()voidlineBreak()voidlineBreak(org.apache.maven.doxia.sink.SinkEventAttributes attributes)voidlink(java.lang.String name)voidlink(java.lang.String name, org.apache.maven.doxia.sink.SinkEventAttributes attributes)voidlink_()voidlist()voidlist(org.apache.maven.doxia.sink.SinkEventAttributes attributes)voidlist_()voidlistItem()voidlistItem(org.apache.maven.doxia.sink.SinkEventAttributes attributes)voidlistItem_()voidload(java.io.File configFile)Load configuration parameters from a File.protected voidlogMessage(java.lang.String key, java.lang.String msg)If debug mode is enabled, log themsgas is, otherwise add unique msg inwarnMessages.voidmonospaced()voidmonospaced_()voidnonBreakingSpace()voidnumberedList(int numbering)voidnumberedList(int numbering, org.apache.maven.doxia.sink.SinkEventAttributes attributes)voidnumberedList_()voidnumberedListItem()voidnumberedListItem(org.apache.maven.doxia.sink.SinkEventAttributes attributes)voidnumberedListItem_()voidpageBreak()voidparagraph()voidparagraph(org.apache.maven.doxia.sink.SinkEventAttributes attributes)voidparagraph_()protected voidpdfBookmarks()Writes a fo:bookmark-tree.voidrawText(java.lang.String text)protected voidregionAfter(java.lang.String footerText)Writes a 'xsl-region-after' block.protected voidregionBefore(java.lang.String headerText)Writes a 'xsl-region-before' block.protected voidresetSectionCounter()Resets the section counter to 0.voidsection(int level, org.apache.maven.doxia.sink.SinkEventAttributes attributes)voidsection_(int level)voidsection1()voidsection1_()voidsection2()voidsection2_()voidsection3()voidsection3_()voidsection4()voidsection4_()voidsection5()voidsection5_()voidsectionTitle()voidsectionTitle(int level, org.apache.maven.doxia.sink.SinkEventAttributes attributes)voidsectionTitle_()voidsectionTitle_(int level)voidsectionTitle1()voidsectionTitle1_()voidsectionTitle2()voidsectionTitle2_()voidsectionTitle3()voidsectionTitle3_()voidsectionTitle4()voidsectionTitle4_()voidsectionTitle5()voidsectionTitle5_()protected voidstartPageSequence(java.lang.String initPageNumber, java.lang.String headerText, java.lang.String footerText)Starts a page sequence.voidtable()voidtable(org.apache.maven.doxia.sink.SinkEventAttributes attributes)voidtable_()voidtableCaption()voidtableCaption(org.apache.maven.doxia.sink.SinkEventAttributes attributes)voidtableCaption_()voidtableCell()voidtableCell(java.lang.String width)voidtableCell(org.apache.maven.doxia.sink.SinkEventAttributes attributes)voidtableCell_()voidtableHeaderCell()voidtableHeaderCell(java.lang.String width)voidtableHeaderCell(org.apache.maven.doxia.sink.SinkEventAttributes attributes)voidtableHeaderCell_()voidtableRow()voidtableRow(org.apache.maven.doxia.sink.SinkEventAttributes attributes)voidtableRow_()voidtableRows(int[] justification, boolean grid)voidtableRows_()voidtext(java.lang.String text)voidtext(java.lang.String text, org.apache.maven.doxia.sink.SinkEventAttributes attributes)voidtitle()voidtitle(org.apache.maven.doxia.sink.SinkEventAttributes attributes)voidtitle_()voidunknown(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.voidverbatim(boolean boxed)voidverbatim(org.apache.maven.doxia.sink.SinkEventAttributes attributes)voidverbatim_()protected voidwrite(java.lang.String text)Writes a text, swallowing any exceptions.protected voidwriteEmptyTag(javax.swing.text.html.HTML.Tag tag, java.lang.String attributeId)Writes a simple tag, appending EOL.protected voidwriteEmptyTag(javax.swing.text.html.HTML.Tag tag, java.lang.String id, java.lang.String name)Writes an empty tag, prepending EOL.protected voidwriteEndTag(javax.swing.text.html.HTML.Tag t)protected voidwriteln(java.lang.String text)Writes a text, appending EOL.protected voidwriteStartTag(javax.swing.text.html.HTML.Tag tag, java.lang.String attributeId)Writes a start tag, prepending EOL.protected voidwriteStartTag(javax.swing.text.html.HTML.Tag tag, java.lang.String id, java.lang.String name)Writes a start tag, prepending EOL.protected voidwriteStartTag(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 voidwriteStartTag(javax.swing.text.html.HTML.Tag t, javax.swing.text.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_
-
-
-
-
Field Detail
-
inlineStack
protected java.util.Stack<java.util.List<javax.swing.text.html.HTML.Tag>> inlineStack
Keep track of the closing tags for inline events.
-
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 usenewXmlWritermethods fromWriterFactory.
-
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 notnull.
-
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 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 Detail
-
load
public void load(java.io.File configFile) throws java.io.IOExceptionLoad 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)
- Specified by:
headin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
headin classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
head
public void head()
- Specified by:
headin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
headin 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:
titlein interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
titlein classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
title
public void title()
- Specified by:
titlein interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
titlein 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:
authorin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
authorin classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
author
public void author()
- Specified by:
authorin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
authorin 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:
datein interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
datein classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
date
public void date()
- Specified by:
datein interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
datein 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:
bodyin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
bodyin classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
body
public void body()
- Specified by:
bodyin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
bodyin 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:
sectionTitlein interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
sectionTitlein 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:
sectionin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
sectionin 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:
sectionTitlein interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
sectionTitlein 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:
section1in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
section1in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
sectionTitle1
public void sectionTitle1()
- Specified by:
sectionTitle1in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
sectionTitle1in 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:
section2in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
section2in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
sectionTitle2
public void sectionTitle2()
- Specified by:
sectionTitle2in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
sectionTitle2in 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:
section3in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
section3in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
sectionTitle3
public void sectionTitle3()
- Specified by:
sectionTitle3in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
sectionTitle3in 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:
section4in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
section4in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
sectionTitle4
public void sectionTitle4()
- Specified by:
sectionTitle4in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
sectionTitle4in 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:
section5in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
section5in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
sectionTitle5
public void sectionTitle5()
- Specified by:
sectionTitle5in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
sectionTitle5in 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
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)
- Specified by:
listin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
listin classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
list
public void list()
- Specified by:
listin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
listin 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:
listItemin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
listItemin classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
listItem
public void listItem()
- Specified by:
listItemin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
listItemin 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:
numberedListin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
numberedListin classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
numberedList
public void numberedList(int numbering)
- Specified by:
numberedListin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
numberedListin 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:
numberedListItemin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
numberedListItemin classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
numberedListItem
public void numberedListItem()
- Specified by:
numberedListItemin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
numberedListItemin 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:
definitionListin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
definitionListin classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
definitionList
public void definitionList()
- Specified by:
definitionListin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
definitionListin 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:
definitionListItemin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
definitionListItemin classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
definitionListItem
public void definitionListItem()
- Specified by:
definitionListItemin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
definitionListItemin 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:
definedTermin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
definedTermin classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
definedTerm
public void definedTerm()
- Specified by:
definedTermin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
definedTermin 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:
definitionin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
definitionin classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
definition
public void definition()
- Specified by:
definitionin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
definitionin 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:
figurein interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
figurein classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
figure
public void figure()
- Specified by:
figurein interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
figurein 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
public void figureGraphics(java.lang.String name)
- Specified by:
figureGraphicsin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
figureGraphicsin classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
figureGraphics
public void figureGraphics(java.lang.String src, org.apache.maven.doxia.sink.SinkEventAttributes attributes)- Specified by:
figureGraphicsin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
figureGraphicsin 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:
figureCaptionin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
figureCaptionin classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
figureCaption
public void figureCaption()
- Specified by:
figureCaptionin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
figureCaptionin 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:
paragraphin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
paragraphin classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
paragraph
public void paragraph(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
- Specified by:
paragraphin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
paragraphin 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:
verbatimin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
verbatimin classorg.apache.maven.doxia.sink.impl.SinkAdapter- Parameters:
attributes- aSinkEventAttributesobject.
-
verbatim
public void verbatim(boolean boxed)
- Specified by:
verbatimin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
verbatimin 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:
horizontalRulein interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
horizontalRulein classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
horizontalRule
public void horizontalRule()
- Specified by:
horizontalRulein interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
horizontalRulein classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
pageBreak
public void pageBreak()
- Specified by:
pageBreakin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
pageBreakin classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
table
public void table(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
- Specified by:
tablein interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
tablein classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
table
public void table()
- Specified by:
tablein interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
tablein 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:
tableRowsin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
tableRowsin 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:
tableRowin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
tableRowin classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
tableRow
public void tableRow()
- Specified by:
tableRowin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
tableRowin 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:
tableCellin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
tableCellin classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
tableCell
public void tableCell()
- Specified by:
tableCellin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
tableCellin classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
tableCell
public void tableCell(java.lang.String width)
- Specified by:
tableCellin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
tableCellin classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
tableHeaderCell
public void tableHeaderCell(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
- Specified by:
tableHeaderCellin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
tableHeaderCellin classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
tableHeaderCell
public void tableHeaderCell()
- Specified by:
tableHeaderCellin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
tableHeaderCellin classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
tableHeaderCell
public void tableHeaderCell(java.lang.String width)
- Specified by:
tableHeaderCellin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
tableHeaderCellin 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:
tableCaptionin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
tableCaptionin classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
tableCaption
public void tableCaption()
- Specified by:
tableCaptionin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
tableCaptionin 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
public void anchor(java.lang.String name, org.apache.maven.doxia.sink.SinkEventAttributes attributes)- Specified by:
anchorin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
anchorin classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
anchor
public void anchor(java.lang.String name)
- Specified by:
anchorin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
anchorin 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
public void link(java.lang.String name, org.apache.maven.doxia.sink.SinkEventAttributes attributes)- Specified by:
linkin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
linkin classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
link
public void link(java.lang.String name)
- Specified by:
linkin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
linkin 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:
inlinein interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
inlinein classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
inline
public void inline(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
- Specified by:
inlinein interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
inlinein 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:
italicin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
italicin 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:
boldin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
boldin 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:
monospacedin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
monospacedin 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:
lineBreakin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
lineBreakin classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
lineBreak
public void lineBreak()
- Specified by:
lineBreakin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
lineBreakin classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
nonBreakingSpace
public void nonBreakingSpace()
- Specified by:
nonBreakingSpacein interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
nonBreakingSpacein classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
text
public void text(java.lang.String text, org.apache.maven.doxia.sink.SinkEventAttributes attributes)- Specified by:
textin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
textin classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
text
public void text(java.lang.String text)
- Specified by:
textin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
textin classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
rawText
public void rawText(java.lang.String text)
- Specified by:
rawTextin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
rawTextin classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
flush
public void flush()
- Specified by:
flushin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
flushin classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
close
public void close()
- Specified by:
closein interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
closein classorg.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.- Specified by:
unknownin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
unknownin classorg.apache.maven.doxia.sink.impl.SinkAdapter- See Also:
Sink.unknown(String,Object[],SinkEventAttributes)
-
comment
public void comment(java.lang.String comment)
- Specified by:
commentin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
commentin 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
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:
writein classorg.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:
writeStartTagin classorg.apache.maven.doxia.sink.impl.AbstractXmlSink
-
writeEndTag
protected void writeEndTag(javax.swing.text.html.HTML.Tag t)
- Overrides:
writeEndTagin classorg.apache.maven.doxia.sink.impl.AbstractXmlSink- Parameters:
t- aHTML.Tagobject.
-
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 themsgas is, otherwise add unique msg inwarnMessages.- Parameters:
key- not nullmsg- not null- Since:
- 1.1.1
- See Also:
close()
-
init
protected void init()
- Overrides:
initin classorg.apache.maven.doxia.sink.impl.AbstractSink
-
-