Xhtml5BaseSink (Doxia :: Core 1.11.1 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

All Implemented Interfaces:

LogEnabled, HtmlMarkup, Markup, XmlMarkup, Sink
```
public class Xhtml5BaseSink
extends AbstractXmlSink
implements HtmlMarkup
```
Abstract base xhtml5 sink implementation.

Field Summary

Fields
Modifier and Type	Field and Description
`protected Stack<HTML.Tag>`	`contentStack` Keep track of the main and div tags for content events.
`protected Stack<List<HTML.Tag>>`	`inlineStack` Keep track of the closing tags for inline events.
`protected MutableAttributeSet`	`tableAttributes` used to store attributes passed to table().
`protected boolean`	`tableRows` Flag to know if `tableRows(int[], boolean)` is called or not.

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, KEYGEN, 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

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

Constructor Summary

Constructors
Constructor and Description

Xhtml5BaseSink(Writer out)
Constructor, initialize the PrintWriter.

Constructors
Constructor and Description
`Xhtml5BaseSink(Writer out)` Constructor, initialize the PrintWriter.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`address_()`
`void`	`address()`
`void`	`address(SinkEventAttributes attributes)`
`void`	`anchor_()`
`void`	`anchor(String name)`
`void`	`anchor(String name, SinkEventAttributes attributes)`
`void`	`article_()`
`void`	`article()`
`void`	`article(SinkEventAttributes attributes)`
`void`	`blockquote_()`
`void`	`blockquote()`
`void`	`blockquote(SinkEventAttributes attributes)`
`void`	`bold_()`
`void`	`bold()`
`void`	`close()`
`void`	`comment(String comment)`
`void`	`content_()`
`void`	`content()`
`void`	`content(SinkEventAttributes attributes)`
`protected void`	`content(String text)` Write HTML escaped text to output.
`void`	`data_()`
`void`	`data(String value)`
`void`	`data(String value, SinkEventAttributes attributes)`
`void`	`definedTerm_()`
`void`	`definedTerm()`
`void`	`definedTerm(SinkEventAttributes attributes)`
`void`	`definition_()`
`void`	`definition()`
`void`	`definition(SinkEventAttributes attributes)`
`void`	`definitionList_()`
`void`	`definitionList()`
`void`	`definitionList(SinkEventAttributes attributes)`
`void`	`division_()`
`void`	`division()`
`void`	`division(SinkEventAttributes attributes)`
`protected static String`	`encodeURL(String text)` Forward to HtmlTools.encodeURL( text ).
`protected static String`	`escapeHTML(String text)` Forward to HtmlTools.escapeHTML( text ).
`void`	`figure_()`
`void`	`figure()`
`void`	`figure(SinkEventAttributes attributes)`
`void`	`figureCaption_()`
`void`	`figureCaption()`
`void`	`figureCaption(SinkEventAttributes attributes)`
`void`	`figureGraphics(String name)`
`void`	`figureGraphics(String src, SinkEventAttributes attributes)`
`void`	`flush()`
`void`	`footer_()`
`void`	`footer()`
`void`	`footer(SinkEventAttributes attributes)`
`protected int`	`getCellCount()` Getter for the field `cellCount`.
`protected int[]`	`getCellJustif()` Getter for the field `cellJustif`.
`protected StringBuffer`	`getTextBuffer()` To use mainly when playing with the head events.
`void`	`header_()`
`void`	`header()`
`void`	`header(SinkEventAttributes attributes)`
`void`	`horizontalRule()`
`void`	`horizontalRule(SinkEventAttributes attributes)`
`protected void`	`init()` This is called in `Sink.head()` or in `Sink.close()`, and can be used to set the sink into a clear state so it can be re-used.
`void`	`inline_()`
`void`	`inline()`
`void`	`inline(SinkEventAttributes attributes)`
`protected boolean`	`isHeadFlag()` isHeadFlag.
`protected boolean`	`isVerbatimFlag()` isVerbatimFlag.
`void`	`italic_()`
`void`	`italic()`
`void`	`lineBreak()`
`void`	`lineBreak(SinkEventAttributes attributes)`
`void`	`lineBreakOpportunity()`
`void`	`lineBreakOpportunity(SinkEventAttributes attributes)`
`void`	`link_()`
`void`	`link(String name)`
`void`	`link(String name, SinkEventAttributes attributes)`
`void`	`list_()`
`void`	`list()`
`void`	`list(SinkEventAttributes attributes)`
`void`	`listItem_()`
`void`	`listItem()`
`void`	`listItem(SinkEventAttributes attributes)`
`void`	`monospaced_()`
`void`	`monospaced()`
`void`	`navigation_()`
`void`	`navigation()`
`void`	`navigation(SinkEventAttributes attributes)`
`void`	`nonBreakingSpace()`
`void`	`numberedList_()`
`void`	`numberedList(int numbering)` The default list style depends on the numbering.
`void`	`numberedList(int numbering, SinkEventAttributes attributes)` The default list style depends on the numbering.
`void`	`numberedListItem_()`
`void`	`numberedListItem()`
`void`	`numberedListItem(SinkEventAttributes attributes)`
`protected void`	`onSection_(int depth)` Ends a section.
`protected void`	`onSection(int depth, SinkEventAttributes attributes)` Starts a section.
`protected void`	`onSectionTitle_(int depth)` Ends a section title.
`protected void`	`onSectionTitle(int depth, SinkEventAttributes attributes)` Starts a section title.
`void`	`pageBreak()`
`void`	`paragraph_()`
`void`	`paragraph()`
`void`	`paragraph(SinkEventAttributes attributes)`
`void`	`rawText(String text)`
`protected void`	`resetState()` Deprecated. since 1.1.2, use `init()` instead of.
`protected void`	`resetTextBuffer()` Reset the text buffer.
`void`	`section_(int level)`
`void`	`section(int level, SinkEventAttributes attributes)`
`void`	`section1_()`
`void`	`section1()`
`void`	`section2_()`
`void`	`section2()`
`void`	`section3_()`
`void`	`section3()`
`void`	`section4_()`
`void`	`section4()`
`void`	`section5_()`
`void`	`section5()`
`void`	`sectionTitle_(int level)`
`void`	`sectionTitle(int level, SinkEventAttributes attributes)`
`void`	`sectionTitle1_()`
`void`	`sectionTitle1()`
`void`	`sectionTitle2_()`
`void`	`sectionTitle2()`
`void`	`sectionTitle3_()`
`void`	`sectionTitle3()`
`void`	`sectionTitle4_()`
`void`	`sectionTitle4()`
`void`	`sectionTitle5_()`
`void`	`sectionTitle5()`
`protected void`	`setCellCount(int count)` Setter for the field `cellCount`.
`protected void`	`setCellJustif(int[] justif)` Setter for the field `cellJustif`.
`protected void`	`setHeadFlag(boolean headFlag)` Setter for the field `headFlag`.
`protected void`	`setVerbatimFlag(boolean verb)` Setter for the field `verbatimFlag`.
`void`	`sidebar_()`
`void`	`sidebar()`
`void`	`sidebar(SinkEventAttributes attributes)`
`void`	`table_()`
`void`	`table()`
`void`	`table(SinkEventAttributes attributes)`
`void`	`tableCaption_()`
`void`	`tableCaption()`
`void`	`tableCaption(SinkEventAttributes attributes)`
`void`	`tableCell_()`
`void`	`tableCell()`
`void`	`tableCell(SinkEventAttributes attributes)`
`void`	`tableCell(String width)`
`void`	`tableHeaderCell_()`
`void`	`tableHeaderCell()`
`void`	`tableHeaderCell(SinkEventAttributes attributes)`
`void`	`tableHeaderCell(String width)`
`void`	`tableRow_()`
`void`	`tableRow()` The default class style is `a` or `b` depending the row id.
`void`	`tableRow(SinkEventAttributes attributes)` The default class style is `a` or `b` depending the row id.
`void`	`tableRows_()`
`void`	`tableRows(int[] justification, boolean grid)` The default class style is `bodyTable`.
`void`	`text(String text)`
`void`	`text(String text, SinkEventAttributes attributes)`
`void`	`time_()`
`void`	`time(String datetime)`
`void`	`time(String datetime, SinkEventAttributes attributes)`
`void`	`unknown(String name, Object[] requiredParams, SinkEventAttributes attributes)` Add an unknown event.
`void`	`verbatim_()`
`void`	`verbatim(boolean boxed)` The default class style for boxed is `source`.
`void`	`verbatim(SinkEventAttributes attributes)` The default class style for boxed is `source`.
`protected void`	`verbatimContent(String text)` Write HTML escaped text to output.
`protected void`	`write(String text)` Write a text to the sink.
`protected void`	`writeEndTag(HTML.Tag t)` Ends a Tag without writing an EOL.
`protected void`	`writeStartTag(HTML.Tag t, MutableAttributeSet att, boolean isSimpleTag)` Starts a Tag with attributes.

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_, author, author, body_, body, body, date_, date, date, definitionListItem_, definitionListItem, definitionListItem, head_, head, head, section6_, section6, sectionTitle_, sectionTitle, sectionTitle6_, sectionTitle6, title_, title, 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

- Field Detail
  - contentStack
```
protected Stack<HTML.Tag> contentStack
```
    Keep track of the main and div tags for content events.
  - inlineStack
```
protected Stack<List<HTML.Tag>> inlineStack
```
    Keep track of the closing tags for inline events.
  - tableAttributes
```
protected MutableAttributeSet tableAttributes
```
    used to store attributes passed to table().
  - tableRows
```
protected boolean tableRows
```
    Flag to know if tableRows(int[], boolean) is called or not. It is mainly to be backward compatible with some plugins (like checkstyle) which uses:
```
 sink.table();
 sink.tableRow();
 
```
    instead of
```
 sink.table();
 sink.tableRows( justify, true );
 sink.tableRow();
 
```
- Constructor Detail
  - Xhtml5BaseSink
```
public Xhtml5BaseSink(Writer out)
```
    Constructor, initialize the PrintWriter.
    
    Parameters:
    
    out - The writer to write the result.
- Method Detail
  - getTextBuffer
```
protected StringBuffer getTextBuffer()
```
    To use mainly when playing with the head events.
    
    Returns:
    
    the current buffer of text events.
  - setHeadFlag
```
protected void setHeadFlag(boolean headFlag)
```
    Setter for the field headFlag.
    
    Parameters:
    
    headFlag - an header flag.
  - isHeadFlag
```
protected boolean isHeadFlag()
```
    isHeadFlag.
    
    Returns:
    
    the current headFlag.
  - setVerbatimFlag
```
protected void setVerbatimFlag(boolean verb)
```
    Setter for the field verbatimFlag.
    
    Parameters:
    
    verb - a verbatim flag.
  - isVerbatimFlag
```
protected boolean isVerbatimFlag()
```
    isVerbatimFlag.
    
    Returns:
    
    the current verbatim flag.
  - setCellJustif
```
protected void setCellJustif(int[] justif)
```
    Setter for the field cellJustif.
    
    Parameters:
    
    justif - the new cell justification array.
  - getCellJustif
```
protected int[] getCellJustif()
```
    Getter for the field cellJustif.
    
    Returns:
    
    the current cell justification array.
  - setCellCount
```
protected void setCellCount(int count)
```
    Setter for the field cellCount.
    
    Parameters:
    
    count - the new cell count.
  - getCellCount
```
protected int getCellCount()
```
    Getter for the field cellCount.
    
    Returns:
    
    the current cell count.
  - resetState
```
protected void resetState()
```
    Deprecated. since 1.1.2, use init() instead of.
    
    Reset all variables.
  - init
```
protected void init()
```
    This is called in Sink.head() or in Sink.close(), and can be used to set the sink into a clear state so it can be re-used.
    
    Overrides:
    
    init in class AbstractSink
  - resetTextBuffer
```
protected void resetTextBuffer()
```
    Reset the text buffer.
  - article
```
public void article()
```
    Specified by:
    
    article in interface Sink
    
    Overrides:
    
    article in class SinkAdapter
  - article
```
public void article(SinkEventAttributes attributes)
```
    Specified by:
    
    article in interface Sink
    
    Overrides:
    
    article in class SinkAdapter
  - article_
```
public void article_()
```
    Specified by:
    
    article_ in interface Sink
    
    Overrides:
    
    article_ in class SinkAdapter
  - navigation
```
public void navigation()
```
    Specified by:
    
    navigation in interface Sink
    
    Overrides:
    
    navigation in class SinkAdapter
  - navigation
```
public void navigation(SinkEventAttributes attributes)
```
    Specified by:
    
    navigation in interface Sink
    
    Overrides:
    
    navigation in class SinkAdapter
  - navigation_
```
public void navigation_()
```
    Specified by:
    
    navigation_ in interface Sink
    
    Overrides:
    
    navigation_ in class SinkAdapter
  - sidebar
```
public void sidebar()
```
    Specified by:
    
    sidebar in interface Sink
    
    Overrides:
    
    sidebar in class SinkAdapter
  - sidebar
```
public void sidebar(SinkEventAttributes attributes)
```
    Specified by:
    
    sidebar in interface Sink
    
    Overrides:
    
    sidebar in class SinkAdapter
  - sidebar_
```
public void sidebar_()
```
    Specified by:
    
    sidebar_ in interface Sink
    
    Overrides:
    
    sidebar_ in class SinkAdapter
  - section
```
public void section(int level,
                    SinkEventAttributes attributes)
```
    Specified by:
    
    section in interface Sink
    
    Overrides:
    
    section in class SinkAdapter
  - sectionTitle
```
public void sectionTitle(int level,
                         SinkEventAttributes attributes)
```
    Specified by:
    
    sectionTitle in interface Sink
    
    Overrides:
    
    sectionTitle in class SinkAdapter
  - sectionTitle_
```
public void sectionTitle_(int level)
```
    Specified by:
    
    sectionTitle_ in interface Sink
    
    Overrides:
    
    sectionTitle_ in class SinkAdapter
  - section_
```
public void section_(int level)
```
    Specified by:
    
    section_ in interface Sink
    
    Overrides:
    
    section_ in class SinkAdapter
  - section1
```
public void section1()
```
    Specified by:
    
    section1 in interface Sink
    
    Overrides:
    
    section1 in class SinkAdapter
  - sectionTitle1
```
public void sectionTitle1()
```
    Specified by:
    
    sectionTitle1 in interface Sink
    
    Overrides:
    
    sectionTitle1 in class SinkAdapter
  - sectionTitle1_
```
public void sectionTitle1_()
```
    Specified by:
    
    sectionTitle1_ in interface Sink
    
    Overrides:
    
    sectionTitle1_ in class SinkAdapter
  - section1_
```
public void section1_()
```
    Specified by:
    
    section1_ in interface Sink
    
    Overrides:
    
    section1_ in class SinkAdapter
  - section2
```
public void section2()
```
    Specified by:
    
    section2 in interface Sink
    
    Overrides:
    
    section2 in class SinkAdapter
  - sectionTitle2
```
public void sectionTitle2()
```
    Specified by:
    
    sectionTitle2 in interface Sink
    
    Overrides:
    
    sectionTitle2 in class SinkAdapter
  - sectionTitle2_
```
public void sectionTitle2_()
```
    Specified by:
    
    sectionTitle2_ in interface Sink
    
    Overrides:
    
    sectionTitle2_ in class SinkAdapter
  - section2_
```
public void section2_()
```
    Specified by:
    
    section2_ in interface Sink
    
    Overrides:
    
    section2_ in class SinkAdapter
  - section3
```
public void section3()
```
    Specified by:
    
    section3 in interface Sink
    
    Overrides:
    
    section3 in class SinkAdapter
  - sectionTitle3
```
public void sectionTitle3()
```
    Specified by:
    
    sectionTitle3 in interface Sink
    
    Overrides:
    
    sectionTitle3 in class SinkAdapter
  - sectionTitle3_
```
public void sectionTitle3_()
```
    Specified by:
    
    sectionTitle3_ in interface Sink
    
    Overrides:
    
    sectionTitle3_ in class SinkAdapter
  - section3_
```
public void section3_()
```
    Specified by:
    
    section3_ in interface Sink
    
    Overrides:
    
    section3_ in class SinkAdapter
  - section4
```
public void section4()
```
    Specified by:
    
    section4 in interface Sink
    
    Overrides:
    
    section4 in class SinkAdapter
  - sectionTitle4
```
public void sectionTitle4()
```
    Specified by:
    
    sectionTitle4 in interface Sink
    
    Overrides:
    
    sectionTitle4 in class SinkAdapter
  - sectionTitle4_
```
public void sectionTitle4_()
```
    Specified by:
    
    sectionTitle4_ in interface Sink
    
    Overrides:
    
    sectionTitle4_ in class SinkAdapter
  - section4_
```
public void section4_()
```
    Specified by:
    
    section4_ in interface Sink
    
    Overrides:
    
    section4_ in class SinkAdapter
  - section5
```
public void section5()
```
    Specified by:
    
    section5 in interface Sink
    
    Overrides:
    
    section5 in class SinkAdapter
  - sectionTitle5
```
public void sectionTitle5()
```
    Specified by:
    
    sectionTitle5 in interface Sink
    
    Overrides:
    
    sectionTitle5 in class SinkAdapter
  - sectionTitle5_
```
public void sectionTitle5_()
```
    Specified by:
    
    sectionTitle5_ in interface Sink
    
    Overrides:
    
    sectionTitle5_ in class SinkAdapter
  - section5_
```
public void section5_()
```
    Specified by:
    
    section5_ in interface Sink
    
    Overrides:
    
    section5_ in class SinkAdapter
  - onSection
```
protected void onSection(int depth,
                         SinkEventAttributes attributes)
```
    Starts a section. The default class style is section.
    
    Parameters:
    
    depth - The level of the section.
    
    attributes - some attributes. May be null.
  - onSection_
```
protected void onSection_(int depth)
```
    Ends a section.
    
    Parameters:
    
    depth - The level of the section.
    
    See Also:
    
    HTML.Tag.DIV
  - onSectionTitle
```
protected void onSectionTitle(int depth,
                              SinkEventAttributes attributes)
```
    Starts a section title.
    
    Parameters:
    
    depth - The level of the section title.
    
    attributes - some attributes. May be null.
    
    See Also:
    
    HTML.Tag.H2, HTML.Tag.H3, HTML.Tag.H4, HTML.Tag.H5, HTML.Tag.H6
  - onSectionTitle_
```
protected void onSectionTitle_(int depth)
```
    Ends a section title.
    
    Parameters:
    
    depth - The level of the section title.
    
    See Also:
    
    HTML.Tag.H2, HTML.Tag.H3, HTML.Tag.H4, HTML.Tag.H5, HTML.Tag.H6
  - header
```
public void header()
```
    Specified by:
    
    header in interface Sink
    
    Overrides:
    
    header in class SinkAdapter
  - header
```
public void header(SinkEventAttributes attributes)
```
    Specified by:
    
    header in interface Sink
    
    Overrides:
    
    header in class SinkAdapter
  - header_
```
public void header_()
```
    Specified by:
    
    header_ in interface Sink
    
    Overrides:
    
    header_ in class SinkAdapter
  - content
```
public void content()
```
    Specified by:
    
    content in interface Sink
    
    Overrides:
    
    content in class SinkAdapter
  - content
```
public void content(SinkEventAttributes attributes)
```
    Specified by:
    
    content in interface Sink
    
    Overrides:
    
    content in class SinkAdapter
  - content_
```
public void content_()
```
    Specified by:
    
    content_ in interface Sink
    
    Overrides:
    
    content_ in class SinkAdapter
  - footer
```
public void footer()
```
    Specified by:
    
    footer in interface Sink
    
    Overrides:
    
    footer in class SinkAdapter
  - footer
```
public void footer(SinkEventAttributes attributes)
```
    Specified by:
    
    footer in interface Sink
    
    Overrides:
    
    footer in class SinkAdapter
  - footer_
```
public void footer_()
```
    Specified by:
    
    footer_ in interface Sink
    
    Overrides:
    
    footer_ in class SinkAdapter
  - list
```
public void list()
```
    Specified by:
    
    list in interface Sink
    
    Overrides:
    
    list in class SinkAdapter
    
    See Also:
    
    HTML.Tag.UL
  - list
```
public void list(SinkEventAttributes attributes)
```
    Specified by:
    
    list in interface Sink
    
    Overrides:
    
    list in class SinkAdapter
    
    See Also:
    
    HTML.Tag.UL
  - list_
```
public void list_()
```
    Specified by:
    
    list_ in interface Sink
    
    Overrides:
    
    list_ in class SinkAdapter
    
    See Also:
    
    HTML.Tag.UL
  - listItem
```
public void listItem()
```
    Specified by:
    
    listItem in interface Sink
    
    Overrides:
    
    listItem in class SinkAdapter
    
    See Also:
    
    HTML.Tag.LI
  - listItem
```
public void listItem(SinkEventAttributes attributes)
```
    Specified by:
    
    listItem in interface Sink
    
    Overrides:
    
    listItem in class SinkAdapter
    
    See Also:
    
    HTML.Tag.LI
  - listItem_
```
public void listItem_()
```
    Specified by:
    
    listItem_ in interface Sink
    
    Overrides:
    
    listItem_ in class SinkAdapter
    
    See Also:
    
    HTML.Tag.LI
  - numberedList
```
public void numberedList(int numbering)
```
    The default list style depends on the numbering.
    
    Specified by:
    
    numberedList in interface Sink
    
    Overrides:
    
    numberedList in class SinkAdapter
    
    See Also:
    
    HTML.Tag.OL
  - numberedList
```
public void numberedList(int numbering,
                         SinkEventAttributes attributes)
```
    The default list style depends on the numbering.
    
    Specified by:
    
    numberedList in interface Sink
    
    Overrides:
    
    numberedList in class SinkAdapter
    
    See Also:
    
    HTML.Tag.OL
  - numberedList_
```
public void numberedList_()
```
    Specified by:
    
    numberedList_ in interface Sink
    
    Overrides:
    
    numberedList_ in class SinkAdapter
    
    See Also:
    
    HTML.Tag.OL
  - numberedListItem
```
public void numberedListItem()
```
    Specified by:
    
    numberedListItem in interface Sink
    
    Overrides:
    
    numberedListItem in class SinkAdapter
    
    See Also:
    
    HTML.Tag.LI
  - numberedListItem
```
public void numberedListItem(SinkEventAttributes attributes)
```
    Specified by:
    
    numberedListItem in interface Sink
    
    Overrides:
    
    numberedListItem in class SinkAdapter
    
    See Also:
    
    HTML.Tag.LI
  - numberedListItem_
```
public void numberedListItem_()
```
    Specified by:
    
    numberedListItem_ in interface Sink
    
    Overrides:
    
    numberedListItem_ in class SinkAdapter
    
    See Also:
    
    HTML.Tag.LI
  - definitionList
```
public void definitionList()
```
    Specified by:
    
    definitionList in interface Sink
    
    Overrides:
    
    definitionList in class SinkAdapter
    
    See Also:
    
    HTML.Tag.DL
  - definitionList
```
public void definitionList(SinkEventAttributes attributes)
```
    Specified by:
    
    definitionList in interface Sink
    
    Overrides:
    
    definitionList in class SinkAdapter
    
    See Also:
    
    HTML.Tag.DL
  - definitionList_
```
public void definitionList_()
```
    Specified by:
    
    definitionList_ in interface Sink
    
    Overrides:
    
    definitionList_ in class SinkAdapter
    
    See Also:
    
    HTML.Tag.DL
  - definedTerm
```
public void definedTerm(SinkEventAttributes attributes)
```
    Specified by:
    
    definedTerm in interface Sink
    
    Overrides:
    
    definedTerm in class SinkAdapter
    
    See Also:
    
    HTML.Tag.DT
  - definedTerm
```
public void definedTerm()
```
    Specified by:
    
    definedTerm in interface Sink
    
    Overrides:
    
    definedTerm in class SinkAdapter
    
    See Also:
    
    HTML.Tag.DT
  - definedTerm_
```
public void definedTerm_()
```
    Specified by:
    
    definedTerm_ in interface Sink
    
    Overrides:
    
    definedTerm_ in class SinkAdapter
    
    See Also:
    
    HTML.Tag.DT
  - definition
```
public void definition()
```
    Specified by:
    
    definition in interface Sink
    
    Overrides:
    
    definition in class SinkAdapter
    
    See Also:
    
    HTML.Tag.DD
  - definition
```
public void definition(SinkEventAttributes attributes)
```
    Specified by:
    
    definition in interface Sink
    
    Overrides:
    
    definition in class SinkAdapter
    
    See Also:
    
    HTML.Tag.DD
  - definition_
```
public void definition_()
```
    Specified by:
    
    definition_ in interface Sink
    
    Overrides:
    
    definition_ in class SinkAdapter
    
    See Also:
    
    HTML.Tag.DD
  - figure
```
public void figure()
```
    Specified by:
    
    figure in interface Sink
    
    Overrides:
    
    figure in class SinkAdapter
  - figure
```
public void figure(SinkEventAttributes attributes)
```
    Specified by:
    
    figure in interface Sink
    
    Overrides:
    
    figure in class SinkAdapter
  - figure_
```
public void figure_()
```
    Specified by:
    
    figure_ in interface Sink
    
    Overrides:
    
    figure_ in class SinkAdapter
  - figureGraphics
```
public void figureGraphics(String name)
```
    Specified by:
    
    figureGraphics in interface Sink
    
    Overrides:
    
    figureGraphics in class SinkAdapter
  - figureGraphics
```
public void figureGraphics(String src,
                           SinkEventAttributes attributes)
```
    Specified by:
    
    figureGraphics in interface Sink
    
    Overrides:
    
    figureGraphics in class SinkAdapter
  - figureCaption
```
public void figureCaption()
```
    Specified by:
    
    figureCaption in interface Sink
    
    Overrides:
    
    figureCaption in class SinkAdapter
  - figureCaption
```
public void figureCaption(SinkEventAttributes attributes)
```
    Specified by:
    
    figureCaption in interface Sink
    
    Overrides:
    
    figureCaption in class SinkAdapter
  - figureCaption_
```
public void figureCaption_()
```
    Specified by:
    
    figureCaption_ in interface Sink
    
    Overrides:
    
    figureCaption_ in class SinkAdapter
  - paragraph
```
public void paragraph()
```
    Specified by:
    
    paragraph in interface Sink
    
    Overrides:
    
    paragraph in class SinkAdapter
    
    See Also:
    
    HTML.Tag.P
  - paragraph
```
public void paragraph(SinkEventAttributes attributes)
```
    Specified by:
    
    paragraph in interface Sink
    
    Overrides:
    
    paragraph in class SinkAdapter
    
    See Also:
    
    HTML.Tag.P
  - paragraph_
```
public void paragraph_()
```
    Specified by:
    
    paragraph_ in interface Sink
    
    Overrides:
    
    paragraph_ in class SinkAdapter
    
    See Also:
    
    HTML.Tag.P
  - data
```
public void data(String value)
```
    Specified by:
    
    data in interface Sink
    
    Overrides:
    
    data in class SinkAdapter
  - data
```
public void data(String value,
                 SinkEventAttributes attributes)
```
    Specified by:
    
    data in interface Sink
    
    Overrides:
    
    data in class SinkAdapter
  - data_
```
public void data_()
```
    Specified by:
    
    data_ in interface Sink
    
    Overrides:
    
    data_ in class SinkAdapter
  - time
```
public void time(String datetime)
```
    Specified by:
    
    time in interface Sink
    
    Overrides:
    
    time in class SinkAdapter
  - time
```
public void time(String datetime,
                 SinkEventAttributes attributes)
```
    Specified by:
    
    time in interface Sink
    
    Overrides:
    
    time in class SinkAdapter
  - time_
```
public void time_()
```
    Specified by:
    
    time_ in interface Sink
    
    Overrides:
    
    time_ in class SinkAdapter
  - address
```
public void address()
```
    Specified by:
    
    address in interface Sink
    
    Overrides:
    
    address in class SinkAdapter
    
    See Also:
    
    HTML.Tag.ADDRESS
  - address
```
public void address(SinkEventAttributes attributes)
```
    Specified by:
    
    address in interface Sink
    
    Overrides:
    
    address in class SinkAdapter
    
    See Also:
    
    HTML.Tag.ADDRESS
  - address_
```
public void address_()
```
    Specified by:
    
    address_ in interface Sink
    
    Overrides:
    
    address_ in class SinkAdapter
    
    See Also:
    
    HTML.Tag.ADDRESS
  - blockquote
```
public void blockquote()
```
    Specified by:
    
    blockquote in interface Sink
    
    Overrides:
    
    blockquote in class SinkAdapter
    
    See Also:
    
    HTML.Tag.BLOCKQUOTE
  - blockquote
```
public void blockquote(SinkEventAttributes attributes)
```
    Specified by:
    
    blockquote in interface Sink
    
    Overrides:
    
    blockquote in class SinkAdapter
    
    See Also:
    
    HTML.Tag.BLOCKQUOTE
  - blockquote_
```
public void blockquote_()
```
    Specified by:
    
    blockquote_ in interface Sink
    
    Overrides:
    
    blockquote_ in class SinkAdapter
    
    See Also:
    
    HTML.Tag.BLOCKQUOTE
  - division
```
public void division()
```
    Specified by:
    
    division in interface Sink
    
    Overrides:
    
    division in class SinkAdapter
    
    See Also:
    
    HTML.Tag.DIV
  - division
```
public void division(SinkEventAttributes attributes)
```
    Specified by:
    
    division in interface Sink
    
    Overrides:
    
    division in class SinkAdapter
    
    See Also:
    
    HTML.Tag.DIV
  - division_
```
public void division_()
```
    Specified by:
    
    division_ in interface Sink
    
    Overrides:
    
    division_ in class SinkAdapter
    
    See Also:
    
    HTML.Tag.DIV
  - verbatim
```
public void verbatim(boolean boxed)
```
    The default class style for boxed is source.
    
    Specified by:
    
    verbatim in interface Sink
    
    Overrides:
    
    verbatim in class SinkAdapter
    
    See Also:
    
    HTML.Tag.DIV, HTML.Tag.PRE
  - verbatim
```
public void verbatim(SinkEventAttributes attributes)
```
    The default class style for boxed is source.
    
    Specified by:
    
    verbatim in interface Sink
    
    Overrides:
    
    verbatim in class SinkAdapter
    
    See Also:
    
    HTML.Tag.DIV, HTML.Tag.PRE
  - verbatim_
```
public void verbatim_()
```
    Specified by:
    
    verbatim_ in interface Sink
    
    Overrides:
    
    verbatim_ in class SinkAdapter
    
    See Also:
    
    HTML.Tag.DIV, HTML.Tag.PRE
  - horizontalRule
```
public void horizontalRule()
```
    Specified by:
    
    horizontalRule in interface Sink
    
    Overrides:
    
    horizontalRule in class SinkAdapter
    
    See Also:
    
    HTML.Tag.HR
  - horizontalRule
```
public void horizontalRule(SinkEventAttributes attributes)
```
    Specified by:
    
    horizontalRule in interface Sink
    
    Overrides:
    
    horizontalRule in class SinkAdapter
    
    See Also:
    
    HTML.Tag.HR
  - table
```
public void table()
```
    Specified by:
    
    table in interface Sink
    
    Overrides:
    
    table in class SinkAdapter
  - table
```
public void table(SinkEventAttributes attributes)
```
    Specified by:
    
    table in interface Sink
    
    Overrides:
    
    table in class SinkAdapter
  - table_
```
public void table_()
```
    Specified by:
    
    table_ in interface Sink
    
    Overrides:
    
    table_ in class SinkAdapter
    
    See Also:
    
    HTML.Tag.TABLE
  - tableRows
```
public void tableRows(int[] justification,
                      boolean grid)
```
    The default class style is bodyTable. The default align is center.
    
    Specified by:
    
    tableRows in interface Sink
    
    Overrides:
    
    tableRows in class SinkAdapter
    
    See Also:
    
    HTML.Tag.TABLE
  - tableRows_
```
public void tableRows_()
```
    Specified by:
    
    tableRows_ in interface Sink
    
    Overrides:
    
    tableRows_ in class SinkAdapter
  - tableRow
```
public void tableRow()
```
    The default class style is a or b depending the row id.
    
    Specified by:
    
    tableRow in interface Sink
    
    Overrides:
    
    tableRow in class SinkAdapter
    
    See Also:
    
    HTML.Tag.TR
  - tableRow
```
public void tableRow(SinkEventAttributes attributes)
```
    The default class style is a or b depending the row id.
    
    Specified by:
    
    tableRow in interface Sink
    
    Overrides:
    
    tableRow in class SinkAdapter
    
    See Also:
    
    HTML.Tag.TR
  - tableRow_
```
public void tableRow_()
```
    Specified by:
    
    tableRow_ in interface Sink
    
    Overrides:
    
    tableRow_ in class SinkAdapter
    
    See Also:
    
    HTML.Tag.TR
  - tableCell
```
public void tableCell()
```
    Specified by:
    
    tableCell in interface Sink
    
    Overrides:
    
    tableCell in class SinkAdapter
  - tableHeaderCell
```
public void tableHeaderCell()
```
    Specified by:
    
    tableHeaderCell in interface Sink
    
    Overrides:
    
    tableHeaderCell in class SinkAdapter
  - tableCell
```
public void tableCell(String width)
```
    Specified by:
    
    tableCell in interface Sink
    
    Overrides:
    
    tableCell in class SinkAdapter
  - tableHeaderCell
```
public void tableHeaderCell(String width)
```
    Specified by:
    
    tableHeaderCell in interface Sink
    
    Overrides:
    
    tableHeaderCell in class SinkAdapter
  - tableCell
```
public void tableCell(SinkEventAttributes attributes)
```
    Specified by:
    
    tableCell in interface Sink
    
    Overrides:
    
    tableCell in class SinkAdapter
  - tableHeaderCell
```
public void tableHeaderCell(SinkEventAttributes attributes)
```
    Specified by:
    
    tableHeaderCell in interface Sink
    
    Overrides:
    
    tableHeaderCell in class SinkAdapter
  - tableCell_
```
public void tableCell_()
```
    Specified by:
    
    tableCell_ in interface Sink
    
    Overrides:
    
    tableCell_ in class SinkAdapter
  - tableHeaderCell_
```
public void tableHeaderCell_()
```
    Specified by:
    
    tableHeaderCell_ in interface Sink
    
    Overrides:
    
    tableHeaderCell_ in class SinkAdapter
  - tableCaption
```
public void tableCaption()
```
    Specified by:
    
    tableCaption in interface Sink
    
    Overrides:
    
    tableCaption in class SinkAdapter
    
    See Also:
    
    HTML.Tag.CAPTION
  - tableCaption
```
public void tableCaption(SinkEventAttributes attributes)
```
    Specified by:
    
    tableCaption in interface Sink
    
    Overrides:
    
    tableCaption in class SinkAdapter
    
    See Also:
    
    HTML.Tag.CAPTION
  - tableCaption_
```
public void tableCaption_()
```
    Specified by:
    
    tableCaption_ in interface Sink
    
    Overrides:
    
    tableCaption_ in class SinkAdapter
    
    See Also:
    
    HTML.Tag.CAPTION
  - anchor
```
public void anchor(String name)
```
    Specified by:
    
    anchor in interface Sink
    
    Overrides:
    
    anchor in class SinkAdapter
    
    See Also:
    
    HTML.Tag.A
  - anchor
```
public void anchor(String name,
                   SinkEventAttributes attributes)
```
    Specified by:
    
    anchor in interface Sink
    
    Overrides:
    
    anchor in class SinkAdapter
    
    See Also:
    
    HTML.Tag.A
  - anchor_
```
public void anchor_()
```
    Specified by:
    
    anchor_ in interface Sink
    
    Overrides:
    
    anchor_ in class SinkAdapter
    
    See Also:
    
    HTML.Tag.A
  - link
```
public void link(String name)
```
    Specified by:
    
    link in interface Sink
    
    Overrides:
    
    link in class SinkAdapter
  - link
```
public void link(String name,
                 SinkEventAttributes attributes)
```
    Specified by:
    
    link in interface Sink
    
    Overrides:
    
    link in class SinkAdapter
  - link_
```
public void link_()
```
    Specified by:
    
    link_ in interface Sink
    
    Overrides:
    
    link_ in class SinkAdapter
    
    See Also:
    
    HTML.Tag.A
  - inline
```
public void inline()
```
    Specified by:
    
    inline in interface Sink
    
    Overrides:
    
    inline in class SinkAdapter
  - inline
```
public void inline(SinkEventAttributes attributes)
```
    Specified by:
    
    inline in interface Sink
    
    Overrides:
    
    inline in class SinkAdapter
  - inline_
```
public void inline_()
```
    Specified by:
    
    inline_ in interface Sink
    
    Overrides:
    
    inline_ in class SinkAdapter
  - italic
```
public void italic()
```
    Specified by:
    
    italic in interface Sink
    
    Overrides:
    
    italic in class SinkAdapter
    
    See Also:
    
    HTML.Tag.I
  - italic_
```
public void italic_()
```
    Specified by:
    
    italic_ in interface Sink
    
    Overrides:
    
    italic_ in class SinkAdapter
    
    See Also:
    
    HTML.Tag.I
  - bold
```
public void bold()
```
    Specified by:
    
    bold in interface Sink
    
    Overrides:
    
    bold in class SinkAdapter
    
    See Also:
    
    HTML.Tag.B
  - bold_
```
public void bold_()
```
    Specified by:
    
    bold_ in interface Sink
    
    Overrides:
    
    bold_ in class SinkAdapter
    
    See Also:
    
    HTML.Tag.B
  - monospaced
```
public void monospaced()
```
    Specified by:
    
    monospaced in interface Sink
    
    Overrides:
    
    monospaced in class SinkAdapter
    
    See Also:
    
    HTML.Tag.CODE
  - monospaced_
```
public void monospaced_()
```
    Specified by:
    
    monospaced_ in interface Sink
    
    Overrides:
    
    monospaced_ in class SinkAdapter
    
    See Also:
    
    HTML.Tag.CODE
  - lineBreak
```
public void lineBreak()
```
    Specified by:
    
    lineBreak in interface Sink
    
    Overrides:
    
    lineBreak in class SinkAdapter
    
    See Also:
    
    HTML.Tag.BR
  - lineBreak
```
public void lineBreak(SinkEventAttributes attributes)
```
    Specified by:
    
    lineBreak in interface Sink
    
    Overrides:
    
    lineBreak in class SinkAdapter
    
    See Also:
    
    HTML.Tag.BR
  - lineBreakOpportunity
```
public void lineBreakOpportunity()
```
    Specified by:
    
    lineBreakOpportunity in interface Sink
    
    Overrides:
    
    lineBreakOpportunity in class SinkAdapter
  - lineBreakOpportunity
```
public void lineBreakOpportunity(SinkEventAttributes attributes)
```
    Specified by:
    
    lineBreakOpportunity in interface Sink
    
    Overrides:
    
    lineBreakOpportunity in class SinkAdapter
  - pageBreak
```
public void pageBreak()
```
    Specified by:
    
    pageBreak in interface Sink
    
    Overrides:
    
    pageBreak in class SinkAdapter
  - nonBreakingSpace
```
public void nonBreakingSpace()
```
    Specified by:
    
    nonBreakingSpace in interface Sink
    
    Overrides:
    
    nonBreakingSpace in class SinkAdapter
  - text
```
public void text(String text)
```
    Specified by:
    
    text in interface Sink
    
    Overrides:
    
    text in class SinkAdapter
  - text
```
public void text(String text,
                 SinkEventAttributes attributes)
```
    Specified by:
    
    text in interface Sink
    
    Overrides:
    
    text in class SinkAdapter
  - rawText
```
public void rawText(String text)
```
    Specified by:
    
    rawText in interface Sink
    
    Overrides:
    
    rawText in class SinkAdapter
  - comment
```
public void comment(String comment)
```
    Specified by:
    
    comment in interface Sink
    
    Overrides:
    
    comment in class SinkAdapter
  - unknown
```
public void unknown(String name,
                    Object[] requiredParams,
                    SinkEventAttributes attributes)
```
    Add an unknown event. This can be used to generate html tags for which no corresponding sink event exists.
    If HtmlTools.getHtmlTag( name ) does not return null, the corresponding tag will be written.
    
    For example, the div block
```
  <div class="detail" style="display:inline">text</div>
 
```
    can be generated via the following event sequence:
```
  SinkEventAttributeSet atts = new SinkEventAttributeSet();
  atts.addAttribute( SinkEventAttributes.CLASS, "detail" );
  atts.addAttribute( SinkEventAttributes.STYLE, "display:inline" );
  sink.unknown( "div", new Object[]{new Integer( HtmlMarkup.TAG_TYPE_START )}, atts );
  sink.text( "text" );
  sink.unknown( "div", new Object[]{new Integer( HtmlMarkup.TAG_TYPE_END )}, null );
 
```
    Specified by:
    
    unknown in interface Sink
    
    Overrides:
    
    unknown in class SinkAdapter
    
    Parameters:
    
    name - the name of the event. If this is not a valid xhtml tag name as defined in HtmlMarkup then the event is ignored.
    
    requiredParams - If this is null or the first argument is not an Integer then the event is ignored. The first argument should indicate the type of the unknown event, its integer value should be one of TAG_TYPE_START, TAG_TYPE_END, TAG_TYPE_SIMPLE, ENTITY_TYPE, or CDATA_TYPE, otherwise the event will be ignored.
    
    attributes - a set of attributes for the event. May be null. The attributes will always be written, no validity check is performed.
  - flush
```
public void flush()
```
    Specified by:
    
    flush in interface Sink
    
    Overrides:
    
    flush in class SinkAdapter
  - close
```
public void close()
```
    Specified by:
    
    close in interface Sink
    
    Overrides:
    
    close in class SinkAdapter
  - content
```
protected void content(String text)
```
    Write HTML escaped text to output.
    
    Parameters:
    
    text - The text to write.
  - verbatimContent
```
protected void verbatimContent(String text)
```
    Write HTML escaped text to output.
    
    Parameters:
    
    text - The text to write.
  - escapeHTML
```
protected static String escapeHTML(String text)
```
    Forward to HtmlTools.escapeHTML( text ).
    
    Parameters:
    
    text - the String to escape, may be null
    
    Returns:
    
    the text escaped, "" if null String input
    
    See Also:
    
    HtmlTools.escapeHTML(String)
  - encodeURL
```
protected static String encodeURL(String text)
```
    Forward to HtmlTools.encodeURL( text ).
    
    Parameters:
    
    text - the String to encode, may be null.
    
    Returns:
    
    the text encoded, null if null String input.
    
    See Also:
    
    HtmlTools.encodeURL(String)
  - write
```
protected void write(String text)
```
    Write a text to the sink.
    
    Specified by:
    
    write in class AbstractXmlSink
    
    Parameters:
    
    text - the given text to write
  - writeStartTag
```
protected void writeStartTag(HTML.Tag t,
                             MutableAttributeSet att,
                             boolean isSimpleTag)
```
    Starts a Tag with attributes. For instance:
```
 <tag attName="attValue">
 
```
    Overrides:
    
    writeStartTag in class AbstractXmlSink
    
    Parameters:
    
    t - a non null tag.
    
    att - a set of attributes. May be null.
    
    isSimpleTag - boolean to write as a simple tag.
  - writeEndTag
```
protected void writeEndTag(HTML.Tag t)
```
    Ends a Tag without writing an EOL. For instance:
```
</tag>
```
    .
    Overrides:
    
    writeEndTag in class AbstractXmlSink
    
    Parameters:
    
    t - a tag.

Class Xhtml5BaseSink

Field Summary

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

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

Constructor Summary

Method Summary

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

Field Detail

contentStack

inlineStack

tableAttributes

tableRows

Constructor Detail

Xhtml5BaseSink

Method Detail

getTextBuffer

setHeadFlag

isHeadFlag

setVerbatimFlag

isVerbatimFlag

setCellJustif

getCellJustif

setCellCount

getCellCount

resetState

init

resetTextBuffer

article

article

article_

navigation

navigation

navigation_

sidebar

sidebar

sidebar_

section

sectionTitle

sectionTitle_

section_

section1

sectionTitle1

sectionTitle1_

section1_

section2

sectionTitle2

sectionTitle2_

section2_

section3

sectionTitle3

sectionTitle3_

section3_

section4

sectionTitle4

sectionTitle4_

section4_

section5

sectionTitle5

sectionTitle5_

section5_

onSection

onSection_

onSectionTitle

onSectionTitle_

header

header

header_

content

content

content_

footer

footer

footer_

list

list