public class FoSink extends AbstractXmlSink implements FoMarkup
FoSink sink = new FoSink( writer ); sink.beginDocument(); ... sink.endDocument();
Modifier and Type | Field and Description |
---|---|
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.
|
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
BANG, CDATA, DOCTYPE_START, ENTITY_START, XML_NAMESPACE
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
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
Modifier | Constructor and Description |
---|---|
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.
|
Modifier and Type | Method and Description |
---|---|
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.
|
getNameSpace, setInsertNewline, setNameSpace, writeEOL, writeSimpleTag, writeSimpleTag, writeStartTag, writeStartTag
section6_, section6, sectionTitle6_, sectionTitle6
enableLogging, getLog, unifyEOLs
protected Map<String,Set<String>> warnMessages
protected FoSink(Writer writer)
writer
- not null writer to write the result. Should be an UTF-8 Writer.
You could use newXmlWriter
methods from WriterFactory
.protected FoSink(Writer writer, String encoding)
writer
- not null writer to write the result.encoding
- the encoding used, that should be written to the generated HTML content
if not null
.protected FoSink(Writer writer, String encoding, String languageId)
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.public void load(File configFile) throws IOException
configFile
- the configuration file.IOException
- if the File cannot be read
or some error occurs when initializing the configuration parameters.public void head(SinkEventAttributes attributes)
head
in interface Sink
head
in class SinkAdapter
public void head()
head
in interface Sink
head
in class SinkAdapter
public void head_()
head_
in interface Sink
head_
in class SinkAdapter
public void title(SinkEventAttributes attributes)
title
in interface Sink
title
in class SinkAdapter
public void title()
title
in interface Sink
title
in class SinkAdapter
public void title_()
title_
in interface Sink
title_
in class SinkAdapter
public void author(SinkEventAttributes attributes)
author
in interface Sink
author
in class SinkAdapter
public void author()
author
in interface Sink
author
in class SinkAdapter
public void author_()
author_
in interface Sink
author_
in class SinkAdapter
public void date(SinkEventAttributes attributes)
date
in interface Sink
date
in class SinkAdapter
public void date()
date
in interface Sink
date
in class SinkAdapter
public void date_()
date_
in interface Sink
date_
in class SinkAdapter
public void body(SinkEventAttributes attributes)
body
in interface Sink
body
in class SinkAdapter
public void body()
body
in interface Sink
body
in class SinkAdapter
public void body_()
body_
in interface Sink
body_
in class SinkAdapter
public void sectionTitle()
sectionTitle
in interface Sink
sectionTitle
in class SinkAdapter
public void sectionTitle_()
sectionTitle_
in interface Sink
sectionTitle_
in class SinkAdapter
public void section(int level, SinkEventAttributes attributes)
section
in interface Sink
section
in class SinkAdapter
public void section_(int level)
section_
in interface Sink
section_
in class SinkAdapter
public void sectionTitle(int level, SinkEventAttributes attributes)
sectionTitle
in interface Sink
sectionTitle
in class SinkAdapter
public void sectionTitle_(int level)
sectionTitle_
in interface Sink
sectionTitle_
in class SinkAdapter
public void section1()
section1
in interface Sink
section1
in class SinkAdapter
public void sectionTitle1()
sectionTitle1
in interface Sink
sectionTitle1
in class SinkAdapter
public void sectionTitle1_()
sectionTitle1_
in interface Sink
sectionTitle1_
in class SinkAdapter
public void section1_()
section1_
in interface Sink
section1_
in class SinkAdapter
public void section2()
section2
in interface Sink
section2
in class SinkAdapter
public void sectionTitle2()
sectionTitle2
in interface Sink
sectionTitle2
in class SinkAdapter
public void sectionTitle2_()
sectionTitle2_
in interface Sink
sectionTitle2_
in class SinkAdapter
public void section2_()
section2_
in interface Sink
section2_
in class SinkAdapter
public void section3()
section3
in interface Sink
section3
in class SinkAdapter
public void sectionTitle3()
sectionTitle3
in interface Sink
sectionTitle3
in class SinkAdapter
public void sectionTitle3_()
sectionTitle3_
in interface Sink
sectionTitle3_
in class SinkAdapter
public void section3_()
section3_
in interface Sink
section3_
in class SinkAdapter
public void section4()
section4
in interface Sink
section4
in class SinkAdapter
public void sectionTitle4()
sectionTitle4
in interface Sink
sectionTitle4
in class SinkAdapter
public void sectionTitle4_()
sectionTitle4_
in interface Sink
sectionTitle4_
in class SinkAdapter
public void section4_()
section4_
in interface Sink
section4_
in class SinkAdapter
public void section5()
section5
in interface Sink
section5
in class SinkAdapter
public void sectionTitle5()
sectionTitle5
in interface Sink
sectionTitle5
in class SinkAdapter
public void sectionTitle5_()
sectionTitle5_
in interface Sink
sectionTitle5_
in class SinkAdapter
public void section5_()
section5_
in interface Sink
section5_
in class SinkAdapter
protected void resetSectionCounter()
protected String getChapterString()
public void list(SinkEventAttributes attributes)
list
in interface Sink
list
in class SinkAdapter
public void list()
list
in interface Sink
list
in class SinkAdapter
public void list_()
list_
in interface Sink
list_
in class SinkAdapter
public void listItem(SinkEventAttributes attributes)
listItem
in interface Sink
listItem
in class SinkAdapter
public void listItem()
listItem
in interface Sink
listItem
in class SinkAdapter
public void listItem_()
listItem_
in interface Sink
listItem_
in class SinkAdapter
public void numberedList(int numbering, SinkEventAttributes attributes)
numberedList
in interface Sink
numberedList
in class SinkAdapter
public void numberedList(int numbering)
numberedList
in interface Sink
numberedList
in class SinkAdapter
public void numberedList_()
numberedList_
in interface Sink
numberedList_
in class SinkAdapter
public void numberedListItem(SinkEventAttributes attributes)
numberedListItem
in interface Sink
numberedListItem
in class SinkAdapter
public void numberedListItem()
numberedListItem
in interface Sink
numberedListItem
in class SinkAdapter
public void numberedListItem_()
numberedListItem_
in interface Sink
numberedListItem_
in class SinkAdapter
public void definitionList(SinkEventAttributes attributes)
definitionList
in interface Sink
definitionList
in class SinkAdapter
public void definitionList()
definitionList
in interface Sink
definitionList
in class SinkAdapter
public void definitionList_()
definitionList_
in interface Sink
definitionList_
in class SinkAdapter
public void definitionListItem(SinkEventAttributes attributes)
definitionListItem
in interface Sink
definitionListItem
in class SinkAdapter
public void definitionListItem()
definitionListItem
in interface Sink
definitionListItem
in class SinkAdapter
public void definitionListItem_()
definitionListItem_
in interface Sink
definitionListItem_
in class SinkAdapter
public void definedTerm(SinkEventAttributes attributes)
definedTerm
in interface Sink
definedTerm
in class SinkAdapter
public void definedTerm()
definedTerm
in interface Sink
definedTerm
in class SinkAdapter
public void definedTerm_()
definedTerm_
in interface Sink
definedTerm_
in class SinkAdapter
public void definition(SinkEventAttributes attributes)
definition
in interface Sink
definition
in class SinkAdapter
public void definition()
definition
in interface Sink
definition
in class SinkAdapter
public void definition_()
definition_
in interface Sink
definition_
in class SinkAdapter
public void figure(SinkEventAttributes attributes)
figure
in interface Sink
figure
in class SinkAdapter
public void figure()
figure
in interface Sink
figure
in class SinkAdapter
public void figure_()
figure_
in interface Sink
figure_
in class SinkAdapter
public void figureGraphics(String name)
figureGraphics
in interface Sink
figureGraphics
in class SinkAdapter
public void figureGraphics(String src, SinkEventAttributes attributes)
figureGraphics
in interface Sink
figureGraphics
in class SinkAdapter
protected boolean isFigure()
public void figureCaption(SinkEventAttributes attributes)
figureCaption
in interface Sink
figureCaption
in class SinkAdapter
public void figureCaption()
figureCaption
in interface Sink
figureCaption
in class SinkAdapter
public void figureCaption_()
figureCaption_
in interface Sink
figureCaption_
in class SinkAdapter
public void paragraph()
paragraph
in interface Sink
paragraph
in class SinkAdapter
public void paragraph(SinkEventAttributes attributes)
paragraph
in interface Sink
paragraph
in class SinkAdapter
public void paragraph_()
paragraph_
in interface Sink
paragraph_
in class SinkAdapter
public void verbatim(SinkEventAttributes attributes)
verbatim
in interface Sink
verbatim
in class SinkAdapter
public void verbatim(boolean boxed)
verbatim
in interface Sink
verbatim
in class SinkAdapter
public void verbatim_()
verbatim_
in interface Sink
verbatim_
in class SinkAdapter
public void horizontalRule(SinkEventAttributes attributes)
horizontalRule
in interface Sink
horizontalRule
in class SinkAdapter
public void horizontalRule()
horizontalRule
in interface Sink
horizontalRule
in class SinkAdapter
public void pageBreak()
pageBreak
in interface Sink
pageBreak
in class SinkAdapter
public void table(SinkEventAttributes attributes)
table
in interface Sink
table
in class SinkAdapter
public void table()
table
in interface Sink
table
in class SinkAdapter
public void table_()
table_
in interface Sink
table_
in class SinkAdapter
public void tableRows(int[] justification, boolean grid)
tableRows
in interface Sink
tableRows
in class SinkAdapter
public void tableRows_()
tableRows_
in interface Sink
tableRows_
in class SinkAdapter
public void tableRow(SinkEventAttributes attributes)
tableRow
in interface Sink
tableRow
in class SinkAdapter
public void tableRow()
tableRow
in interface Sink
tableRow
in class SinkAdapter
public void tableRow_()
tableRow_
in interface Sink
tableRow_
in class SinkAdapter
public void tableCell(SinkEventAttributes attributes)
tableCell
in interface Sink
tableCell
in class SinkAdapter
public void tableCell()
tableCell
in interface Sink
tableCell
in class SinkAdapter
public void tableCell(String width)
tableCell
in interface Sink
tableCell
in class SinkAdapter
public void tableHeaderCell(SinkEventAttributes attributes)
tableHeaderCell
in interface Sink
tableHeaderCell
in class SinkAdapter
public void tableHeaderCell()
tableHeaderCell
in interface Sink
tableHeaderCell
in class SinkAdapter
public void tableHeaderCell(String width)
tableHeaderCell
in interface Sink
tableHeaderCell
in class SinkAdapter
public void tableCell_()
tableCell_
in interface Sink
tableCell_
in class SinkAdapter
public void tableHeaderCell_()
tableHeaderCell_
in interface Sink
tableHeaderCell_
in class SinkAdapter
public void tableCaption(SinkEventAttributes attributes)
tableCaption
in interface Sink
tableCaption
in class SinkAdapter
public void tableCaption()
tableCaption
in interface Sink
tableCaption
in class SinkAdapter
public void tableCaption_()
tableCaption_
in interface Sink
tableCaption_
in class SinkAdapter
public void anchor(String name, SinkEventAttributes attributes)
anchor
in interface Sink
anchor
in class SinkAdapter
public void anchor(String name)
anchor
in interface Sink
anchor
in class SinkAdapter
public void anchor_()
anchor_
in interface Sink
anchor_
in class SinkAdapter
public void link(String name, SinkEventAttributes attributes)
link
in interface Sink
link
in class SinkAdapter
public void link(String name)
link
in interface Sink
link
in class SinkAdapter
public void link_()
link_
in interface Sink
link_
in class SinkAdapter
public void italic()
italic
in interface Sink
italic
in class SinkAdapter
public void italic_()
italic_
in interface Sink
italic_
in class SinkAdapter
public void bold()
bold
in interface Sink
bold
in class SinkAdapter
public void bold_()
bold_
in interface Sink
bold_
in class SinkAdapter
public void monospaced()
monospaced
in interface Sink
monospaced
in class SinkAdapter
public void monospaced_()
monospaced_
in interface Sink
monospaced_
in class SinkAdapter
public void lineBreak(SinkEventAttributes attributes)
lineBreak
in interface Sink
lineBreak
in class SinkAdapter
public void lineBreak()
lineBreak
in interface Sink
lineBreak
in class SinkAdapter
public void nonBreakingSpace()
nonBreakingSpace
in interface Sink
nonBreakingSpace
in class SinkAdapter
public void text(String text, SinkEventAttributes attributes)
text
in interface Sink
text
in class SinkAdapter
public void text(String text)
text
in interface Sink
text
in class SinkAdapter
public void rawText(String text)
rawText
in interface Sink
rawText
in class SinkAdapter
public void flush()
flush
in interface Sink
flush
in class SinkAdapter
public void close()
close
in interface Sink
close
in class SinkAdapter
public void unknown(String name, Object[] requiredParams, SinkEventAttributes attributes)
unknown
in interface Sink
unknown
in class SinkAdapter
Sink.unknown(String,Object[],SinkEventAttributes)
public void comment(String comment)
comment
in interface Sink
comment
in class SinkAdapter
public void beginDocument()
public void endDocument()
protected FoConfiguration getFoConfiguration()
protected void writeStartTag(HTML.Tag tag, String attributeId)
tag
- The tag.attributeId
- An id identifying the attribute set.protected void writeStartTag(HTML.Tag tag, String id, String name)
tag
- The tag.id
- An id to add.name
- The name (value) of the id.protected void writeStartTag(HTML.Tag tag, String id, String name, String attributeId)
tag
- The tag.id
- An id to add.name
- The name (value) of the id.attributeId
- An id identifying the attribute set.protected void writeEmptyTag(HTML.Tag tag, String id, String name)
tag
- The tag.id
- An id to add.name
- The name (value) of the id.protected void writeEmptyTag(HTML.Tag tag, String attributeId)
tag
- The tag name.attributeId
- An id identifying the attribute set.protected void write(String text)
write
in class AbstractXmlSink
protected void writeln(String text)
text
- The text to write.protected void content(String text)
text
- The text to write.public static String escaped(String text, boolean verb)
text
- The text to process.verb
- In verbatim mode, white space and newlines are escaped.protected void writeStartTag(HTML.Tag t, MutableAttributeSet att, boolean isSimpleTag)
writeStartTag
in class AbstractXmlSink
protected void writeEndTag(HTML.Tag t)
writeEndTag
in class AbstractXmlSink
protected void startPageSequence(String initPageNumber, String headerText, String footerText)
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.protected void regionBefore(String headerText)
headerText
- The text to write in the header, if null, nothing is written.protected void regionAfter(String footerText)
footerText
- The text to write in the footer, if null, nothing is written.protected void chapterHeading(String headerText, boolean chapterNumber)
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.protected void pdfBookmarks()
protected void logMessage(String key, String msg)
msg
as is, otherwise add unique msg in warnMessages
.key
- not nullmsg
- not nullclose()
protected void init()
init
in class AbstractSink
Copyright © 2005–2016 The Apache Software Foundation. All rights reserved.