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

AutoCloseable, HtmlMarkup, Markup, XmlMarkup, Sink

Direct Known Subclasses:

XdocSink, Xhtml5Sink
```
public class Xhtml5BaseSink
extends AbstractXmlSink
implements HtmlMarkup
```
Abstract base xhtml5 sink implementation.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected static class Xhtml5BaseSink.VerbatimMode

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`Xhtml5BaseSink.VerbatimMode`

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().

Fields inherited from interface org.apache.maven.doxia.markup.HtmlMarkup
A, ABBR, ADDRESS, AREA, ARTICLE, ASIDE, AUDIO, B, BASE, BDI, BDO, BLOCKQUOTE, BODY, BR, BUTTON, CANVAS, CAPTION, CDATA_TYPE, CITE, CODE, COL, COLGROUP, COMMAND, DATA, DATALIST, DD, DEL, DETAILS, DFN, DIALOG, DIV, DL, DT, EM, EMBED, ENTITY_TYPE, FIELDSET, FIGCAPTION, FIGURE, FOOTER, FORM, H1, H2, H3, H4, H5, H6, HEAD, HEADER, HGROUP, HR, HTML, I, IFRAME, IMG, INPUT, INS, KBD, KEYGEN, LABEL, LEGEND, LI, LINK, MAIN, MAP, MARK, MENU, MENUITEM, META, METER, NAV, 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, STRONG, STYLE, SUB, SUMMARY, SUP, SVG, TABLE, TAG_TYPE_END, TAG_TYPE_SIMPLE, TAG_TYPE_START, TBODY, TD, TEMPLATE, TEXTAREA, TFOOT, TH, THEAD, TIME, TITLE, TR, TRACK, 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, 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
Modifier and Type	Method and Description
`void`	`address_()` Ends an address element.
`void`	`address(SinkEventAttributes attributes)` Starts an address element.
`void`	`anchor_()` Ends an anchor element.
`void`	`anchor(String name, SinkEventAttributes attributes)` Starts an element which defines an anchor.
`void`	`article_()` Ends the article element.
`void`	`article(SinkEventAttributes attributes)` Starts an article within a document.
`void`	`blockquote_()` Ends an blockquote element.
`void`	`blockquote(SinkEventAttributes attributes)` Starts a blockquote element.
`void`	`bold_()` Ends a bold element.
`void`	`bold()` Starts a bold element.
`void`	`close()` Close the writer or the stream, if needed.
`void`	`comment(String comment)` Add a comment.
`void`	`content_()` Ends a main content section.
`void`	`content(SinkEventAttributes attributes)` Start the main content section between the header and the footer within the sections and/or body.
`protected void`	`content(String text)` Write HTML escaped text to output.
`void`	`data_()` Ends an data element.
`void`	`data(String value, SinkEventAttributes attributes)` Starts a data element which groups together other elements representing microformats.
`void`	`definedTerm_()` Ends a definition term element within a definition list.
`void`	`definedTerm(SinkEventAttributes attributes)` Starts a definition term element within a definition list.
`void`	`definition_()` Ends a definition element within a definition list.
`void`	`definition(SinkEventAttributes attributes)` Starts a definition element within a definition list.
`void`	`definitionList_()` Ends a definition list element.
`void`	`definitionList(SinkEventAttributes attributes)` Starts a definition list.
`void`	`division_()` Ends a division element.
`void`	`division(SinkEventAttributes attributes)` Starts a division element grouping together other elements.
`protected static String`	`encodeURL(String text)` Forward to HtmlTools.encodeURL(text).
`protected static String`	`escapeHTML(String text)` Forward to HtmlTools.escapeHTML(text).
`void`	`figure_()` Ends a basic image embedding element.
`void`	`figure(SinkEventAttributes attributes)` Starts a basic image embedding element.
`void`	`figureCaption_()` Ends a caption of an image.
`void`	`figureCaption(SinkEventAttributes attributes)` Starts a figure caption.
`void`	`figureGraphics(String src, SinkEventAttributes attributes)` Adds a graphic element.
`void`	`flush()` Flush the writer or the stream, if needed.
`void`	`footer_()` Ends a footer element.
`void`	`footer(SinkEventAttributes attributes)` Start a new footer within the section or body.
`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.
`protected Xhtml5BaseSink.VerbatimMode`	`getVerbatimMode()`
`void`	`header_()` Ends a header element.
`void`	`header(SinkEventAttributes attributes)` Start a new header within the section or body.
`void`	`horizontalRule(SinkEventAttributes attributes)` Adds a horizontal separator rule.
`protected void`	`init()` This is called in `AbstractSink.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_()` Ends an inline element.
`void`	`inline(SinkEventAttributes attributes)` Starts an inline element.
`protected boolean`	`isHeadFlag()` isHeadFlag.
`protected boolean`	`isVerbatim()`
`void`	`italic_()` Ends an italic element.
`void`	`italic()` Starts an italic element.
`void`	`lineBreak(SinkEventAttributes attributes)` Adds a line break.
`void`	`lineBreakOpportunity(SinkEventAttributes attributes)` Adds a line break opportunity.
`void`	`link_()` Ends a link element.
`void`	`link(String name, SinkEventAttributes attributes)` The default style class for external link is `externalLink`.
`void`	`list_()` Ends an unordered list element.
`void`	`list(SinkEventAttributes attributes)` Starts an unordered list.
`void`	`listItem_()` Ends a list item element within an unordered list.
`void`	`listItem(SinkEventAttributes attributes)` Starts a list item element within an unordered list.
`void`	`monospaced_()` Ends a monospaced element.
`void`	`monospaced()` Starts a monospaced element.
`void`	`navigation_()` Ends the navigation element.
`void`	`navigation(SinkEventAttributes attributes)` Starts a navigation section within a document.
`void`	`nonBreakingSpace()` Adding a non breaking space, ie a space without any special formatting operations.
`void`	`numberedList_()` Ends an ordered list element.
`void`	`numberedList(int numbering, SinkEventAttributes attributes)` The default list style depends on the numbering.
`void`	`numberedListItem_()` Ends a list item element within an ordered list.
`void`	`numberedListItem(SinkEventAttributes attributes)` Starts a list item element within an ordered list.
`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()` Adding a new page separator.
`void`	`paragraph_()` Ends a paragraph element.
`void`	`paragraph(SinkEventAttributes attributes)` Starts a paragraph.
`void`	`rawText(String text)` Adding a raw text, ie a text without any special formatting operations.
`protected void`	`resetTextBuffer()` Reset the text buffer.
`void`	`section_(int level)` Ends a section at the given level.
`void`	`section(int level, SinkEventAttributes attributes)` Start a new section at the given level.
`void`	`sectionTitle_(int level)` Ends a section title at the given level.
`void`	`sectionTitle(int level, SinkEventAttributes attributes)` Start a new section title at the given level.
`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`	`setVerbatimMode(Xhtml5BaseSink.VerbatimMode mode)` Setter for the field `verbatimMode`.
`void`	`sidebar_()` Ends the sidebar element.
`void`	`sidebar(SinkEventAttributes attributes)` Starts a sidebar section within a document.
`void`	`table_()` Ends a table element.
`void`	`table(SinkEventAttributes attributes)` Starts a table.
`void`	`tableCaption_()` Ends a caption element of a table.
`void`	`tableCaption(SinkEventAttributes attributes)` Starts a table caption.
`void`	`tableCell_()` Ends a cell element.
`void`	`tableCell(SinkEventAttributes attributes)` Starts a table cell.
`void`	`tableHeaderCell_()` Ends a cell header element.
`void`	`tableHeaderCell(SinkEventAttributes attributes)` Starts a table header cell.
`void`	`tableRow_()` Ends a row element.
`void`	`tableRow(SinkEventAttributes attributes)` Rows are striped with two colors by adding the class `a` or `b`.
`void`	`tableRows_()` Ends an element that contains rows of table data.
`void`	`tableRows(int[] justification, boolean grid)` The default style class is `bodyTable`.
`void`	`text(String text, SinkEventAttributes attributes)` Adds a text.
`void`	`time_()` Ends a time element.
`void`	`time(String datetime, SinkEventAttributes attributes)` Starts a time element which groups together other elements representing a time.
`void`	`unknown(String name, Object[] requiredParams, SinkEventAttributes attributes)` Add an unknown event.
`void`	`verbatim_()` Ends a verbatim element.
`void`	`verbatim(SinkEventAttributes attributes)` Depending on whether the decoration attribute is "source" or not, this leads to either emitting {@code
`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, body_, body, date_, date, definitionListItem_, definitionListItem, head_, head, title_, title

Methods inherited from class org.apache.maven.doxia.sink.impl.AbstractSink
address, anchor, article, author, blockquote, body, content, data, date, definedTerm, definition, definitionList, definitionListItem, division, figure, figureCaption, figureGraphics, footer, formatLocation, getDocumentLocator, getLocationLogPrefix, head, header, horizontalRule, inline, lineBreak, lineBreakOpportunity, link, list, listItem, navigation, numberedList, numberedListItem, paragraph, section1_, section1, section2_, section2, section3_, section3, section4_, section4, section5_, section5, section6_, section6, sectionTitle_, sectionTitle, sectionTitle1_, sectionTitle1, sectionTitle2_, sectionTitle2, sectionTitle3_, sectionTitle3, sectionTitle4_, sectionTitle4, sectionTitle5_, sectionTitle5, sectionTitle6_, sectionTitle6, setDocumentLocator, sidebar, table, tableCaption, tableCell, tableHeaderCell, tableRow, tableRows, text, time, title, unifyEOLs, verbatim

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().
- 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.
  - getVerbatimMode
```
protected Xhtml5BaseSink.VerbatimMode getVerbatimMode()
```
    Returns:
    
    the current verbatim mode.
  - setVerbatimMode
```
protected void setVerbatimMode(Xhtml5BaseSink.VerbatimMode mode)
```
    Setter for the field verbatimMode.
    
    Parameters:
    
    mode - a verbatim mode.
  - isVerbatim
```
protected boolean isVerbatim()
```
    Returns:
    
    true if inside verbatim section, false otherwise
  - 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.
  - init
```
protected void init()
```
    This is called in AbstractSink.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(SinkEventAttributes attributes)
```
    Starts an article within a document.
    Supported attributes are the base attributes.
    
    Specified by:
    
    article in interface Sink
    
    Overrides:
    
    article in class SinkAdapter
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
  - article_
```
public void article_()
```
    Ends the article element.
    
    Specified by:
    
    article_ in interface Sink
    
    Overrides:
    
    article_ in class SinkAdapter
  - navigation
```
public void navigation(SinkEventAttributes attributes)
```
    Starts a navigation section within a document.
    Supported attributes are the base attributes.
    
    Specified by:
    
    navigation in interface Sink
    
    Overrides:
    
    navigation in class SinkAdapter
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
    
    See Also:
    
    Sink.navigation(SinkEventAttributes)
  - navigation_
```
public void navigation_()
```
    Ends the navigation element.
    
    Specified by:
    
    navigation_ in interface Sink
    
    Overrides:
    
    navigation_ in class SinkAdapter
  - sidebar
```
public void sidebar(SinkEventAttributes attributes)
```
    Starts a sidebar section within a document.
    Supported attributes are the base attributes.
    
    Specified by:
    
    sidebar in interface Sink
    
    Overrides:
    
    sidebar in class SinkAdapter
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
  - sidebar_
```
public void sidebar_()
```
    Ends the sidebar element.
    
    Specified by:
    
    sidebar_ in interface Sink
    
    Overrides:
    
    sidebar_ in class SinkAdapter
  - section
```
public void section(int level,
                    SinkEventAttributes attributes)
```
    Start a new section at the given level.
    Sections with higher level have to be entirely contained within sections of lower level.
    
    Supported attributes are the base attributes.
    
    Specified by:
    
    section in interface Sink
    
    Overrides:
    
    section in class SinkAdapter
    
    Parameters:
    
    level - the section level (must be a value between 1 and 6).
    
    attributes - A set of SinkEventAttributes, may be null.
  - sectionTitle
```
public void sectionTitle(int level,
                         SinkEventAttributes attributes)
```
    Start a new section title at the given level.
    This element is optional, but if it exists, it has to be contained, and be the first element, within a corresponding section element of the same level.
    
    NOTE: It is strongly recommended not to make section titles implicit anchors. Neither Parsers nor Sinks should insert any content that is not explicitly present in the original source document, as this would lead to undefined behaviour for multi-format processing chains. However, while Parsers must never emit anchors for section titles, some specialized Sinks may implement such a feature if the resulting output documents are not going to be further processed (and this is properly documented).
    
    Supported attributes are the base attributes plus ALIGN.
    
    Specified by:
    
    sectionTitle in interface Sink
    
    Overrides:
    
    sectionTitle in class SinkAdapter
    
    Parameters:
    
    level - the section title level (must be a value between 1 and 6).
    
    attributes - A set of SinkEventAttributes, may be null.
  - sectionTitle_
```
public void sectionTitle_(int level)
```
    Ends a section title at the given level.
    
    Specified by:
    
    sectionTitle_ in interface Sink
    
    Overrides:
    
    sectionTitle_ in class SinkAdapter
    
    Parameters:
    
    level - the section title level (must be a value between 1 and 6).
  - section_
```
public void section_(int level)
```
    Ends a section at the given level.
    
    Specified by:
    
    section_ in interface Sink
    
    Overrides:
    
    section_ in class SinkAdapter
    
    Parameters:
    
    level - the section level (must be a value between 1 and 6).
  - onSection
```
protected void onSection(int depth,
                         SinkEventAttributes attributes)
```
    Starts a 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:
    
    HtmlMarkup.SECTION
  - 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:
    
    HtmlMarkup.H1, HtmlMarkup.H2, HtmlMarkup.H3, HtmlMarkup.H4, HtmlMarkup.H5, HtmlMarkup.H6
  - onSectionTitle_
```
protected void onSectionTitle_(int depth)
```
    Ends a section title.
    
    Parameters:
    
    depth - The level of the section title.
    
    See Also:
    
    HtmlMarkup.H1, HtmlMarkup.H2, HtmlMarkup.H3, HtmlMarkup.H4, HtmlMarkup.H5, HtmlMarkup.H6
  - header
```
public void header(SinkEventAttributes attributes)
```
    Start a new header within the section or body.
    Supported attributes are the base attributes.
    
    Specified by:
    
    header in interface Sink
    
    Overrides:
    
    header in class SinkAdapter
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
  - header_
```
public void header_()
```
    Ends a header element.
    
    Specified by:
    
    header_ in interface Sink
    
    Overrides:
    
    header_ in class SinkAdapter
  - content
```
public void content(SinkEventAttributes attributes)
```
    Start the main content section between the header and the footer within the sections and/or body.
    Supported attributes are the base attributes.
    
    Specified by:
    
    content in interface Sink
    
    Overrides:
    
    content in class SinkAdapter
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
  - content_
```
public void content_()
```
    Ends a main content section.
    
    Specified by:
    
    content_ in interface Sink
    
    Overrides:
    
    content_ in class SinkAdapter
  - footer
```
public void footer(SinkEventAttributes attributes)
```
    Start a new footer within the section or body.
    Supported attributes are the base attributes.
    
    Specified by:
    
    footer in interface Sink
    
    Overrides:
    
    footer in class SinkAdapter
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
  - footer_
```
public void footer_()
```
    Ends a footer element.
    
    Specified by:
    
    footer_ in interface Sink
    
    Overrides:
    
    footer_ in class SinkAdapter
  - list
```
public void list(SinkEventAttributes attributes)
```
    Starts an unordered list.
    Supported attributes are the base attributes.
    
    Specified by:
    
    list in interface Sink
    
    Overrides:
    
    list in class SinkAdapter
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
    
    See Also:
    
    HTML.Tag.UL
  - list_
```
public void list_()
```
    Ends an unordered list element.
    
    Specified by:
    
    list_ in interface Sink
    
    Overrides:
    
    list_ in class SinkAdapter
    
    See Also:
    
    HTML.Tag.UL
  - listItem
```
public void listItem(SinkEventAttributes attributes)
```
    Starts a list item element within an unordered list.
    Supported attributes are the base attributes.
    
    Specified by:
    
    listItem in interface Sink
    
    Overrides:
    
    listItem in class SinkAdapter
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
    
    See Also:
    
    HTML.Tag.LI
  - listItem_
```
public void listItem_()
```
    Ends a list item element within an unordered list.
    
    Specified by:
    
    listItem_ in interface Sink
    
    Overrides:
    
    listItem_ in class SinkAdapter
    
    See Also:
    
    HTML.Tag.LI
  - numberedList
```
public void numberedList(int numbering,
                         SinkEventAttributes attributes)
```
    The default list style depends on the numbering. Starts an ordered list element.
    Supported attributes are the base attributes.
    
    Specified by:
    
    numberedList in interface Sink
    
    Overrides:
    
    numberedList in class SinkAdapter
    
    Parameters:
    
    numbering - the numbering style.
    
    attributes - A set of SinkEventAttributes, may be null.
    
    See Also:
    
    HTML.Tag.OL
  - numberedList_
```
public void numberedList_()
```
    Ends an ordered list element.
    
    Specified by:
    
    numberedList_ in interface Sink
    
    Overrides:
    
    numberedList_ in class SinkAdapter
    
    See Also:
    
    HTML.Tag.OL
  - numberedListItem
```
public void numberedListItem(SinkEventAttributes attributes)
```
    Starts a list item element within an ordered list.
    Supported attributes are the base attributes.
    
    Specified by:
    
    numberedListItem in interface Sink
    
    Overrides:
    
    numberedListItem in class SinkAdapter
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
    
    See Also:
    
    HTML.Tag.LI
  - numberedListItem_
```
public void numberedListItem_()
```
    Ends a list item element within an ordered list.
    
    Specified by:
    
    numberedListItem_ in interface Sink
    
    Overrides:
    
    numberedListItem_ in class SinkAdapter
    
    See Also:
    
    HTML.Tag.LI
  - definitionList
```
public void definitionList(SinkEventAttributes attributes)
```
    Starts a definition list.
    Supported attributes are the base attributes.
    
    Specified by:
    
    definitionList in interface Sink
    
    Overrides:
    
    definitionList in class SinkAdapter
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
    
    See Also:
    
    HTML.Tag.DL
  - definitionList_
```
public void definitionList_()
```
    Ends a definition list element.
    
    Specified by:
    
    definitionList_ in interface Sink
    
    Overrides:
    
    definitionList_ in class SinkAdapter
    
    See Also:
    
    HTML.Tag.DL
  - definedTerm
```
public void definedTerm(SinkEventAttributes attributes)
```
    Starts a definition term element within a definition list.
    Supported attributes are the base attributes.
    
    Specified by:
    
    definedTerm in interface Sink
    
    Overrides:
    
    definedTerm in class SinkAdapter
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
    
    See Also:
    
    HTML.Tag.DT
  - definedTerm_
```
public void definedTerm_()
```
    Ends a definition term element within a definition list.
    
    Specified by:
    
    definedTerm_ in interface Sink
    
    Overrides:
    
    definedTerm_ in class SinkAdapter
    
    See Also:
    
    HTML.Tag.DT
  - definition
```
public void definition(SinkEventAttributes attributes)
```
    Starts a definition element within a definition list.
    Supported attributes are the base attributes.
    
    Specified by:
    
    definition in interface Sink
    
    Overrides:
    
    definition in class SinkAdapter
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
    
    See Also:
    
    HTML.Tag.DD
  - definition_
```
public void definition_()
```
    Ends a definition element within a definition list.
    
    Specified by:
    
    definition_ in interface Sink
    
    Overrides:
    
    definition_ in class SinkAdapter
    
    See Also:
    
    HTML.Tag.DD
  - figure
```
public void figure(SinkEventAttributes attributes)
```
    Starts a basic image embedding element.
    The canonical sequence of events for the figure element is:
```
   sink.figure();

   sink.figureGraphics("figure.png");

   sink.figureCaption();
   sink.text("Figure caption",);
   sink.figureCaption_();

   sink.figure_();
 
```
    where the figureCaption element is optional.
    
    However, NOTE that the order of figureCaption and figureGraphics events is arbitrary, ie a parser may emit the figureCaption before or after the figureGraphics. Implementing sinks should be prepared to handle both possibilities.
    
    NOTE also that the figureGraphics() event does not have to be embedded inside figure(), in particular for in-line images the figureGraphics() should be used stand-alone (in HTML language, figureGraphics() produces a <img> tag, while figure() opens a paragraph- or <div>- like environment).
    
    Supported attributes are the base attributes.
    Specified by:
    
    figure in interface Sink
    
    Overrides:
    
    figure in class SinkAdapter
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
  - figure_
```
public void figure_()
```
    Ends a basic image embedding element.
    
    Specified by:
    
    figure_ in interface Sink
    
    Overrides:
    
    figure_ in class SinkAdapter
  - figureGraphics
```
public void figureGraphics(String src,
                           SinkEventAttributes attributes)
```
    Adds a graphic element.
    The src parameter should be a valid link, ie it can be an absolute URL or a link relative to the current source document.
    
    Supported attributes are the base attributes plus:
    
    SRC, ALT, WIDTH, HEIGHT, ALIGN, BORDER, HSPACE, VSPACE, ISMAP, USEMAP.
    
    If the SRC attribute is specified in SinkEventAttributes, it will be overridden by the src parameter.
    
    Specified by:
    
    figureGraphics in interface Sink
    
    Overrides:
    
    figureGraphics in class SinkAdapter
    
    Parameters:
    
    src - the image source, a valid URL.
    
    attributes - A set of SinkEventAttributes, may be null.
    
    See Also:
    
    Sink.figure(SinkEventAttributes)
  - figureCaption
```
public void figureCaption(SinkEventAttributes attributes)
```
    Starts a figure caption.
    Supported attributes are the base attributes.
    
    Specified by:
    
    figureCaption in interface Sink
    
    Overrides:
    
    figureCaption in class SinkAdapter
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
    
    See Also:
    
    Sink.figure(SinkEventAttributes)
  - figureCaption_
```
public void figureCaption_()
```
    Ends a caption of an image.
    
    Specified by:
    
    figureCaption_ in interface Sink
    
    Overrides:
    
    figureCaption_ in class SinkAdapter
  - paragraph
```
public void paragraph(SinkEventAttributes attributes)
```
    Starts a paragraph.
    Supported attributes are the base attributes plus ALIGN.
    
    Specified by:
    
    paragraph in interface Sink
    
    Overrides:
    
    paragraph in class SinkAdapter
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
    
    See Also:
    
    HTML.Tag.P
  - paragraph_
```
public void paragraph_()
```
    Ends a paragraph element.
    
    Specified by:
    
    paragraph_ in interface Sink
    
    Overrides:
    
    paragraph_ in class SinkAdapter
    
    See Also:
    
    HTML.Tag.P
  - data
```
public void data(String value,
                 SinkEventAttributes attributes)
```
    Starts a data element which groups together other elements representing microformats.
    Supported attributes are the base attributes plus VALUE.
    
    Specified by:
    
    data in interface Sink
    
    Overrides:
    
    data in class SinkAdapter
    
    Parameters:
    
    value - the machine readable value of the data, may be null.
    
    attributes - A set of SinkEventAttributes, may be null.
  - data_
```
public void data_()
```
    Ends an data element.
    
    Specified by:
    
    data_ in interface Sink
    
    Overrides:
    
    data_ in class SinkAdapter
  - time
```
public void time(String datetime,
                 SinkEventAttributes attributes)
```
    Starts a time element which groups together other elements representing a time.
    Supported attributes are the base attributes plus DATETIME.
    
    Specified by:
    
    time in interface Sink
    
    Overrides:
    
    time in class SinkAdapter
    
    Parameters:
    
    datetime - the machine readable value of the time, may be null.
    
    attributes - A set of SinkEventAttributes, may be null.
  - time_
```
public void time_()
```
    Ends a time element.
    
    Specified by:
    
    time_ in interface Sink
    
    Overrides:
    
    time_ in class SinkAdapter
  - address
```
public void address(SinkEventAttributes attributes)
```
    Starts an address element.
    
    Specified by:
    
    address in interface Sink
    
    Overrides:
    
    address in class SinkAdapter
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
    
    See Also:
    
    HTML.Tag.ADDRESS
  - address_
```
public void address_()
```
    Ends an address element.
    
    Specified by:
    
    address_ in interface Sink
    
    Overrides:
    
    address_ in class SinkAdapter
    
    See Also:
    
    HTML.Tag.ADDRESS
  - blockquote
```
public void blockquote(SinkEventAttributes attributes)
```
    Starts a blockquote element.
    Supported attributes are the base attributes.
    
    Specified by:
    
    blockquote in interface Sink
    
    Overrides:
    
    blockquote in class SinkAdapter
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
    
    See Also:
    
    HTML.Tag.BLOCKQUOTE
  - blockquote_
```
public void blockquote_()
```
    Ends an blockquote element.
    
    Specified by:
    
    blockquote_ in interface Sink
    
    Overrides:
    
    blockquote_ in class SinkAdapter
    
    See Also:
    
    HTML.Tag.BLOCKQUOTE
  - division
```
public void division(SinkEventAttributes attributes)
```
    Starts a division element grouping together other elements.
    Supported attributes are the base attributes plus ALIGN.
    
    Specified by:
    
    division in interface Sink
    
    Overrides:
    
    division in class SinkAdapter
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
    
    See Also:
    
    HTML.Tag.DIV
  - division_
```
public void division_()
```
    Ends a division element.
    
    Specified by:
    
    division_ in interface Sink
    
    Overrides:
    
    division_ in class SinkAdapter
    
    See Also:
    
    HTML.Tag.DIV
  - verbatim
```
public void verbatim(SinkEventAttributes attributes)
```
    Depending on whether the decoration attribute is "source" or not, this leads to either emitting <pre><code> or just <pre>. No default classes are emitted but the given attributes are always added to the pre element only. Starts a verbatim block, ie a block where whitespace has semantic relevance.
    Text in a verbatim block must only be wrapped at the linebreaks in the source, and spaces should not be collapsed. It should be displayed in a fixed-width font to retain the formatting but the overall size may be chosen by the implementation.
    
    Most Sink events may be emitted within a verbatim block, the only elements explicitly forbidden are font-changing events and figures. Also, verbatim blocks may not be nested.
    
    Supported attributes are the base attributes plus:
    
    DECORATION (values: "source"), ALIGN, WIDTH.
    
    Specified by:
    
    verbatim in interface Sink
    
    Overrides:
    
    verbatim in class SinkAdapter
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
    
    See Also:
    
    HTML.Tag.PRE, HTML.Tag.CODE
  - verbatim_
```
public void verbatim_()
```
    Ends a verbatim element.
    
    Specified by:
    
    verbatim_ in interface Sink
    
    Overrides:
    
    verbatim_ in class SinkAdapter
    
    See Also:
    
    HTML.Tag.CODE, HTML.Tag.PRE
  - horizontalRule
```
public void horizontalRule(SinkEventAttributes attributes)
```
    Adds a horizontal separator rule.
    Supported attributes are the base attributes plus:
    
    ALIGN, NOSHADE, SIZE, WIDTH.
    
    Specified by:
    
    horizontalRule in interface Sink
    
    Overrides:
    
    horizontalRule in class SinkAdapter
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
    
    See Also:
    
    HTML.Tag.HR
  - table
```
public void table(SinkEventAttributes attributes)
```
    Starts a table.
    The canonical sequence of events for the table element is:
```
   sink.table();

   sink.tableRows(justify, true);

   sink.tableRow();
   sink.tableCell();
   sink.text("cell 1,1");
   sink.tableCell_();
   sink.tableCell();
   sink.text("cell 1,2");
   sink.tableCell_();
   sink.tableRow_();

   sink.tableRows_();

   sink.tableCaption();
   sink.text("Table caption");
   sink.tableCaption_();

   sink.table_();

 
```
    where the tableCaption element is optional.
    
    However, NOTE that the order of tableCaption and Sink.tableRows(int[],boolean) events is arbitrary, ie a parser may emit the tableCaption before or after the tableRows. Implementing sinks should be prepared to handle both possibilities.
    
    Supported attributes are the base attributes plus:
    
    ALIGN, BGCOLOR, BORDER, CELLPADDING, CELLSPACING, FRAME, RULES, SUMMARY, WIDTH.
    Specified by:
    
    table in interface Sink
    
    Overrides:
    
    table in class SinkAdapter
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
  - table_
```
public void table_()
```
    Ends a table element.
    
    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 style class is bodyTable.
    
    Specified by:
    
    tableRows in interface Sink
    
    Overrides:
    
    tableRows in class SinkAdapter
    
    Parameters:
    
    grid - if true the style class bodyTableBorder will be added true to provide a grid, false otherwise.
    
    justification - the default justification of columns. This can be overridden by individual table rows or table cells. If null a left alignment is assumed by default. If this array has less elements than there are columns in the table then the value of the last array element will be taken as default for the remaining table cells.
    
    See Also:
    
    HTML.Tag.TABLE
  - tableRows_
```
public void tableRows_()
```
    Ends an element that contains rows of table data.
    
    Specified by:
    
    tableRows_ in interface Sink
    
    Overrides:
    
    tableRows_ in class SinkAdapter
  - tableRow
```
public void tableRow(SinkEventAttributes attributes)
```
    Rows are striped with two colors by adding the class a or b. If the provided attributes specify the hidden class, the next call to tableRow will set the same striping class as this one. A style for hidden or table.bodyTable hidden may need to be provided to actually hide such a row. Starts a table row.
    Supported attributes are the base attributes plus:
    
    ALIGN, BGCOLOR, VALIGN.
    
    Specified by:
    
    tableRow in interface Sink
    
    Overrides:
    
    tableRow in class SinkAdapter
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
    
    See Also:
    
    HTML.Tag.TR
  - tableRow_
```
public void tableRow_()
```
    Ends a row element.
    
    Specified by:
    
    tableRow_ in interface Sink
    
    Overrides:
    
    tableRow_ in class SinkAdapter
    
    See Also:
    
    HTML.Tag.TR
  - tableCell
```
public void tableCell(SinkEventAttributes attributes)
```
    Starts a table cell.
    Supported attributes are the base attributes plus:
    
    ABBRV, ALIGN, AXIS, BGCOLOR, COLSPAN, HEADERS, HEIGHT, NOWRAP, ROWSPAN, SCOPE, VALIGN, WIDTH.
    
    Specified by:
    
    tableCell in interface Sink
    
    Overrides:
    
    tableCell in class SinkAdapter
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
  - tableHeaderCell
```
public void tableHeaderCell(SinkEventAttributes attributes)
```
    Starts a table header cell.
    Supported attributes are the same as for tableCell.
    
    Specified by:
    
    tableHeaderCell in interface Sink
    
    Overrides:
    
    tableHeaderCell in class SinkAdapter
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
  - tableCell_
```
public void tableCell_()
```
    Ends a cell element.
    
    Specified by:
    
    tableCell_ in interface Sink
    
    Overrides:
    
    tableCell_ in class SinkAdapter
  - tableHeaderCell_
```
public void tableHeaderCell_()
```
    Ends a cell header element.
    
    Specified by:
    
    tableHeaderCell_ in interface Sink
    
    Overrides:
    
    tableHeaderCell_ in class SinkAdapter
  - tableCaption
```
public void tableCaption(SinkEventAttributes attributes)
```
    Starts a table caption.
    Note that the order of tableCaption and Sink.tableRows(int[],boolean) events is arbitrary, ie a parser may emit the tableCaption before or after the tableRows. Implementing sinks should be prepared to handle both possibilities.
    
    Supported attributes are the base attributes plus ALIGN.
    
    Specified by:
    
    tableCaption in interface Sink
    
    Overrides:
    
    tableCaption in class SinkAdapter
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
    
    See Also:
    
    HTML.Tag.CAPTION
  - tableCaption_
```
public void tableCaption_()
```
    Ends a caption element of a table.
    
    Specified by:
    
    tableCaption_ in interface Sink
    
    Overrides:
    
    tableCaption_ in class SinkAdapter
    
    See Also:
    
    HTML.Tag.CAPTION
  - anchor
```
public void anchor(String name,
                   SinkEventAttributes attributes)
```
    Starts an element which defines an anchor.
    The name parameter has to be a valid SGML NAME token. According to the HTML 4.01 specification section 6.2 SGML basic types:
    
    ID and NAME tokens must begin with a letter ([A-Za-z]) and may be followed by any number of letters, digits ([0-9]), hyphens ("-"), underscores ("_"), colons (":"), and periods (".").
    
    Supported attributes are the base attributes. If NAME is specified in the SinkEventAttributes, it will be overwritten by the name parameter.
    
    Specified by:
    
    anchor in interface Sink
    
    Overrides:
    
    anchor in class SinkAdapter
    
    Parameters:
    
    name - the name of the anchor. This has to be a valid SGML NAME token.
    
    attributes - A set of SinkEventAttributes, may be null.
    
    See Also:
    
    HTML.Tag.A
  - anchor_
```
public void anchor_()
```
    Ends an anchor element.
    
    Specified by:
    
    anchor_ in interface Sink
    
    Overrides:
    
    anchor_ in class SinkAdapter
    
    See Also:
    
    HTML.Tag.A
  - link
```
public void link(String name,
                 SinkEventAttributes attributes)
```
    The default style class for external link is externalLink. Starts a link.
    The name parameter has to be a valid URI according to RFC 3986, i.e. for internal links (links to an anchor within the same source document), name should start with the character "#". This also implies that all unsafe characters are already encoded.
    
    Supported attributes are the base attributes plus:
    
    CHARSET, COORDS, HREF, HREFLANG, REL, REV, SHAPE, TARGET, TYPE.
    
    If HREF is specified in the SinkEventAttributes, it will be overwritten by the name parameter.
    
    Specified by:
    
    link in interface Sink
    
    Overrides:
    
    link in class SinkAdapter
    
    Parameters:
    
    name - the name of the link.
    
    attributes - A set of SinkEventAttributes, may be null.
    
    See Also:
    
    HTML.Tag.A
  - link_
```
public void link_()
```
    Ends a link element.
    
    Specified by:
    
    link_ in interface Sink
    
    Overrides:
    
    link_ in class SinkAdapter
    
    See Also:
    
    HTML.Tag.A
  - inline
```
public void inline(SinkEventAttributes attributes)
```
    Starts an inline element.
    The inline method is similar to Sink.text(String,SinkEventAttributes), but allows you to wrap arbitrary elements in addition to text.
    
    Supported attributes are the base attributes plus
    
    SEMANTICS (values "emphasis", "strong", "small", "line-through", "citation", "quote", "definition", "abbreviation", "italic", "bold", "monospaced", "variable", "sample", "keyboard", "superscript", "subscript", "annotation", "highlight", "ruby", "rubyBase", "rubyText", "rubyTextContainer", "rubyParentheses", "bidirectionalIsolation", "bidirectionalOverride", "phrase", "insert", "delete").
    
    Specified by:
    
    inline in interface Sink
    
    Overrides:
    
    inline in class SinkAdapter
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
  - inline_
```
public void inline_()
```
    Ends an inline element.
    
    Specified by:
    
    inline_ in interface Sink
    
    Overrides:
    
    inline_ in class SinkAdapter
  - italic
```
public void italic()
```
    Starts an italic element. Alternatively one may use Sink.text(String,SinkEventAttributes) with STYLE instead.
    
    Specified by:
    
    italic in interface Sink
    
    Overrides:
    
    italic in class SinkAdapter
    
    See Also:
    
    HTML.Tag.I
  - italic_
```
public void italic_()
```
    Ends an italic element. Alternatively one may use Sink.text(String,SinkEventAttributes) with STYLE instead.
    
    Specified by:
    
    italic_ in interface Sink
    
    Overrides:
    
    italic_ in class SinkAdapter
    
    See Also:
    
    HTML.Tag.I
  - bold
```
public void bold()
```
    Starts a bold element. Alternatively one may use Sink.text(String,SinkEventAttributes) with STYLE instead.
    
    Specified by:
    
    bold in interface Sink
    
    Overrides:
    
    bold in class SinkAdapter
    
    See Also:
    
    HTML.Tag.B
  - bold_
```
public void bold_()
```
    Ends a bold element. Alternatively one may use Sink.text(String,SinkEventAttributes) with STYLE instead.
    
    Specified by:
    
    bold_ in interface Sink
    
    Overrides:
    
    bold_ in class SinkAdapter
    
    See Also:
    
    HTML.Tag.B
  - monospaced
```
public void monospaced()
```
    Starts a monospaced element. Alternatively one may use Sink.text(String,SinkEventAttributes) with STYLE instead.
    
    Specified by:
    
    monospaced in interface Sink
    
    Overrides:
    
    monospaced in class SinkAdapter
    
    See Also:
    
    HTML.Tag.CODE
  - monospaced_
```
public void monospaced_()
```
    Ends a monospaced element. Alternatively one may use Sink.text(String,SinkEventAttributes) with STYLE instead.
    
    Specified by:
    
    monospaced_ in interface Sink
    
    Overrides:
    
    monospaced_ in class SinkAdapter
    
    See Also:
    
    HTML.Tag.CODE
  - lineBreak
```
public void lineBreak(SinkEventAttributes attributes)
```
    Adds a line break.
    Supported attributes are:
    
    ID, CLASS, TITLE, STYLE.
    
    Specified by:
    
    lineBreak in interface Sink
    
    Overrides:
    
    lineBreak in class SinkAdapter
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
    
    See Also:
    
    HTML.Tag.BR
  - lineBreakOpportunity
```
public void lineBreakOpportunity(SinkEventAttributes attributes)
```
    Adds a line break opportunity.
    Supported attributes are:
    
    ID, CLASS, TITLE, STYLE.
    
    Specified by:
    
    lineBreakOpportunity in interface Sink
    
    Overrides:
    
    lineBreakOpportunity in class SinkAdapter
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
  - pageBreak
```
public void pageBreak()
```
    Adding a new page separator.
    
    Specified by:
    
    pageBreak in interface Sink
    
    Overrides:
    
    pageBreak in class SinkAdapter
  - nonBreakingSpace
```
public void nonBreakingSpace()
```
    Adding a non breaking space, ie a space without any special formatting operations.
    
    Specified by:
    
    nonBreakingSpace in interface Sink
    
    Overrides:
    
    nonBreakingSpace in class SinkAdapter
  - text
```
public void text(String text,
                 SinkEventAttributes attributes)
```
    Adds a text.
    The text parameter should contain only real content, ie any ignorable/collapsable whitespace/EOLs or other pretty-printing should be removed/normalized by a parser.
    
    If text contains any variants of line terminators, they should be normalized to the System EOL by an implementing Sink.
    
    Supported attributes are the base attributes plus
    
    SEMANTICS (values "emphasis", "strong", "small", "line-through", "citation", "quote", "definition", "abbreviation", "italic", "bold", "monospaced", "variable", "sample", "keyboard", "superscript", "subscript", "annotation", "highlight", "ruby", "rubyBase", "rubyText", "rubyTextContainer", "rubyParentheses", "bidirectionalIsolation", "bidirectionalOverride", "phrase", "insert", "delete").
    
    The following attributes are deprecated:
    
    VALIGN (values "sub", "sup"), DECORATION (values "underline", "overline", "line-through"), STYLE (values "italic", "bold", "monospaced").
    
    Specified by:
    
    text in interface Sink
    
    Overrides:
    
    text in class SinkAdapter
    
    Parameters:
    
    text - The text to write.
    
    attributes - A set of SinkEventAttributes, may be null.
  - rawText
```
public void rawText(String text)
```
    Adding a raw text, ie a text without any special formatting operations.
    
    Specified by:
    
    rawText in interface Sink
    
    Overrides:
    
    rawText in class SinkAdapter
    
    Parameters:
    
    text - The text to write.
  - comment
```
public void comment(String comment)
```
    Add a comment.
    
    Specified by:
    
    comment in interface Sink
    
    Overrides:
    
    comment in class SinkAdapter
    
    Parameters:
    
    comment - The comment to write.
  - unknown
```
public void unknown(String name,
                    Object[] requiredParams,
                    SinkEventAttributes attributes)
```
    Add an unknown event. This may be used by parsers to notify a general Sink about an event that doesn't fit into any event defined by the Sink API. Depending on the parameters, a Sink may decide whether or not to process the event, emit it as raw text, as a comment, log it, etc. 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()
```
    Flush the writer or the stream, if needed. Flushing a previously-flushed Sink has no effect.
    
    Specified by:
    
    flush in interface Sink
    
    Overrides:
    
    flush in class SinkAdapter
  - close
```
public void close()
```
    Close the writer or the stream, if needed. Closing a previously-closed Sink has no effect.
    
    Specified by:
    
    close in interface AutoCloseable
    
    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

Nested Class Summary

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

Constructor Detail

Xhtml5BaseSink

Method Detail

getTextBuffer

setHeadFlag

isHeadFlag

getVerbatimMode

setVerbatimMode

isVerbatim

setCellJustif

getCellJustif

setCellCount

getCellCount

init

resetTextBuffer

article

article_

navigation

navigation_

sidebar

sidebar_

section

sectionTitle

sectionTitle_

section_

onSection

onSection_

onSectionTitle

onSectionTitle_

header

header_

content

content_

footer

footer_

list

list_

listItem

listItem_

numberedList

numberedList_

numberedListItem

numberedListItem_

definitionList

definitionList_

definedTerm

definedTerm_

definition

definition_

figure

figure_

figureGraphics

figureCaption

figureCaption_

paragraph

paragraph_

data

data_

time

time_

address

address_

blockquote