org.apache.maven.doxia.book.services.renderer.xdoc
Class SectionXdocBookSink

java.lang.Object
  org.apache.maven.doxia.sink.AbstractSink
      org.apache.maven.doxia.sink.SinkAdapter
          org.apache.maven.doxia.sink.AbstractXmlSink
              org.apache.maven.doxia.sink.XhtmlBaseSink
                  org.apache.maven.doxia.module.xdoc.XdocSink
                      org.apache.maven.doxia.book.services.renderer.xdoc.AbstractXdocBookSink
                          org.apache.maven.doxia.book.services.renderer.xdoc.SectionXdocBookSink

All Implemented Interfaces:

org.apache.maven.doxia.logging.LogEnabled, HtmlMarkup, Markup, XmlMarkup, XdocMarkup, Sink

public class SectionXdocBookSink
extends AbstractXdocBookSink

A XdocSink implementation for section in a book

Version:

$Id: SectionXdocBookSink.java 782330 2009-06-07 05:55:26Z ltheussl $

Author:

Vincent Siveton

Field Summary

Fields inherited from class org.apache.maven.doxia.sink.XhtmlBaseSink

tableAttributes, tableRows

Fields inherited from interface org.apache.maven.doxia.module.xdoc.XdocMarkup

AUTHOR_TAG, DATE_TAG, DOCUMENT_TAG, MACRO_TAG, PROPERTIES_TAG, SECTION_TAG, SOURCE_TAG, SUBSECTION_TAG, XDOC_NAMESPACE, XDOC_SYSTEM_ID

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

A, ABBR, ACRONYM, ADDRESS, APPLET, AREA, B, BASE, BASEFONT, BDO, BIG, BLOCKQUOTE, BODY, BR, BUTTON, CAPTION, CDATA_TYPE, CENTER, CITE, CODE, COL, COLGROUP, DD, DEL, DFN, DIR, DIV, DL, DT, EM, ENTITY_TYPE, FIELDSET, FONT, FORM, FRAME, FRAMESET, H1, H2, H3, H4, H5, H6, HEAD, HR, HTML, I, IFRAME, IMG, INPUT, INS, ISINDEX, KBD, LABEL, LEGEND, LI, LINK, MAP, MENU, META, NOFRAMES, NOSCRIPT, OBJECT, OL, OPTGROUP, OPTION, P, PARAM, PRE, Q, S, SAMP, SCRIPT, SELECT, SMALL, SPAN, STRIKE, STRONG, STYLE, SUB, SUP, TABLE, TAG_TYPE_END, TAG_TYPE_SIMPLE, TAG_TYPE_START, TBODY, TD, TEXTAREA, TFOOT, TH, THEAD, TITLE, TR, TT, U, UL, VAR

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

BANG, CDATA, DOCTYPE_START, ENTITY_START, XML_NAMESPACE

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

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

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

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

Constructor Summary

SectionXdocBookSink(Writer out, IndexEntry indexEntry, org.codehaus.plexus.i18n.I18N i18n, Locale locale)
Default constructor.

Method Summary

protected void	navigationPanel() Add a navigation panel.
protected void	next(IndexEntry parent, IndexEntry nextEntry) Add next link.
protected void	previous(IndexEntry parent, IndexEntry prevEntry) Add previous link.
protected void	up(IndexEntry parent) Add parent/up link.

Methods inherited from class org.apache.maven.doxia.book.services.renderer.xdoc.AbstractXdocBookSink

body_, body, date_, getString

Methods inherited from class org.apache.maven.doxia.module.xdoc.XdocSink

author_, body, close, head_, head, head, init, link, markup, onSection_, onSection, onSectionTitle_, onSectionTitle, tableRow, tableRows, title_, title, verbatim_, verbatim

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

anchor_, anchor, anchor, bold_, bold, comment, content, definedTerm_, definedTerm, definedTerm, definition_, definition, definition, definitionList_, definitionList, definitionList, encodeURL, escapeHTML, figure_, figure, figure, figureCaption_, figureCaption, figureCaption, figureGraphics, figureGraphics, flush, getCellCount, getCellJustif, getTextBuffer, horizontalRule, horizontalRule, isHeadFlag, isVerbatimFlag, italic_, italic, lineBreak, lineBreak, link_, link, link, list_, list, list, listItem_, listItem, listItem, monospaced_, monospaced, nonBreakingSpace, numberedList_, numberedList, numberedList, numberedListItem_, numberedListItem, numberedListItem, pageBreak, paragraph_, paragraph, paragraph, rawText, resetState, resetTextBuffer, section_, section, section1_, section1, section2_, section2, section3_, section3, section4_, section4, section5_, section5, sectionTitle_, sectionTitle, sectionTitle1_, sectionTitle1, sectionTitle2_, sectionTitle2, sectionTitle3_, sectionTitle3, sectionTitle4_, sectionTitle4, sectionTitle5_, sectionTitle5, setCellCount, setCellJustif, setHeadFlag, setVerbatimFlag, table_, table, table, tableCaption_, tableCaption, tableCaption, tableCell_, tableCell, tableCell, tableCell, tableHeaderCell_, tableHeaderCell, tableHeaderCell, tableHeaderCell, tableRow_, tableRow, tableRows_, text, text, unknown, verbatim, verbatimContent, write, writeEndTag, writeStartTag

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

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

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

author, author, date, date, definitionListItem_, definitionListItem, definitionListItem, sectionTitle_, sectionTitle, title

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

enableLogging, getLog, unifyEOLs

Methods inherited from class java.lang.Object

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

Constructor Detail

SectionXdocBookSink

public SectionXdocBookSink(Writer out,
                           IndexEntry indexEntry,
                           org.codehaus.plexus.i18n.I18N i18n,
                           Locale locale)

Default constructor.

Parameters:

out - the Writer to use.

indexEntry - the IndexEntry.

i18n - the I18N.

locale - wanted locale.

Method Detail

navigationPanel

protected void navigationPanel()

Add a navigation panel.

Specified by:

navigationPanel in class AbstractXdocBookSink

previous

protected void previous(IndexEntry parent,
                        IndexEntry prevEntry)

Add previous link.

Parameters:

parent - the parent IndexEntry.

prevEntry - the previous IndexEntry.

up

protected void up(IndexEntry parent)

Add parent/up link.

Parameters:

parent - the parent IndexEntry.

See Also:

ChapterXdocBookSink.up()

next

protected void next(IndexEntry parent,
                    IndexEntry nextEntry)

Add next link.

Parameters:

parent - the parent IndexEntry.

nextEntry - the next IndexEntry.