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

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
                  extended by org.apache.maven.doxia.book.services.renderer.xdoc.SectionXdocBookSink
All Implemented Interfaces:
Markup, XmlMarkup, XdocMarkup, Sink

public class SectionXdocBookSink
extends AbstractXdocBookSink

A XdocSink implementation for section in a book

Version:
$Id: SectionXdocBookSink.java 572956 2007-09-05 14:22:50Z ltheussl $
Author:
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
SectionXdocBookSink(Writer out, IndexEntry indexEntry, org.codehaus.plexus.i18n.I18N i18n)
          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
author_, body_, body, date_, getString, head_, head, 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, 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

SectionXdocBookSink

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

Parameters:
out - the Writer to use.
indexEntry - the IndexEntry.
i18n - the I18N.
Method Detail

navigationPanel

protected void navigationPanel()
Description copied from class: AbstractXdocBookSink
Add a navigation panel.

Specified by:
navigationPanel in class AbstractXdocBookSink
See Also:
AbstractXdocBookSink.navigationPanel()

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:
org.apache.maven.doxia.book.services.renderer.xdoc.ChapterXdocBookSink#up(org.apache.maven.doxia.book.context.IndexEntry)

next

protected void next(IndexEntry parent,
                    IndexEntry nextEntry)
Add next link.

Parameters:
parent - the parent IndexEntry.
nextEntry - the next IndexEntry.


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