org.apache.maven.doxia.siterenderer.sink
Class SiteRendererSink

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.xhtml.XhtmlSink
                      org.apache.maven.doxia.siterenderer.sink.SiteRendererSink

All Implemented Interfaces:

org.apache.maven.doxia.logging.LogEnabled, org.apache.maven.doxia.markup.HtmlMarkup, org.apache.maven.doxia.markup.Markup, org.apache.maven.doxia.markup.XmlMarkup, org.apache.maven.doxia.module.xhtml.XhtmlMarkup, org.apache.maven.doxia.sink.Sink

public class SiteRendererSink
extends org.apache.maven.doxia.module.xhtml.XhtmlSink
implements org.apache.maven.doxia.sink.Sink, org.codehaus.doxia.sink.Sink

Sink for site renderering.

Version:

$Id: SiteRendererSink.java 746999 2009-02-23 12:56:04Z vsiveton $

Author:

Emmanuel Venisse

Field Summary

Fields inherited from interface org.apache.maven.doxia.module.xhtml.XhtmlMarkup

XHTML_NAMESPACE, XHTML_TRANSITIONAL_PUBLIC_ID, XHTML_TRANSITIONAL_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, CENTER, CITE, CODE, COL, COLGROUP, DD, DEL, DFN, DIR, DIV, DL, DT, EM, 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

Constructor Summary

SiteRendererSink(org.apache.maven.doxia.sink.render.RenderingContext renderingContext)
Construct a new SiteRendererSink.

Method Summary

void	author_()
void	body_() Do nothing.
void	body() Do nothing.
void	date_()
java.util.List	getAuthors() Getter for the field authors.
java.lang.String	getBody() getBody
java.lang.String	getDate() Getter for the field date.
org.apache.maven.doxia.sink.render.RenderingContext	getRenderingContext() Getter for the field renderingContext.
java.lang.String	getTitle() Getter for the field title.
void	head_()
void	head()
void	sectionTitle_(int level)
void	sectionTitle(int level, org.apache.maven.doxia.sink.SinkEventAttributes attributes)
void	sectionTitle1_() Writes out a sectionTitle1 block, including an anchor that is constructed from the buffered title text via HtmlTools.encodeId(String).
void	sectionTitle1() Sets the head flag to true so the title text is buffered until the closing tag.
void	sectionTitle2_() Writes out a sectionTitle2 block, including an anchor that is constructed from the buffered title text via HtmlTools.encodeId(String).
void	sectionTitle2() Sets the head flag to true so the title text is buffered until the closing tag.
void	title_()
void	title() Do nothing.
protected void	write(java.lang.String text)

Methods inherited from class org.apache.maven.doxia.module.xhtml.XhtmlSink

isHeadTitleFlag, setHeadTitleFlag

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

anchor_, anchor, anchor, bold_, bold, close, 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, onSection_, onSection, onSectionTitle_, onSectionTitle, pageBreak, paragraph_, paragraph, paragraph, rawText, resetState, resetTextBuffer, section_, section, section1_, section1, section2_, section2, section3_, section3, section4_, section4, section5_, section5, 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, tableRow, tableRows_, tableRows, text, text, unknown, verbatim_, verbatim, verbatim, verbatimContent

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

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

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

author, author, body, date, date, definitionListItem_, definitionListItem, definitionListItem, head, 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

SiteRendererSink

public SiteRendererSink(org.apache.maven.doxia.sink.render.RenderingContext renderingContext)

Construct a new SiteRendererSink.

Parameters:

renderingContext - the RenderingContext.

Method Detail

title_

public void title_()

Specified by:

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

Overrides:

title_ in class org.apache.maven.doxia.module.xhtml.XhtmlSink

title

public void title()

Do nothing.

Specified by:

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

Overrides:

title in class org.apache.maven.doxia.module.xhtml.XhtmlSink

See Also:

XhtmlSink.title()

getTitle

public java.lang.String getTitle()

Getter for the field title.

Returns:

a String object.

author_

public void author_()

Specified by:

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

Overrides:

author_ in class org.apache.maven.doxia.module.xhtml.XhtmlSink

getAuthors

public java.util.List getAuthors()

Getter for the field authors.

Returns:

a List object.

date_

public void date_()

Specified by:

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

Overrides:

date_ in class org.apache.maven.doxia.module.xhtml.XhtmlSink

getDate

public java.lang.String getDate()

Getter for the field date.

Returns:

a String object.

body_

public void body_()

Do nothing.

Specified by:

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

Overrides:

body_ in class org.apache.maven.doxia.module.xhtml.XhtmlSink

See Also:

XhtmlSink.body_()

body

public void body()

Do nothing.

Specified by:

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

Overrides:

body in class org.apache.maven.doxia.module.xhtml.XhtmlSink

See Also:

XhtmlSink.body()

getBody

public java.lang.String getBody()

getBody

Returns:

a String object.

head_

public void head_()

Specified by:

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

Overrides:

head_ in class org.apache.maven.doxia.module.xhtml.XhtmlSink

head

public void head()

Specified by:

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

Overrides:

head in class org.apache.maven.doxia.module.xhtml.XhtmlSink

sectionTitle

public void sectionTitle(int level,
                         org.apache.maven.doxia.sink.SinkEventAttributes attributes)

Specified by:

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

Overrides:

sectionTitle in class org.apache.maven.doxia.sink.XhtmlBaseSink

sectionTitle_

public void sectionTitle_(int level)

Specified by:

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

Overrides:

sectionTitle_ in class org.apache.maven.doxia.sink.XhtmlBaseSink

sectionTitle1

public void sectionTitle1()

Sets the head flag to true so the title text is buffered until the closing tag.

Specified by:

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

Overrides:

sectionTitle1 in class org.apache.maven.doxia.sink.XhtmlBaseSink

See Also:

XhtmlBaseSink.sectionTitle1()

sectionTitle1_

public void sectionTitle1_()

Writes out a sectionTitle1 block, including an anchor that is constructed from the buffered title text via HtmlTools.encodeId(String).

Specified by:

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

Overrides:

sectionTitle1_ in class org.apache.maven.doxia.sink.XhtmlBaseSink

See Also:

XhtmlBaseSink.sectionTitle1_()

sectionTitle2

public void sectionTitle2()

Sets the head flag to true so the title text is buffered until the closing tag.

Specified by:

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

Overrides:

sectionTitle2 in class org.apache.maven.doxia.sink.XhtmlBaseSink

See Also:

XhtmlBaseSink.sectionTitle2()

sectionTitle2_

public void sectionTitle2_()

Writes out a sectionTitle2 block, including an anchor that is constructed from the buffered title text via HtmlTools.encodeId(String).

Specified by:

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

Overrides:

sectionTitle2_ in class org.apache.maven.doxia.sink.XhtmlBaseSink

See Also:

XhtmlBaseSink.sectionTitle2_()

getRenderingContext

public org.apache.maven.doxia.sink.render.RenderingContext getRenderingContext()

Getter for the field renderingContext.

Returns:

the current rendering context

Since:

1.1

write

protected void write(java.lang.String text)

Overrides:

write in class org.apache.maven.doxia.sink.XhtmlBaseSink