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

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

All Implemented Interfaces:

org.apache.maven.doxia.markup.Markup, org.apache.maven.doxia.markup.XmlMarkup, org.apache.maven.doxia.module.xdoc.XdocMarkup, org.apache.maven.doxia.sink.Sink

Direct Known Subclasses:

ChapterXdocBookSink, IndexXdocBookSink, SectionXdocBookSink

public abstract class AbstractXdocBookSink
extends org.apache.maven.doxia.module.xdoc.XdocSink

Abstract XdocSink implementation for book.

Version:

$Id: AbstractXdocBookSink.java 572956 2007-09-05 14:22:50Z ltheussl $

Author:

Trygve Laugstøl, Vincent Siveton

Field Summary

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

buffer, headFlag, out, titleFlag

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

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

BANG, CDATA

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

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

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

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

AbstractXdocBookSink(java.io.Writer out, org.codehaus.plexus.i18n.I18N i18n)
Default constructor.

Method Summary

void	author_()
void	body_()
void	body()
void	date_()
protected java.lang.String	getString(java.lang.String key) Gets a trimmed String for the given key from the resource bundle defined by Plexus.
void	head_()
void	head()
protected abstract void	navigationPanel() Add a navigation panel.
void	title_()

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

anchor_, anchor, bold_, bold, close, content, definedTerm_, definedTerm, definition_, definition, definitionList_, definitionList, encodeURL, escapeHTML, figure_, figure, figureCaption_, figureCaption, figureGraphics, flush, horizontalRule, italic_, italic, lineBreak, link_, link, list_, list, listItem_, listItem, markup, monospaced_, monospaced, nonBreakingSpace, numberedList_, numberedList, numberedListItem_, numberedListItem, paragraph_, paragraph, resetState, section1_, section1, section2_, section2, section3_, section3, section4_, section4, section5_, section5, sectionTitle1_, sectionTitle1, sectionTitle2_, sectionTitle2, sectionTitle3_, sectionTitle3, sectionTitle4_, sectionTitle4, sectionTitle5_, sectionTitle5, table_, table, tableCaption_, tableCaption, tableCell_, tableCell_, tableCell, tableCell, tableHeaderCell_, tableHeaderCell, tableRow_, tableRow, tableRows_, tableRows, text, verbatim_, verbatim, verbatimContent, write

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

writeEndTag, writeSimpleTag, writeSimpleTag, writeStartTag, writeStartTag, writeStartTag

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

author, date, definitionListItem_, definitionListItem, pageBreak, rawText, sectionTitle_, sectionTitle, tableCell, tableHeaderCell, title

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractXdocBookSink

public AbstractXdocBookSink(java.io.Writer out,
                            org.codehaus.plexus.i18n.I18N i18n)

Default constructor.

Parameters:

out - a Writer.

i18n - I18N.

Method Detail

head

public void head()

Specified by:

head in interface org.apache.maven.doxia.sink.Sink

Overrides:

head in class org.apache.maven.doxia.module.xdoc.XdocSink

See Also:

XdocSink.head()

head_

public void head_()

Specified by:

head_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

head_ in class org.apache.maven.doxia.module.xdoc.XdocSink

See Also:

XdocSink.head_()

author_

public void author_()

Specified by:

author_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

author_ in class org.apache.maven.doxia.module.xdoc.XdocSink

See Also:

XdocSink.author_()

date_

public void date_()

Specified by:

date_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

date_ in class org.apache.maven.doxia.module.xdoc.XdocSink

See Also:

XdocSink.date_()

body

public void body()

Specified by:

body in interface org.apache.maven.doxia.sink.Sink

Overrides:

body in class org.apache.maven.doxia.module.xdoc.XdocSink

See Also:

XdocSink.body()

body_

public void body_()

Specified by:

body_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

body_ in class org.apache.maven.doxia.module.xdoc.XdocSink

See Also:

XdocSink.body_()

title_

public void title_()

Specified by:

title_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

title_ in class org.apache.maven.doxia.module.xdoc.XdocSink

See Also:

XdocSink.title_()

getString

protected java.lang.String getString(java.lang.String key)

Gets a trimmed String for the given key from the resource bundle defined by Plexus.

Parameters:

key - the key for the desired string

Returns:

the string for the given key

navigationPanel

protected abstract void navigationPanel()

Add a navigation panel.