SiteRendererSink (Doxia Sitetools :: Site Renderer 1.9 API)

java.lang.Object
- org.apache.maven.doxia.sink.impl.AbstractSink
- - org.apache.maven.doxia.sink.impl.SinkAdapter
  - - org.apache.maven.doxia.sink.impl.AbstractXmlSink
    - - org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
      - org.apache.maven.doxia.module.xhtml5.Xhtml5Sink
        
        org.apache.maven.doxia.siterenderer.sink.SiteRendererSink

All Implemented Interfaces:

LogEnabled, HtmlMarkup, Markup, XmlMarkup, org.apache.maven.doxia.module.xhtml5.Xhtml5Markup, Sink, DocumentContent
```
public class SiteRendererSink
extends org.apache.maven.doxia.module.xhtml5.Xhtml5Sink
implements Sink, Sink, DocumentContent
```
Sink for site rendering of a document, to allow later merge document's output with a template. During raw Doxia rendering, content is stored in multiple fields for later use when incorporating into skin or template: title, date, authors, head, body

Author:

Emmanuel Venisse

Field Summary
- Fields inherited from class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
  contentStack, inlineStack, tableAttributes, tableRows
- 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, SECTION_LEVEL_6
- Fields inherited from interface org.apache.maven.doxia.module.xhtml5.Xhtml5Markup
  XHTML5_NAMESPACE
- Fields inherited from interface org.apache.maven.doxia.markup.HtmlMarkup
  A, ABBR, ACRONYM, ADDRESS, APPLET, AREA, ARTICLE, ASIDE, AUDIO, B, BASE, BASEFONT, BDI, BDO, BIG, BLOCKQUOTE, BODY, BR, BUTTON, CANVAS, CAPTION, CDATA_TYPE, CENTER, CITE, CODE, COL, COLGROUP, COMMAND, DATA, DATALIST, DD, DEL, DETAILS, DFN, DIALOG, DIR, DIV, DL, DT, EM, EMBED, ENTITY_TYPE, FIELDSET, FIGCAPTION, FIGURE, FONT, FOOTER, FORM, FRAME, FRAMESET, H1, H2, H3, H4, H5, H6, HEAD, HEADER, HGROUP, HR, HTML, I, IFRAME, IMG, INPUT, INS, ISINDEX, KBD, LABEL, LEGEND, LI, LINK, MAIN, MAP, MARK, MENU, META, METER, NAV, NOFRAMES, NOSCRIPT, OBJECT, OL, OPTGROUP, OPTION, OUTPUT, P, PARAM, PICTURE, PRE, PROGRESS, Q, RB, RP, RT, RTC, RUBY, S, SAMP, SCRIPT, SECTION, SELECT, SMALL, SOURCE, SPAN, STRIKE, STRONG, STYLE, SUB, SUMMARY, SUP, TABLE, TAG_TYPE_END, TAG_TYPE_SIMPLE, TAG_TYPE_START, TBODY, TD, TEMPLATE, TEXTAREA, TFOOT, TH, THEAD, TIME, TITLE, TR, TRACK, TT, U, UL, VAR, VIDEO, WBR
- 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

Constructors
Constructor and Description

SiteRendererSink(RenderingContext renderingContext)
Construct a new SiteRendererSink for a document.

Constructors
Constructor and Description
`SiteRendererSink(RenderingContext renderingContext)` Construct a new SiteRendererSink for a document.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`anchor(String name, SinkEventAttributes attributes)`
`void`	`author_()`
`void`	`author()`
`void`	`body_()` Do nothing.
`void`	`body()` Do nothing.
`void`	`date_()`
`void`	`date()`
`List<String>`	`getAuthors()` Get the authors of the document.
`String`	`getBody()` Get the html body of the document.
`String`	`getDate()` Get the date of the document.
`String`	`getHead()` Get the html head of the document.
`RenderingContext`	`getRenderingContext()` Get the document rendering context.
`String`	`getTitle()` Get the title of the document.
`void`	`head_()`
`void`	`head()`
`protected void`	`onSectionTitle_(int depth)`
`protected void`	`onSectionTitle(int depth, SinkEventAttributes attributes)`
`void`	`text(String text)`
`void`	`title_()`
`void`	`title()` Reset text buffer, since text content before title mustn't be in title.
`protected void`	`write(String text)`

Methods inherited from class org.apache.maven.doxia.module.xhtml5.Xhtml5Sink
isHeadTitleFlag, onSection_, onSection, setHeadTitleFlag

Methods inherited from class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
address_, address, address, anchor_, anchor, article_, article, article, blockquote_, blockquote, blockquote, bold_, bold, close, comment, content_, content, content, content, data_, data, data, definedTerm_, definedTerm, definedTerm, definition_, definition, definition, definitionList_, definitionList, definitionList, division_, division, division, encodeURL, escapeHTML, figure_, figure, figure, figureCaption_, figureCaption, figureCaption, figureGraphics, figureGraphics, flush, footer_, footer, footer, getCellCount, getCellJustif, getTextBuffer, header_, header, header, horizontalRule, horizontalRule, init, inline_, inline, inline, isHeadFlag, isVerbatimFlag, italic_, italic, lineBreak, lineBreak, lineBreakOpportunity, lineBreakOpportunity, link_, link, link, list_, list, list, listItem_, listItem, listItem, monospaced_, monospaced, navigation_, navigation, navigation, 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, sidebar_, sidebar, sidebar, table_, table, table, tableCaption_, tableCaption, tableCaption, tableCell_, tableCell, tableCell, tableCell, tableHeaderCell_, tableHeaderCell, tableHeaderCell, tableHeaderCell, tableRow_, tableRow, tableRow, tableRows_, tableRows, text, time_, time, time, unknown, verbatim_, verbatim, verbatim, verbatimContent, writeEndTag, writeStartTag

Methods inherited from class org.apache.maven.doxia.sink.impl.AbstractXmlSink
getNameSpace, setInsertNewline, setNameSpace, writeEOL, writeSimpleTag, writeSimpleTag, writeStartTag, writeStartTag

Methods inherited from class org.apache.maven.doxia.sink.impl.SinkAdapter
author, body, date, definitionListItem_, definitionListItem, definitionListItem, head, section6_, section6, sectionTitle_, sectionTitle, sectionTitle6_, sectionTitle6, title

Methods inherited from class org.apache.maven.doxia.sink.impl.AbstractSink
enableLogging, getLog, unifyEOLs

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.maven.doxia.sink.Sink
address_, address, address, anchor_, anchor, article_, article, article, author, blockquote_, blockquote, blockquote, body, bold_, bold, close, comment, content_, content, content, data_, data, data, date, definedTerm_, definedTerm, definedTerm, definition_, definition, definition, definitionList_, definitionList, definitionList, definitionListItem_, definitionListItem, definitionListItem, division_, division, division, figure_, figure, figure, figureCaption_, figureCaption, figureCaption, figureGraphics, figureGraphics, flush, footer_, footer, footer, head, header_, header, header, horizontalRule, horizontalRule, inline_, inline, inline, italic_, italic, lineBreak, lineBreak, lineBreakOpportunity, lineBreakOpportunity, link_, link, link, list_, list, list, listItem_, listItem, listItem, monospaced_, monospaced, navigation_, navigation, navigation, nonBreakingSpace, numberedList_, numberedList, numberedList, numberedListItem_, numberedListItem, numberedListItem, pageBreak, paragraph_, paragraph, paragraph, rawText, section_, section, section1_, section1, section2_, section2, section3_, section3, section4_, section4, section5_, section5, section6_, section6, sectionTitle_, sectionTitle_, sectionTitle, sectionTitle, sectionTitle1_, sectionTitle1, sectionTitle2_, sectionTitle2, sectionTitle3_, sectionTitle3, sectionTitle4_, sectionTitle4, sectionTitle5_, sectionTitle5, sectionTitle6_, sectionTitle6, sidebar_, sidebar, sidebar, table_, table, table, tableCaption_, tableCaption, tableCaption, tableCell_, tableCell, tableCell, tableCell, tableHeaderCell_, tableHeaderCell, tableHeaderCell, tableHeaderCell, tableRow_, tableRow, tableRow, tableRows_, tableRows, text, time_, time, time, title, unknown, verbatim_, verbatim, verbatim

Methods inherited from interface org.apache.maven.doxia.logging.LogEnabled
enableLogging

- Constructor Detail
  - SiteRendererSink
```
public SiteRendererSink(RenderingContext renderingContext)
```
    Construct a new SiteRendererSink for a document.
    
    Parameters:
    renderingContext - the document's RenderingContext.
- Method Detail
  - title_
```
public void title_()
```
    Specified by:
    
    title_ in interface Sink
    
    Overrides:
    
    title_ in class org.apache.maven.doxia.module.xhtml5.Xhtml5Sink
  - title
```
public void title()
```
    Reset text buffer, since text content before title mustn't be in title.
    
    Specified by:
    
    title in interface Sink
    
    Overrides:
    
    title in class org.apache.maven.doxia.module.xhtml5.Xhtml5Sink
    
    See Also:
    Xhtml5Sink.title()
  - author
```
public void author()
```
    Specified by:
    
    author in interface Sink
    
    Overrides:
    
    author in class SinkAdapter
  - author_
```
public void author_()
```
    Specified by:
    
    author_ in interface Sink
    
    Overrides:
    
    author_ in class org.apache.maven.doxia.module.xhtml5.Xhtml5Sink
  - date
```
public void date()
```
    Specified by:
    
    date in interface Sink
    
    Overrides:
    
    date in class SinkAdapter
  - date_
```
public void date_()
```
    Specified by:
    
    date_ in interface Sink
    
    Overrides:
    
    date_ in class org.apache.maven.doxia.module.xhtml5.Xhtml5Sink
  - body_
```
public void body_()
```
    Do nothing.
    
    Specified by:
    
    body_ in interface Sink
    
    Overrides:
    
    body_ in class org.apache.maven.doxia.module.xhtml5.Xhtml5Sink
    
    See Also:
    Xhtml5Sink.body_()
  - body
```
public void body()
```
    Do nothing.
    
    Specified by:
    
    body in interface Sink
    
    Overrides:
    
    body in class org.apache.maven.doxia.module.xhtml5.Xhtml5Sink
    
    See Also:
    Xhtml5Sink.body()
  - head_
```
public void head_()
```
    Specified by:
    
    head_ in interface Sink
    
    Overrides:
    
    head_ in class org.apache.maven.doxia.module.xhtml5.Xhtml5Sink
  - head
```
public void head()
```
    Specified by:
    
    head in interface Sink
    
    Overrides:
    
    head in class org.apache.maven.doxia.module.xhtml5.Xhtml5Sink
  - anchor
```
public void anchor(String name,
          SinkEventAttributes attributes)
```
    Specified by:
    
    anchor in interface Sink
    
    Overrides:
    
    anchor in class Xhtml5BaseSink
  - onSectionTitle
```
protected void onSectionTitle(int depth,
                  SinkEventAttributes attributes)
```
    Overrides:
    
    onSectionTitle in class org.apache.maven.doxia.module.xhtml5.Xhtml5Sink
  - onSectionTitle_
```
protected void onSectionTitle_(int depth)
```
    Overrides:
    
    onSectionTitle_ in class org.apache.maven.doxia.module.xhtml5.Xhtml5Sink
  - text
```
public void text(String text)
```
    Specified by:
    
    text in interface Sink
    
    Overrides:
    
    text in class Xhtml5BaseSink
  - write
```
protected void write(String text)
```
    Overrides:
    
    write in class Xhtml5BaseSink
  - getTitle
```
public String getTitle()
```
    Get the title of the document.
    
    Specified by:
    
    getTitle in interface DocumentContent
    
    Returns:
    the document title
  - getAuthors
```
public List<String> getAuthors()
```
    Get the authors of the document.
    
    Specified by:
    
    getAuthors in interface DocumentContent
    
    Returns:
    the document authors
  - getDate
```
public String getDate()
```
    Get the date of the document.
    
    Specified by:
    
    getDate in interface DocumentContent
    
    Returns:
    the document date
  - getBody
```
public String getBody()
```
    Get the html body of the document.
    
    Specified by:
    
    getBody in interface DocumentContent
    
    Returns:
    the document body head
  - getHead
```
public String getHead()
```
    Get the html head of the document.
    
    Specified by:
    
    getHead in interface DocumentContent
    
    Returns:
    the document html head
  - getRenderingContext
```
public RenderingContext getRenderingContext()
```
    Get the document rendering context.
    
    Specified by:
    
    getRenderingContext in interface DocumentContent
    
    Returns:
    the document rendering context

Class SiteRendererSink

Field Summary

Fields inherited from class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink

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

Fields inherited from interface org.apache.maven.doxia.module.xhtml5.Xhtml5Markup

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

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

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

Constructor Summary

Method Summary

Methods inherited from class org.apache.maven.doxia.module.xhtml5.Xhtml5Sink

Methods inherited from class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink

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

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.maven.doxia.logging.LogEnabled

Constructor Detail

SiteRendererSink

Method Detail

title_

title

author

author_

date

date_

body_

body

head_

head

anchor

onSectionTitle

onSectionTitle_

text

write

getTitle

getAuthors

getDate

getBody

getHead

getRenderingContext