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

java.lang.Object
  extended by org.apache.maven.doxia.sink.SinkAdapter
      extended by org.apache.maven.doxia.sink.AbstractXmlSink
          extended by org.apache.maven.doxia.module.xdoc.XdocSink
              extended by org.apache.maven.doxia.book.services.renderer.xdoc.AbstractXdocBookSink
All Implemented Interfaces:
Markup, XmlMarkup, XdocMarkup, Sink
Direct Known Subclasses:
ChapterXdocBookSink, IndexXdocBookSink, SectionXdocBookSink

public abstract class AbstractXdocBookSink
extends 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(Writer out, org.codehaus.plexus.i18n.I18N i18n)
          Default constructor.
 
Method Summary
 void author_()
          Ending the author element.
 void body_()
          Ending the body element.
 void body()
          Starting the body of a document which contains the document's content.
 void date_()
          Ending the date element.
protected  String getString(String key)
          Gets a trimmed String for the given key from the resource bundle defined by Plexus.
 void head_()
          Ending the head element.
 void head()
          Starting the head element which contains information about the current document, such as its title, that is not considered document content.
protected abstract  void navigationPanel()
          Add a navigation panel.
 void title_()
          Ending the title element.
 
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, writeEndTagWithoutEOL, 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(Writer out,
                            org.codehaus.plexus.i18n.I18N i18n)
Default constructor.

Parameters:
out - a Writer.
i18n - I18N.
Method Detail

head

public void head()
Description copied from class: XdocSink
Starting the head element which contains information about the current document, such as its title, that is not considered document content.

Specified by:
head in interface Sink
Overrides:
head in class XdocSink
See Also:
XdocSink.head()

head_

public void head_()
Description copied from class: XdocSink
Ending the head element.

Specified by:
head_ in interface Sink
Overrides:
head_ in class XdocSink
See Also:
XdocSink.head_()

author_

public void author_()
Description copied from class: XdocSink
Ending the author element.

Specified by:
author_ in interface Sink
Overrides:
author_ in class XdocSink
See Also:
XdocSink.author_()

date_

public void date_()
Description copied from class: XdocSink
Ending the date element.

Specified by:
date_ in interface Sink
Overrides:
date_ in class XdocSink
See Also:
XdocSink.date_()

body

public void body()
Description copied from class: XdocSink
Starting the body of a document which contains the document's content.

Specified by:
body in interface Sink
Overrides:
body in class XdocSink
See Also:
XdocSink.body()

body_

public void body_()
Description copied from class: XdocSink
Ending the body element.

Specified by:
body_ in interface Sink
Overrides:
body_ in class XdocSink
See Also:
XdocSink.body_()

title_

public void title_()
Description copied from class: XdocSink
Ending the title element.

Specified by:
title_ in interface Sink
Overrides:
title_ in class XdocSink
See Also:
XdocSink.title_()

getString

protected String getString(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.



Copyright © 2005-2010 Apache Software Foundation. All Rights Reserved.