XhtmlBaseSink

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.XhtmlBaseSink

All Implemented Interfaces:

HtmlMarkup, Markup, XmlMarkup
```
public class XhtmlBaseSink
extends AbstractXmlSink
implements HtmlMarkup
```
Abstract base xhtml sink implementation.

Since:

1.1

Version:

$Id: XhtmlBaseSink.java 1726411 2016-01-23 16:34:09Z hboutemy $

Author:

Jason van Zyl, ltheussl

Field Summary

Fields
Modifier and Type	Field	Description
`protected javax.swing.text.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, B, BASE, BASEFONT, BDO, BIG, BLOCKQUOTE, BODY, BR, BUTTON, CAPTION, CDATA_TYPE, CENTER, CITE, CODE, COL, COLGROUP, DD, DEL, DFN, DIR, DIV, DL, DT, EM, ENTITY_TYPE, FIELDSET, FONT, FORM, FRAME, FRAMESET, H1, H2, H3, H4, H5, H6, HEAD, HR, HTML, I, IFRAME, IMG, INPUT, INS, ISINDEX, KBD, LABEL, LEGEND, LI, LINK, MAP, MENU, META, NOFRAMES, NOSCRIPT, OBJECT, OL, OPTGROUP, OPTION, P, PARAM, PRE, Q, S, SAMP, SCRIPT, SELECT, SMALL, SPAN, STRIKE, STRONG, STYLE, SUB, SUP, TABLE, TAG_TYPE_END, TAG_TYPE_SIMPLE, TAG_TYPE_START, TBODY, TD, TEXTAREA, TFOOT, TH, THEAD, TITLE, TR, TT, U, UL, VAR

Fields inherited from interface org.apache.maven.doxia.markup.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

Fields inherited from interface org.apache.maven.doxia.markup.XmlMarkup
BANG, CDATA, DOCTYPE_START, ENTITY_START, XML_NAMESPACE

Constructor Summary

Constructors
Constructor Description

XhtmlBaseSink(java.io.Writer out)
Constructor, initialize the PrintWriter.

Constructors
Constructor	Description
`XhtmlBaseSink(java.io.Writer out)`	Constructor, initialize the PrintWriter.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`void`	`anchor(java.lang.String name)`
`void`	`anchor(java.lang.String name, org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`anchor_()`
`void`	`bold()`
`void`	`bold_()`
`void`	`close()`
`void`	`comment(java.lang.String comment)`
`protected void`	`content(java.lang.String text)`	Write HTML escaped text to output.
`void`	`definedTerm()`
`void`	`definedTerm(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`definedTerm_()`
`void`	`definition()`
`void`	`definition(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`definition_()`
`void`	`definitionList()`
`void`	`definitionList(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`definitionList_()`
`protected static java.lang.String`	`encodeURL(java.lang.String text)`	Forward to HtmlTools.encodeURL( text ).
`protected static java.lang.String`	`escapeHTML(java.lang.String text)`	Forward to HtmlTools.escapeHTML( text ).
`void`	`figure()`	Deprecated. Use `figure(SinkEventAttributes)`, this method is only kept for backward compatibility. Note that the behavior is different though, as this method writes an img tag, while correctly the img tag should be written by figureGraphics().
`void`	`figure(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`figure_()`
`void`	`figureCaption()`	Deprecated. Use `figureCaption(SinkEventAttributes)`, this method is only kept for backward compatibility. Note that the behavior is different though, as this method only writes an alt attribute.
`void`	`figureCaption(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`figureCaption_()`
`void`	`figureGraphics(java.lang.String name)`	Deprecated. Use `figureGraphics(String,SinkEventAttributes)`, this method is only kept for backward compatibility. Note that the behavior is different though, as this method does not write the img tag, only the src attribute.
`void`	`figureGraphics(java.lang.String src, org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`flush()`
`protected int`	`getCellCount()`	Getter for the field `cellCount`.
`protected int[]`	`getCellJustif()`	Getter for the field `cellJustif`.
`protected java.lang.StringBuffer`	`getTextBuffer()`	To use mainly when playing with the head events.
`void`	`horizontalRule()`
`void`	`horizontalRule(org.apache.maven.doxia.sink.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.
`protected boolean`	`isHeadFlag()`	isHeadFlag.
`protected boolean`	`isVerbatimFlag()`	isVerbatimFlag.
`void`	`italic()`
`void`	`italic_()`
`void`	`lineBreak()`
`void`	`lineBreak(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`link(java.lang.String name)`
`void`	`link(java.lang.String name, org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`link_()`
`void`	`list()`
`void`	`list(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`list_()`
`void`	`listItem()`
`void`	`listItem(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`listItem_()`
`void`	`monospaced()`
`void`	`monospaced_()`
`void`	`nonBreakingSpace()`
`void`	`numberedList(int numbering)`	The default list style depends on the numbering.
`void`	`numberedList(int numbering, org.apache.maven.doxia.sink.SinkEventAttributes attributes)`	The default list style depends on the numbering.
`void`	`numberedList_()`
`void`	`numberedListItem()`
`void`	`numberedListItem(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`numberedListItem_()`
`protected void`	`onSection(int depth, org.apache.maven.doxia.sink.SinkEventAttributes attributes)`	Starts a section.
`protected void`	`onSection_(int depth)`	Ends a section.
`protected void`	`onSectionTitle(int depth, org.apache.maven.doxia.sink.SinkEventAttributes attributes)`	Starts a section title.
`protected void`	`onSectionTitle_(int depth)`	Ends a section title.
`void`	`pageBreak()`
`void`	`paragraph()`
`void`	`paragraph(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`paragraph_()`
`void`	`rawText(java.lang.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, org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`section_(int level)`
`void`	`section1()`
`void`	`section1_()`
`void`	`section2()`
`void`	`section2_()`
`void`	`section3()`
`void`	`section3_()`
`void`	`section4()`
`void`	`section4_()`
`void`	`section5()`
`void`	`section5_()`
`void`	`sectionTitle(int level, org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`sectionTitle_(int level)`
`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`	`table()`
`void`	`table(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`table_()`
`void`	`tableCaption()`
`void`	`tableCaption(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`tableCaption_()`
`void`	`tableCell()`
`void`	`tableCell(java.lang.String width)`
`void`	`tableCell(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`tableCell_()`
`void`	`tableHeaderCell()`
`void`	`tableHeaderCell(java.lang.String width)`
`void`	`tableHeaderCell(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`tableHeaderCell_()`
`void`	`tableRow()`	The default class style is `a` or `b` depending the row id.
`void`	`tableRow(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`	The default class style is `a` or `b` depending the row id.
`void`	`tableRow_()`
`void`	`tableRows(int[] justification, boolean grid)`	The default class style is `bodyTable`.
`void`	`tableRows_()`
`void`	`text(java.lang.String text)`
`void`	`text(java.lang.String text, org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`unknown(java.lang.String name, java.lang.Object[] requiredParams, org.apache.maven.doxia.sink.SinkEventAttributes attributes)`	Add an unknown event.
`void`	`verbatim(boolean boxed)`	The default class style for boxed is `source`.
`void`	`verbatim(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`	The default class style for boxed is `source`.
`void`	`verbatim_()`
`protected void`	`verbatimContent(java.lang.String text)`	Write HTML escaped text to output.
`protected void`	`write(java.lang.String text)`	Write a text to the sink.
`protected void`	`writeEndTag(javax.swing.text.html.HTML.Tag t)`	Ends a Tag without writing an EOL.
`protected void`	`writeStartTag(javax.swing.text.html.HTML.Tag t, javax.swing.text.MutableAttributeSet att, boolean isSimpleTag)`	Starts a Tag with attributes.

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

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

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

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_

- Field Detail
  - tableAttributes
```
protected javax.swing.text.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
  - XhtmlBaseSink
```
public XhtmlBaseSink(java.io.Writer out)
```
    Constructor, initialize the PrintWriter.
    
    Parameters:
    
    out - The writer to write the result.
- Method Detail
  - getTextBuffer
```
protected java.lang.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.
  - section
```
public void section(int level,
                    org.apache.maven.doxia.sink.SinkEventAttributes attributes)
```
    Overrides:
    
    section in class SinkAdapter
  - sectionTitle
```
public void sectionTitle(int level,
                         org.apache.maven.doxia.sink.SinkEventAttributes attributes)
```
    Overrides:
    
    sectionTitle in class SinkAdapter
  - sectionTitle_
```
public void sectionTitle_(int level)
```
    Overrides:
    
    sectionTitle_ in class SinkAdapter
  - section_
```
public void section_(int level)
```
    Overrides:
    
    section_ in class SinkAdapter
  - section1
```
public void section1()
```
    Overrides:
    
    section1 in class SinkAdapter
  - sectionTitle1
```
public void sectionTitle1()
```
    Overrides:
    
    sectionTitle1 in class SinkAdapter
  - sectionTitle1_
```
public void sectionTitle1_()
```
    Overrides:
    
    sectionTitle1_ in class SinkAdapter
  - section1_
```
public void section1_()
```
    Overrides:
    
    section1_ in class SinkAdapter
  - section2
```
public void section2()
```
    Overrides:
    
    section2 in class SinkAdapter
  - sectionTitle2
```
public void sectionTitle2()
```
    Overrides:
    
    sectionTitle2 in class SinkAdapter
  - sectionTitle2_
```
public void sectionTitle2_()
```
    Overrides:
    
    sectionTitle2_ in class SinkAdapter
  - section2_
```
public void section2_()
```
    Overrides:
    
    section2_ in class SinkAdapter
  - section3
```
public void section3()
```
    Overrides:
    
    section3 in class SinkAdapter
  - sectionTitle3
```
public void sectionTitle3()
```
    Overrides:
    
    sectionTitle3 in class SinkAdapter
  - sectionTitle3_
```
public void sectionTitle3_()
```
    Overrides:
    
    sectionTitle3_ in class SinkAdapter
  - section3_
```
public void section3_()
```
    Overrides:
    
    section3_ in class SinkAdapter
  - section4
```
public void section4()
```
    Overrides:
    
    section4 in class SinkAdapter
  - sectionTitle4
```
public void sectionTitle4()
```
    Overrides:
    
    sectionTitle4 in class SinkAdapter
  - sectionTitle4_
```
public void sectionTitle4_()
```
    Overrides:
    
    sectionTitle4_ in class SinkAdapter
  - section4_
```
public void section4_()
```
    Overrides:
    
    section4_ in class SinkAdapter
  - section5
```
public void section5()
```
    Overrides:
    
    section5 in class SinkAdapter
  - sectionTitle5
```
public void sectionTitle5()
```
    Overrides:
    
    sectionTitle5 in class SinkAdapter
  - sectionTitle5_
```
public void sectionTitle5_()
```
    Overrides:
    
    sectionTitle5_ in class SinkAdapter
  - section5_
```
public void section5_()
```
    Overrides:
    
    section5_ in class SinkAdapter
  - onSection
```
protected void onSection(int depth,
                         org.apache.maven.doxia.sink.SinkEventAttributes attributes)
```
    Starts a section. The default class style is section.
    
    Parameters:
    
    depth - The level of the section.
    
    attributes - some attributes. May be null.
    
    See Also:
    
    HTML.Tag.DIV
  - 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,
                              org.apache.maven.doxia.sink.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
  - list
```
public void list()
```
    Overrides:
    
    list in class SinkAdapter
    
    See Also:
    
    HTML.Tag.UL
  - list
```
public void list(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
```
    Overrides:
    
    list in class SinkAdapter
    
    See Also:
    
    HTML.Tag.UL
  - list_
```
public void list_()
```
    Overrides:
    
    list_ in class SinkAdapter
    
    See Also:
    
    HTML.Tag.UL
  - listItem
```
public void listItem()
```
    Overrides:
    
    listItem in class SinkAdapter
    
    See Also:
    
    HTML.Tag.LI
  - listItem
```
public void listItem(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
```
    Overrides:
    
    listItem in class SinkAdapter
    
    See Also:
    
    HTML.Tag.LI
  - listItem_
```
public void listItem_()
```
    Overrides:
    
    listItem_ in class SinkAdapter
    
    See Also:
    
    HTML.Tag.LI
  - numberedList
```
public void numberedList(int numbering)
```
    The default list style depends on the numbering.
    
    Overrides:
    
    numberedList in class SinkAdapter
    
    See Also:
    
    HTML.Tag.OL
  - numberedList
```
public void numberedList(int numbering,
                         org.apache.maven.doxia.sink.SinkEventAttributes attributes)
```
    The default list style depends on the numbering.
    
    Overrides:
    
    numberedList in class SinkAdapter
    
    See Also:
    
    HTML.Tag.OL
  - numberedList_
```
public void numberedList_()
```
    Overrides:
    
    numberedList_ in class SinkAdapter
    
    See Also:
    
    HTML.Tag.OL
  - numberedListItem
```
public void numberedListItem()
```
    Overrides:
    
    numberedListItem in class SinkAdapter
    
    See Also:
    
    HTML.Tag.LI
  - numberedListItem
```
public void numberedListItem(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
```
    Overrides:
    
    numberedListItem in class SinkAdapter
    
    See Also:
    
    HTML.Tag.LI
  - numberedListItem_
```
public void numberedListItem_()
```
    Overrides:
    
    numberedListItem_ in class SinkAdapter
    
    See Also:
    
    HTML.Tag.LI
  - definitionList
```
public void definitionList()
```
    Overrides:
    
    definitionList in class SinkAdapter
    
    See Also:
    
    HTML.Tag.DL
  - definitionList
```
public void definitionList(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
```
    Overrides:
    
    definitionList in class SinkAdapter
    
    See Also:
    
    HTML.Tag.DL
  - definitionList_
```
public void definitionList_()
```
    Overrides:
    
    definitionList_ in class SinkAdapter
    
    See Also:
    
    HTML.Tag.DL
  - definedTerm
```
public void definedTerm(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
```
    Overrides:
    
    definedTerm in class SinkAdapter
    
    See Also:
    
    HTML.Tag.DT
  - definedTerm
```
public void definedTerm()
```
    Overrides:
    
    definedTerm in class SinkAdapter
    
    See Also:
    
    HTML.Tag.DT
  - definedTerm_
```
public void definedTerm_()
```
    Overrides:
    
    definedTerm_ in class SinkAdapter
    
    See Also:
    
    HTML.Tag.DT
  - definition
```
public void definition()
```
    Overrides:
    
    definition in class SinkAdapter
    
    See Also:
    
    HTML.Tag.DD
  - definition
```
public void definition(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
```
    Overrides:
    
    definition in class SinkAdapter
    
    See Also:
    
    HTML.Tag.DD
  - definition_
```
public void definition_()
```
    Overrides:
    
    definition_ in class SinkAdapter
    
    See Also:
    
    HTML.Tag.DD
  - figure
```
public void figure()
```
    Deprecated. Use figure(SinkEventAttributes), this method is only kept for backward compatibility. Note that the behavior is different though, as this method writes an img tag, while correctly the img tag should be written by figureGraphics().
    
    Overrides:
    
    figure in class SinkAdapter
    
    See Also:
    
    HTML.Tag.IMG
  - figure
```
public void figure(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
```
    Overrides:
    
    figure in class SinkAdapter
    
    See Also:
    
    HTML.Tag.IMG
  - figure_
```
public void figure_()
```
    Overrides:
    
    figure_ in class SinkAdapter
  - figureGraphics
```
public void figureGraphics(java.lang.String name)
```
    Deprecated. Use figureGraphics(String,SinkEventAttributes), this method is only kept for backward compatibility. Note that the behavior is different though, as this method does not write the img tag, only the src attribute.
    
    Overrides:
    
    figureGraphics in class SinkAdapter
  - figureGraphics
```
public void figureGraphics(java.lang.String src,
                           org.apache.maven.doxia.sink.SinkEventAttributes attributes)
```
    Overrides:
    
    figureGraphics in class SinkAdapter
  - figureCaption
```
public void figureCaption()
```
    Deprecated. Use figureCaption(SinkEventAttributes), this method is only kept for backward compatibility. Note that the behavior is different though, as this method only writes an alt attribute.
    
    Overrides:
    
    figureCaption in class SinkAdapter
  - figureCaption
```
public void figureCaption(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
```
    Overrides:
    
    figureCaption in class SinkAdapter
  - figureCaption_
```
public void figureCaption_()
```
    Overrides:
    
    figureCaption_ in class SinkAdapter
  - paragraph
```
public void paragraph()
```
    Overrides:
    
    paragraph in class SinkAdapter
    
    See Also:
    
    HTML.Tag.P
  - paragraph
```
public void paragraph(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
```
    Overrides:
    
    paragraph in class SinkAdapter
    
    See Also:
    
    HTML.Tag.P
  - paragraph_
```
public void paragraph_()
```
    Overrides:
    
    paragraph_ in class SinkAdapter
    
    See Also:
    
    HTML.Tag.P
  - verbatim
```
public void verbatim(boolean boxed)
```
    The default class style for boxed is source.
    
    Overrides:
    
    verbatim in class SinkAdapter
    
    See Also:
    
    HTML.Tag.DIV, HTML.Tag.PRE
  - verbatim
```
public void verbatim(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
```
    The default class style for boxed is source.
    
    Overrides:
    
    verbatim in class SinkAdapter
    
    See Also:
    
    HTML.Tag.DIV, HTML.Tag.PRE
  - verbatim_
```
public void verbatim_()
```
    Overrides:
    
    verbatim_ in class SinkAdapter
    
    See Also:
    
    HTML.Tag.DIV, HTML.Tag.PRE
  - horizontalRule
```
public void horizontalRule()
```
    Overrides:
    
    horizontalRule in class SinkAdapter
    
    See Also:
    
    HTML.Tag.HR
  - horizontalRule
```
public void horizontalRule(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
```
    Overrides:
    
    horizontalRule in class SinkAdapter
    
    See Also:
    
    HTML.Tag.HR
  - table
```
public void table()
```
    Overrides:
    
    table in class SinkAdapter
  - table
```
public void table(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
```
    Overrides:
    
    table in class SinkAdapter
  - table_
```
public void table_()
```
    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.
    
    Overrides:
    
    tableRows in class SinkAdapter
    
    See Also:
    
    HTML.Tag.TABLE
  - tableRows_
```
public void tableRows_()
```
    Overrides:
    
    tableRows_ in class SinkAdapter
  - tableRow
```
public void tableRow()
```
    The default class style is a or b depending the row id.
    
    Overrides:
    
    tableRow in class SinkAdapter
    
    See Also:
    
    HTML.Tag.TR
  - tableRow
```
public void tableRow(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
```
    The default class style is a or b depending the row id.
    
    Overrides:
    
    tableRow in class SinkAdapter
    
    See Also:
    
    HTML.Tag.TR
  - tableRow_
```
public void tableRow_()
```
    Overrides:
    
    tableRow_ in class SinkAdapter
    
    See Also:
    
    HTML.Tag.TR
  - tableCell
```
public void tableCell()
```
    Overrides:
    
    tableCell in class SinkAdapter
  - tableHeaderCell
```
public void tableHeaderCell()
```
    Overrides:
    
    tableHeaderCell in class SinkAdapter
  - tableCell
```
public void tableCell(java.lang.String width)
```
    Overrides:
    
    tableCell in class SinkAdapter
  - tableHeaderCell
```
public void tableHeaderCell(java.lang.String width)
```
    Overrides:
    
    tableHeaderCell in class SinkAdapter
  - tableCell
```
public void tableCell(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
```
    Overrides:
    
    tableCell in class SinkAdapter
  - tableHeaderCell
```
public void tableHeaderCell(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
```
    Overrides:
    
    tableHeaderCell in class SinkAdapter
  - tableCell_
```
public void tableCell_()
```
    Overrides:
    
    tableCell_ in class SinkAdapter
  - tableHeaderCell_
```
public void tableHeaderCell_()
```
    Overrides:
    
    tableHeaderCell_ in class SinkAdapter
  - tableCaption
```
public void tableCaption()
```
    Overrides:
    
    tableCaption in class SinkAdapter
    
    See Also:
    
    HTML.Tag.CAPTION
  - tableCaption
```
public void tableCaption(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
```
    Overrides:
    
    tableCaption in class SinkAdapter
    
    See Also:
    
    HTML.Tag.CAPTION
  - tableCaption_
```
public void tableCaption_()
```
    Overrides:
    
    tableCaption_ in class SinkAdapter
    
    See Also:
    
    HTML.Tag.CAPTION
  - anchor
```
public void anchor(java.lang.String name)
```
    Overrides:
    
    anchor in class SinkAdapter
    
    See Also:
    
    HTML.Tag.A
  - anchor
```
public void anchor(java.lang.String name,
                   org.apache.maven.doxia.sink.SinkEventAttributes attributes)
```
    Overrides:
    
    anchor in class SinkAdapter
    
    See Also:
    
    HTML.Tag.A
  - anchor_
```
public void anchor_()
```
    Overrides:
    
    anchor_ in class SinkAdapter
    
    See Also:
    
    HTML.Tag.A
  - link
```
public void link(java.lang.String name)
```
    Overrides:
    
    link in class SinkAdapter
  - link
```
public void link(java.lang.String name,
                 org.apache.maven.doxia.sink.SinkEventAttributes attributes)
```
    Overrides:
    
    link in class SinkAdapter
  - link_
```
public void link_()
```
    Overrides:
    
    link_ in class SinkAdapter
    
    See Also:
    
    HTML.Tag.A
  - italic
```
public void italic()
```
    Overrides:
    
    italic in class SinkAdapter
    
    See Also:
    
    HTML.Tag.I
  - italic_
```
public void italic_()
```
    Overrides:
    
    italic_ in class SinkAdapter
    
    See Also:
    
    HTML.Tag.I
  - bold
```
public void bold()
```
    Overrides:
    
    bold in class SinkAdapter
    
    See Also:
    
    HTML.Tag.B
  - bold_
```
public void bold_()
```
    Overrides:
    
    bold_ in class SinkAdapter
    
    See Also:
    
    HTML.Tag.B
  - monospaced
```
public void monospaced()
```
    Overrides:
    
    monospaced in class SinkAdapter
    
    See Also:
    
    HTML.Tag.TT
  - monospaced_
```
public void monospaced_()
```
    Overrides:
    
    monospaced_ in class SinkAdapter
    
    See Also:
    
    HTML.Tag.TT
  - lineBreak
```
public void lineBreak()
```
    Overrides:
    
    lineBreak in class SinkAdapter
    
    See Also:
    
    HTML.Tag.BR
  - lineBreak
```
public void lineBreak(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
```
    Overrides:
    
    lineBreak in class SinkAdapter
    
    See Also:
    
    HTML.Tag.BR
  - pageBreak
```
public void pageBreak()
```
    Overrides:
    
    pageBreak in class SinkAdapter
  - nonBreakingSpace
```
public void nonBreakingSpace()
```
    Overrides:
    
    nonBreakingSpace in class SinkAdapter
  - text
```
public void text(java.lang.String text)
```
    Overrides:
    
    text in class SinkAdapter
  - text
```
public void text(java.lang.String text,
                 org.apache.maven.doxia.sink.SinkEventAttributes attributes)
```
    Overrides:
    
    text in class SinkAdapter
  - rawText
```
public void rawText(java.lang.String text)
```
    Overrides:
    
    rawText in class SinkAdapter
  - comment
```
public void comment(java.lang.String comment)
```
    Overrides:
    
    comment in class SinkAdapter
  - unknown
```
public void unknown(java.lang.String name,
                    java.lang.Object[] requiredParams,
                    org.apache.maven.doxia.sink.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 );
 
```
    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()
```
    Overrides:
    
    flush in class SinkAdapter
  - close
```
public void close()
```
    Overrides:
    
    close in class SinkAdapter
  - content
```
protected void content(java.lang.String text)
```
    Write HTML escaped text to output.
    
    Parameters:
    
    text - The text to write.
  - verbatimContent
```
protected void verbatimContent(java.lang.String text)
```
    Write HTML escaped text to output.
    
    Parameters:
    
    text - The text to write.
  - escapeHTML
```
protected static java.lang.String escapeHTML(java.lang.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 java.lang.String encodeURL(java.lang.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(java.lang.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(javax.swing.text.html.HTML.Tag t,
                             javax.swing.text.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(javax.swing.text.html.HTML.Tag t)
```
    Ends a Tag without writing an EOL. For instance:
```
</tag>
```
    .
    Overrides:
    
    writeEndTag in class AbstractXmlSink
    
    Parameters:
    
    t - a tag.

Class XhtmlBaseSink

Field Summary

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

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

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

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

Field Detail

tableAttributes

tableRows

Constructor Detail

XhtmlBaseSink

Method Detail

getTextBuffer

setHeadFlag

isHeadFlag

setVerbatimFlag

isVerbatimFlag

setCellJustif

getCellJustif

setCellCount

getCellCount

resetState

init

resetTextBuffer

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_

list

list

list_

listItem

listItem

listItem_

numberedList

numberedList

numberedList_

numberedListItem

numberedListItem

numberedListItem_

definitionList

definitionList

definitionList_

definedTerm

definedTerm

definedTerm_

definition

definition

definition_

figure