Class FoAggregateSink
- All Implemented Interfaces:
LogEnabled
,Markup
,XmlMarkup
,FoMarkup
,Sink
FoAggregateSink sink = new FoAggregateSink( writer ); sink.setDocumentModel( documentModel ); sink.beginDocument(); sink.coverPage(); sink.toc(); ... sink.endDocument();Note: the documentModel object contains several document metadata, but only a few of them are used in this sink (i.e. author, confidential, date and title), the others are ignored.
- Since:
- 1.1
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate int
Counts the current chapter level.private static final String
private DocumentModel
The document model to be used by this sink.private String
Name of the source file of the current document, relative to the source root.private String
Title of the chapter, used in the page header.private boolean
Content in head is ignored in aggregated documents.static final int
Table Of Content at the end of the document.static final int
No Table Of Content.static final int
Table Of Content at the start of the document.private int
Current position of the TOC, see#TOC_POSITION
private final Stack<NumberedListItem>
Used to get the current position in the TOC.Fields inherited from class org.apache.maven.doxia.module.fo.FoSink
inlineStack, warnMessages
Fields inherited from interface org.apache.maven.doxia.module.fo.FoMarkup
BASIC_LINK_TAG, BLOCK_TAG, BOOKMARK_TAG, BOOKMARK_TITLE_TAG, BOOKMARK_TREE_TAG, FLOW_TAG, FO_NAMESPACE, INLINE_TAG, LAYOUT_MASTER_SET_TAG, LEADER_TAG, LIST_BLOCK_TAG, LIST_ITEM_BODY_TAG, LIST_ITEM_LABEL_TAG, LIST_ITEM_TAG, PAGE_NUMBER_CITATION_TAG, PAGE_NUMBER_TAG, PAGE_SEQUENCE_TAG, REGION_AFTER_TAG, REGION_BEFORE_TAG, REGION_BODY_TAG, ROOT_TAG, SIMPLE_PAGE_MASTER_TAG, STATIC_CONTENT_TAG, TABLE_AND_CAPTION_TAG, TABLE_BODY_TAG, TABLE_CAPTION_TAG, TABLE_CELL_TAG, TABLE_COLUMN_TAG, TABLE_ROW_TAG, TABLE_TAG
Fields inherited from interface org.apache.maven.doxia.markup.Markup
COLON, EOL, EQUAL, GREATER_THAN, LEFT_CURLY_BRACKET, LEFT_SQUARE_BRACKET, LESS_THAN, MINUS, PLUS, QUOTE, RIGHT_CURLY_BRACKET, RIGHT_SQUARE_BRACKET, SEMICOLON, SLASH, SPACE, STAR
Fields inherited from interface org.apache.maven.doxia.sink.Sink
JUSTIFY_CENTER, JUSTIFY_LEFT, JUSTIFY_RIGHT, NUMBERING_DECIMAL, NUMBERING_LOWER_ALPHA, NUMBERING_LOWER_ROMAN, NUMBERING_UPPER_ALPHA, NUMBERING_UPPER_ROMAN, ROLE, SECTION_LEVEL_1, SECTION_LEVEL_2, SECTION_LEVEL_3, SECTION_LEVEL_4, SECTION_LEVEL_5, SECTION_LEVEL_6
Fields inherited from interface org.apache.maven.doxia.markup.XmlMarkup
BANG, CDATA, DOCTYPE_START, ENTITY_START, XML_NAMESPACE
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Starts an element which defines an anchor.void
anchor
(String name, SinkEventAttributes attributes) Starts an element which defines an anchor.void
author()
Starts an author element.void
author
(SinkEventAttributes attributes) Starts an author element.void
author_()
Ends an author element.void
body()
Starts the body of a document.void
body
(SinkEventAttributes attributes) Starts the body of a document.void
body_()
Ends the body element.protected void
chapterHeading
(String headerText, boolean chapterNumber) Writes a chapter heading.private String
chopExtension
(String name) protected void
Writes content, escaping special characters.void
Writes a cover page.private String
void
date()
Starts the date element.void
date
(SinkEventAttributes attributes) Starts the date element.void
date_()
Ends the date element.void
figureGraphics
(String name) Adding a source of a graphic.void
figureGraphics
(String src, SinkEventAttributes attributes) Adds a graphic element.private ResourceBundle
protected String
Returns the current chapter number as a string.protected String
Returns the text to write in the footer of each page.private SinkEventAttributeSet
getGraphicsAttributes
(String logo) protected String
Returns the text to write in the header of each page.private String
Translates the given name to a usable id.void
head()
Starts the head element.void
head
(SinkEventAttributes attributes) Starts the head element.void
head_()
Ends the head element.void
Starts an element which defines a link.void
link
(String name, SinkEventAttributes attributes) Starts a link.protected void
newline()
Writes EOL.protected void
Writes a fo:bookmark-tree.protected void
regionAfter
(String footerText) Writes a 'xsl-region-after' block.protected void
regionBefore
(String headerText) Writes a 'xsl-region-before' block.private void
renderBookmarkItems
(List<DocumentTOCItem> items) private String
void
setDocumentModel
(DocumentModel model) Sets the DocumentModel to be used by this sink.void
setDocumentModel
(DocumentModel model, int tocPos) Sets the DocumentModel to be used by this sink.void
setDocumentName
(String name) Sets the name of the current source document, relative to the source root.void
setDocumentTitle
(String title) Sets the title of the current document.protected void
startPageSequence
(String headerText, String footerText) Starts a page sequence, depending on the current chapter.void
title()
Starts the title element.void
title
(SinkEventAttributes attributes) Starts the title element.void
title_()
Ends the title element.void
toc()
Writes a table of contents.protected void
Write a text to the sink.private void
writeCoverBody
(DocumentCover cover, DocumentMeta meta) private void
writeCoverFooter
(DocumentCover cover, DocumentMeta meta) private void
writeCoverHead
(DocumentCover cover) protected void
writeEmptyTag
(HTML.Tag tag, String attributeId) Writes a simple tag, appending EOL.protected void
Ends a Tag without writing an EOL.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.private void
writeTocItems
(List<DocumentTOCItem> tocItems, int level) Methods inherited from class org.apache.maven.doxia.module.fo.FoSink
anchor_, beginDocument, bold, bold_, close, comment, definedTerm, definedTerm, definedTerm_, definition, definition, definition_, definitionList, definitionList, definitionList_, definitionListItem, definitionListItem, definitionListItem_, endDocument, escaped, figure, figure, figure_, figureCaption, figureCaption, figureCaption_, flush, getFoConfiguration, horizontalRule, horizontalRule, init, inline, inline, inline_, isFigure, italic, italic_, lineBreak, lineBreak, link_, list, list, list_, listItem, listItem, listItem_, load, logMessage, monospaced, monospaced_, nonBreakingSpace, numberedList, numberedList, numberedList_, numberedListItem, numberedListItem, numberedListItem_, pageBreak, paragraph, paragraph, paragraph_, rawText, resetSectionCounter, section, section_, section1, section1_, section2, section2_, section3, section3_, section4, section4_, section5, section5_, sectionTitle, sectionTitle, sectionTitle_, sectionTitle_, sectionTitle1, sectionTitle1_, sectionTitle2, sectionTitle2_, sectionTitle3, sectionTitle3_, sectionTitle4, sectionTitle4_, sectionTitle5, sectionTitle5_, startPageSequence, table, table, table_, tableCaption, tableCaption, tableCaption_, tableCell, tableCell, tableCell, tableCell_, tableHeaderCell, tableHeaderCell, tableHeaderCell, tableHeaderCell_, tableRow, tableRow, tableRow_, tableRows, tableRows_, text, text, unknown, verbatim, verbatim, verbatim_, writeEmptyTag, writeStartTag, writeStartTag
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
-
TOC_NONE
public static final int TOC_NONENo Table Of Content. -
TOC_START
public static final int TOC_STARTTable Of Content at the start of the document. -
TOC_END
public static final int TOC_ENDTable Of Content at the end of the document. -
COVER_HEADER_HEIGHT
- See Also:
-
docModel
The document model to be used by this sink. -
chapter
private int chapterCounts the current chapter level. -
docName
Name of the source file of the current document, relative to the source root. -
docTitle
Title of the chapter, used in the page header. -
ignoreText
private boolean ignoreTextContent in head is ignored in aggregated documents. -
tocPosition
private int tocPositionCurrent position of the TOC, see#TOC_POSITION
-
tocStack
Used to get the current position in the TOC.
-
-
Constructor Details
-
FoAggregateSink
Constructor.- Parameters:
writer
- The writer for writing the result.
-
-
Method Details
-
head
public void head()Starts the head element. -
head
Starts the head element.This contains information about the current document, (eg its title) that is not considered document content. The head element is optional but if it exists, it has to be unique within a sequence of Sink events that produces one output document, and it has to come before the
Sink.body(SinkEventAttributes)
element.The canonical sequence of events for the head element is:
sink.head(); sink.title(); sink.text( "Title" ); sink.title_(); sink.author(); sink.text( "Author" ); sink.author_(); sink.date(); sink.text( "Date" ); sink.date_(); sink.head_();
but none of the enclosed events is required. However, if they exist they have to occur in the order shown, and the title() and date() events have to be unique (author() events may occur any number of times).
Supported attributes are:
PROFILE
,LANG
.- Specified by:
head
in interfaceSink
- Overrides:
head
in classFoSink
- Parameters:
attributes
- A set ofSinkEventAttributes
, may benull
.
-
head_
public void head_()Ends the head element. -
title
public void title()Starts the title element. -
title
Starts the title element. This is used to identify the document.Supported attributes are the
base attributes
.- Specified by:
title
in interfaceSink
- Overrides:
title
in classFoSink
- Parameters:
attributes
- A set ofSinkEventAttributes
, may benull
.- See Also:
-
title_
public void title_()Ends the title element. -
author
public void author()Starts an author element. -
author
Starts an author element. This is used to identify the author of the document.Supported attributes are:
EMAIL
.- Specified by:
author
in interfaceSink
- Overrides:
author
in classFoSink
- Parameters:
attributes
- A set ofSinkEventAttributes
, may benull
.- See Also:
-
author_
public void author_()Ends an author element. -
date
public void date()Starts the date element. -
date
Starts the date element. This is used to identify the date of the document: there is no strict definition if it is creation date or last modification date, which are the 2 classical semantics. There is no formal formatting requirements either.
The date is recommended (but it is not a requirement) to be aligned to the ISO-8601 standard, i.e.:YYYY-MM-DD
whereYYYY
is the year in the Gregorian calendar,MM
is the month of the year between 01 (January) and 12 (December),- and
DD
is the day of the month between 01 and 31.
Supported attributes are: none.
- Specified by:
date
in interfaceSink
- Overrides:
date
in classFoSink
- Parameters:
attributes
- A set ofSinkEventAttributes
, may benull
.- See Also:
-
date_
public void date_()Ends the date element. -
body
public void body()Starts the body of a document. -
body
Starts the body of a document. This contains the document's content.Supported attributes are the
base attributes
.- Specified by:
body
in interfaceSink
- Overrides:
body
in classFoSink
- Parameters:
attributes
- A set ofSinkEventAttributes
, may benull
.- See Also:
-
body_
public void body_()Ends the body element. -
setDocumentTitle
Sets the title of the current document. This is used as a chapter title in the page header.- Parameters:
title
- the title of the current document.
-
setDocumentName
Sets the name of the current source document, relative to the source root. Used to resolve links to other source documents.- Parameters:
name
- the name for the current document.
-
setDocumentModel
Sets the DocumentModel to be used by this sink. The DocumentModel provides all the meta-information required to render a document, eg settings for the cover page, table of contents, etc.
By default, a TOC will be added at the beginning of the document.- Parameters:
model
- the DocumentModel.- See Also:
-
setDocumentModel
Sets the DocumentModel to be used by this sink. The DocumentModel provides all the meta-information required to render a document, eg settings for the cover page, table of contents, etc. -
getIdName
Translates the given name to a usable id. Prepends "./" and strips any extension.- Parameters:
name
- the name for the current document.- Returns:
- String
-
figureGraphics
Adding a source of a graphic.- Specified by:
figureGraphics
in interfaceSink
- Overrides:
figureGraphics
in classFoSink
- Parameters:
name
- the source
-
figureGraphics
Adds a graphic element.The
src
parameter should be a valid link, ie it can be an absolute URL or a link relative to the current source document.Supported attributes are the
base attributes
plus:SRC
,ALT
,WIDTH
,HEIGHT
,ALIGN
,BORDER
,HSPACE
,VSPACE
,ISMAP
,USEMAP
.If the
SRC
attribute is specified in SinkEventAttributes, it will be overridden by thesrc
parameter.- Specified by:
figureGraphics
in interfaceSink
- Overrides:
figureGraphics
in classFoSink
- Parameters:
src
- the image source, a valid URL.attributes
- A set ofSinkEventAttributes
, may benull
.- See Also:
-
anchor
Starts an element which defines an anchor. -
anchor
Starts an element which defines an anchor.The
name
parameter has to be a valid SGML NAME token. According to the HTML 4.01 specification section 6.2 SGML basic types:ID and NAME tokens must begin with a letter ([A-Za-z]) and may be followed by any number of letters, digits ([0-9]), hyphens ("-"), underscores ("_"), colons (":"), and periods (".").
Supported attributes are the
base attributes
. IfNAME
is specified in the SinkEventAttributes, it will be overwritten by thename
parameter.- Specified by:
anchor
in interfaceSink
- Overrides:
anchor
in classFoSink
- Parameters:
name
- the name of the anchor. This has to be a valid SGML NAME token.attributes
- A set ofSinkEventAttributes
, may benull
.
-
link
Starts an element which defines a link. -
link
Starts a link.The
name
parameter has to be a valid htmlhref
parameter, ie for internal links (links to an anchor within the same source document),name
should start with the character "#".Supported attributes are the
base attributes
plus:CHARSET
,COORDS
,HREF
,HREFLANG
,REL
,REV
,SHAPE
,TARGET
,TYPE
.If
HREF
is specified in the SinkEventAttributes, it will be overwritten by thename
parameter.- Specified by:
link
in interfaceSink
- Overrides:
link
in classFoSink
- Parameters:
name
- the name of the link.attributes
- A set ofSinkEventAttributes
, may benull
.
-
resolveLinkRelativeToBase
-
chopExtension
-
writeStartTag
Writes a start tag, prepending EOL.- Overrides:
writeStartTag
in classFoSink
- Parameters:
tag
- The tag.attributeId
- An id identifying the attribute set.
-
writeStartTag
Writes a start tag, prepending EOL.- Overrides:
writeStartTag
in classFoSink
- Parameters:
tag
- The tag.id
- An id to add.name
- The name (value) of the id.
-
writeEndTag
Ends a Tag without writing an EOL. For instance:</tag>
.- Overrides:
writeEndTag
in classFoSink
- Parameters:
t
- aHTML.Tag
object.
-
writeEmptyTag
Writes a simple tag, appending EOL.- Overrides:
writeEmptyTag
in classFoSink
- Parameters:
tag
- The tag name.attributeId
- An id identifying the attribute set.
-
write
Write a text to the sink. Writes a text, swallowing any exceptions. -
writeln
Writes a text, appending EOL. -
content
Writes content, escaping special characters. -
newline
protected void newline()Writes EOL. -
startPageSequence
Starts a page sequence, depending on the current chapter.- Parameters:
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.
-
getHeaderText
Returns the text to write in the header of each page.- Returns:
- String
-
getChapterString
Returns the current chapter number as a string. By default does nothing, gets overridden by AggregateSink.- Overrides:
getChapterString
in classFoSink
- Returns:
- an empty String.
-
regionBefore
Writes a 'xsl-region-before' block.- Overrides:
regionBefore
in classFoSink
- 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.- Overrides:
regionAfter
in classFoSink
- 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.- Overrides:
chapterHeading
in classFoSink
- 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.
-
toc
public void toc()Writes a table of contents. The DocumentModel has to contain a DocumentTOC for this to work. -
writeTocItems
-
currentTocNumber
-
pdfBookmarks
protected void pdfBookmarks()Writes a fo:bookmark-tree. The DocumentModel has to contain a DocumentTOC for this to work.- Overrides:
pdfBookmarks
in classFoSink
-
renderBookmarkItems
-
coverPage
public void coverPage()Writes a cover page. The DocumentModel has to contain a DocumentMeta for this to work. -
writeCoverHead
-
writeCoverBody
-
getBundle
-
getGraphicsAttributes
-