Package org.apache.maven.doxia.sink.impl
Class Xhtml5BaseSink
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,org.apache.maven.doxia.sink.Sink
Abstract base xhtml5 sink implementation.
-
Nested Class Summary
Nested Classes -
Field Summary
FieldsModifier and TypeFieldDescriptionKeep track of the main and div tags for content events.Keep track of the closing tags for inline events.protected MutableAttributeSetused 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, WBRFields 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, STARFields 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_6Fields inherited from interface org.apache.maven.doxia.markup.XmlMarkup
BANG, CDATA, DOCTYPE_START, ENTITY_START, XML_NAMESPACE -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddress(org.apache.maven.doxia.sink.SinkEventAttributes attributes) voidaddress_()voidvoidanchor_()voidarticle(org.apache.maven.doxia.sink.SinkEventAttributes attributes) voidarticle_()voidblockquote(org.apache.maven.doxia.sink.SinkEventAttributes attributes) voidvoidbold()voidbold_()voidclose()voidprotected voidWrite HTML escaped text to output.voidcontent(org.apache.maven.doxia.sink.SinkEventAttributes attributes) voidcontent_()voidvoiddata_()voiddefinedTerm(org.apache.maven.doxia.sink.SinkEventAttributes attributes) voidvoiddefinition(org.apache.maven.doxia.sink.SinkEventAttributes attributes) voidvoiddefinitionList(org.apache.maven.doxia.sink.SinkEventAttributes attributes) voidvoiddivision(org.apache.maven.doxia.sink.SinkEventAttributes attributes) voidprotected static StringForward to HtmlTools.encodeURL(text).protected static StringescapeHTML(String text) Forward to HtmlTools.escapeHTML(text).voidfigure(org.apache.maven.doxia.sink.SinkEventAttributes attributes) voidfigure_()voidfigureCaption(org.apache.maven.doxia.sink.SinkEventAttributes attributes) voidvoidfigureGraphics(String src, org.apache.maven.doxia.sink.SinkEventAttributes attributes) voidflush()voidfooter(org.apache.maven.doxia.sink.SinkEventAttributes attributes) voidfooter_()protected intGetter for the fieldcellCount.protected int[]Getter for the fieldcellJustif.protected StringBufferTo use mainly when playing with the head events.protected Xhtml5BaseSink.VerbatimModevoidheader(org.apache.maven.doxia.sink.SinkEventAttributes attributes) voidheader_()voidhorizontalRule(org.apache.maven.doxia.sink.SinkEventAttributes attributes) protected voidinit()This is called inAbstractSink.head()or inSink.close(), and can be used to set the sink into a clear state so it can be re-used.voidinline(org.apache.maven.doxia.sink.SinkEventAttributes attributes) voidinline_()protected booleanisHeadFlag.protected booleanvoiditalic()voiditalic_()voidlineBreak(org.apache.maven.doxia.sink.SinkEventAttributes attributes) voidlineBreakOpportunity(org.apache.maven.doxia.sink.SinkEventAttributes attributes) voidThe default style class for external link isexternalLink.voidlink_()voidlist(org.apache.maven.doxia.sink.SinkEventAttributes attributes) voidlist_()voidlistItem(org.apache.maven.doxia.sink.SinkEventAttributes attributes) voidvoidvoidvoidnavigation(org.apache.maven.doxia.sink.SinkEventAttributes attributes) voidvoidvoidnumberedList(int numbering, org.apache.maven.doxia.sink.SinkEventAttributes attributes) The default list style depends on the numbering.voidvoidnumberedListItem(org.apache.maven.doxia.sink.SinkEventAttributes attributes) voidprotected voidonSection(int depth, org.apache.maven.doxia.sink.SinkEventAttributes attributes) Starts a section.protected voidonSection_(int depth) Ends a section.protected voidonSectionTitle(int depth, org.apache.maven.doxia.sink.SinkEventAttributes attributes) Starts a section title.protected voidonSectionTitle_(int depth) Ends a section title.voidvoidparagraph(org.apache.maven.doxia.sink.SinkEventAttributes attributes) voidvoidprotected voidReset the text buffer.voidsection(int level, org.apache.maven.doxia.sink.SinkEventAttributes attributes) voidsection_(int level) voidsectionTitle(int level, org.apache.maven.doxia.sink.SinkEventAttributes attributes) voidsectionTitle_(int level) protected voidsetCellCount(int count) Setter for the fieldcellCount.protected voidsetCellJustif(int[] justif) Setter for the fieldcellJustif.protected voidsetHeadFlag(boolean headFlag) Setter for the fieldheadFlag.protected voidSetter for the fieldverbatimMode.voidsidebar(org.apache.maven.doxia.sink.SinkEventAttributes attributes) voidsidebar_()voidtable(org.apache.maven.doxia.sink.SinkEventAttributes attributes) voidtable_()voidtableCaption(org.apache.maven.doxia.sink.SinkEventAttributes attributes) voidvoidtableCell(org.apache.maven.doxia.sink.SinkEventAttributes attributes) voidvoidtableHeaderCell(org.apache.maven.doxia.sink.SinkEventAttributes attributes) voidvoidtableRow(org.apache.maven.doxia.sink.SinkEventAttributes attributes) Rows are striped with two colors by adding the classaorb.voidvoidtableRows(int[] justification, boolean grid) The default style class isbodyTable.voidvoidvoidvoidtime_()voidunknown(String name, Object[] requiredParams, org.apache.maven.doxia.sink.SinkEventAttributes attributes) Add an unknown event.voidverbatim(org.apache.maven.doxia.sink.SinkEventAttributes attributes) Depending on whether the decoration attribute is "source" or not, this leads to either emitting<pre><code>or just<pre>.voidprotected voidverbatimContent(String text) Write HTML escaped text to output.protected voidWrite a text to the sink.protected voidEnds a Tag without writing an EOL.protected voidwriteStartTag(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, writeStartTagMethods 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
-
Field Details
-
contentStack
Keep track of the main and div tags for content events. -
inlineStack
Keep track of the closing tags for inline events. -
tableAttributes
used to store attributes passed to table().
-
-
Constructor Details
-
Xhtml5BaseSink
Constructor, initialize the PrintWriter.- Parameters:
out- The writer to write the result.
-
-
Method Details
-
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
- Returns:
- the current verbatim mode.
-
setVerbatimMode
Setter for the field
verbatimMode.- Parameters:
mode- a verbatim mode.
-
isVerbatim
protected boolean isVerbatim()- Returns:
trueif inside verbatim section,falseotherwise
-
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 inAbstractSink.head()or inSink.close(), and can be used to set the sink into a clear state so it can be re-used.- Overrides:
initin classAbstractSink
-
resetTextBuffer
protected void resetTextBuffer()Reset the text buffer. -
article
public void article(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
articlein interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
articlein classSinkAdapter
-
article_
public void article_()- Specified by:
article_in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
article_in classSinkAdapter
-
sidebar
public void sidebar(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
sidebarin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
sidebarin classSinkAdapter
-
sidebar_
public void sidebar_()- Specified by:
sidebar_in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
sidebar_in classSinkAdapter
-
section
public void section(int level, org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
sectionin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
sectionin classSinkAdapter
-
sectionTitle
public void sectionTitle(int level, org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
sectionTitlein interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
sectionTitlein classSinkAdapter
-
sectionTitle_
public void sectionTitle_(int level) - Specified by:
sectionTitle_in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
sectionTitle_in classSinkAdapter
-
section_
public void section_(int level) - Specified by:
section_in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
section_in classSinkAdapter
-
onSection
protected void onSection(int depth, org.apache.maven.doxia.sink.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:
-
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:
-
onSectionTitle_
protected void onSectionTitle_(int depth) Ends a section title.- Parameters:
depth- The level of the section title.- See Also:
-
header
public void header(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
headerin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
headerin classSinkAdapter
-
header_
public void header_()- Specified by:
header_in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
header_in classSinkAdapter
-
content
public void content(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
contentin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
contentin classSinkAdapter
-
content_
public void content_()- Specified by:
content_in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
content_in classSinkAdapter
-
list
public void list(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
listin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
listin classSinkAdapter- See Also:
-
list_
public void list_()- Specified by:
list_in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
list_in classSinkAdapter- See Also:
-
listItem
public void listItem(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
listItemin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
listItemin classSinkAdapter- See Also:
-
listItem_
public void listItem_()- Specified by:
listItem_in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
listItem_in classSinkAdapter- See Also:
-
numberedList
public void numberedList(int numbering, org.apache.maven.doxia.sink.SinkEventAttributes attributes) The default list style depends on the numbering.- Specified by:
numberedListin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
numberedListin classSinkAdapter- See Also:
-
numberedList_
public void numberedList_()- Specified by:
numberedList_in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
numberedList_in classSinkAdapter- See Also:
-
numberedListItem
public void numberedListItem(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
numberedListItemin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
numberedListItemin classSinkAdapter- See Also:
-
numberedListItem_
public void numberedListItem_()- Specified by:
numberedListItem_in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
numberedListItem_in classSinkAdapter- See Also:
-
definitionList
public void definitionList(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
definitionListin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
definitionListin classSinkAdapter- See Also:
-
definitionList_
public void definitionList_()- Specified by:
definitionList_in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
definitionList_in classSinkAdapter- See Also:
-
definedTerm
public void definedTerm(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
definedTermin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
definedTermin classSinkAdapter- See Also:
-
definedTerm_
public void definedTerm_()- Specified by:
definedTerm_in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
definedTerm_in classSinkAdapter- See Also:
-
definition
public void definition(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
definitionin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
definitionin classSinkAdapter- See Also:
-
definition_
public void definition_()- Specified by:
definition_in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
definition_in classSinkAdapter- See Also:
-
figure
public void figure(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
figurein interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
figurein classSinkAdapter
-
figure_
public void figure_()- Specified by:
figure_in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
figure_in classSinkAdapter
-
figureGraphics
- Specified by:
figureGraphicsin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
figureGraphicsin classSinkAdapter
-
figureCaption
public void figureCaption(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
figureCaptionin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
figureCaptionin classSinkAdapter
-
figureCaption_
public void figureCaption_()- Specified by:
figureCaption_in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
figureCaption_in classSinkAdapter
-
paragraph
public void paragraph(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
paragraphin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
paragraphin classSinkAdapter- See Also:
-
paragraph_
public void paragraph_()- Specified by:
paragraph_in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
paragraph_in classSinkAdapter- See Also:
-
data
- Specified by:
datain interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
datain classSinkAdapter
-
data_
public void data_()- Specified by:
data_in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
data_in classSinkAdapter
-
time
- Specified by:
timein interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
timein classSinkAdapter
-
time_
public void time_()- Specified by:
time_in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
time_in classSinkAdapter
-
address
public void address(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
addressin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
addressin classSinkAdapter- See Also:
-
address_
public void address_()- Specified by:
address_in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
address_in classSinkAdapter- See Also:
-
blockquote
public void blockquote(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
blockquotein interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
blockquotein classSinkAdapter- See Also:
-
blockquote_
public void blockquote_()- Specified by:
blockquote_in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
blockquote_in classSinkAdapter- See Also:
-
division
public void division(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
divisionin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
divisionin classSinkAdapter- See Also:
-
division_
public void division_()- Specified by:
division_in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
division_in classSinkAdapter- See Also:
-
verbatim
public void verbatim(org.apache.maven.doxia.sink.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 thepreelement only.- Specified by:
verbatimin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
verbatimin classSinkAdapter- See Also:
-
verbatim_
public void verbatim_()- Specified by:
verbatim_in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
verbatim_in classSinkAdapter- See Also:
-
horizontalRule
public void horizontalRule(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
horizontalRulein interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
horizontalRulein classSinkAdapter- See Also:
-
table
public void table(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
tablein interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
tablein classSinkAdapter
-
table_
public void table_()- Specified by:
table_in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
table_in classSinkAdapter- See Also:
-
tableRows
public void tableRows(int[] justification, boolean grid) The default style class isbodyTable.- Specified by:
tableRowsin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
tableRowsin classSinkAdapter- Parameters:
grid- iftruethe style classbodyTableBorderwill be added- See Also:
-
tableRows_
public void tableRows_()- Specified by:
tableRows_in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
tableRows_in classSinkAdapter
-
tableRow
public void tableRow(org.apache.maven.doxia.sink.SinkEventAttributes attributes) Rows are striped with two colors by adding the classaorb. If the provided attributes specify thehiddenclass, the next call to tableRow will set the same striping class as this one. A style forhiddenortable.bodyTable hiddenmay need to be provided to actually hide such a row.- Specified by:
tableRowin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
tableRowin classSinkAdapter- See Also:
-
tableRow_
public void tableRow_()- Specified by:
tableRow_in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
tableRow_in classSinkAdapter- See Also:
-
tableCell
public void tableCell(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
tableCellin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
tableCellin classSinkAdapter
-
tableHeaderCell
public void tableHeaderCell(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
tableHeaderCellin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
tableHeaderCellin classSinkAdapter
-
tableCell_
public void tableCell_()- Specified by:
tableCell_in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
tableCell_in classSinkAdapter
-
tableHeaderCell_
public void tableHeaderCell_()- Specified by:
tableHeaderCell_in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
tableHeaderCell_in classSinkAdapter
-
tableCaption
public void tableCaption(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
tableCaptionin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
tableCaptionin classSinkAdapter- See Also:
-
tableCaption_
public void tableCaption_()- Specified by:
tableCaption_in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
tableCaption_in classSinkAdapter- See Also:
-
anchor
- Specified by:
anchorin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
anchorin classSinkAdapter- See Also:
-
anchor_
public void anchor_()- Specified by:
anchor_in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
anchor_in classSinkAdapter- See Also:
-
link
The default style class for external link isexternalLink.- Specified by:
linkin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
linkin classSinkAdapter- See Also:
-
link_
public void link_()- Specified by:
link_in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
link_in classSinkAdapter- See Also:
-
inline
public void inline(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
inlinein interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
inlinein classSinkAdapter
-
inline_
public void inline_()- Specified by:
inline_in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
inline_in classSinkAdapter
-
italic
public void italic()- Specified by:
italicin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
italicin classSinkAdapter- See Also:
-
italic_
public void italic_()- Specified by:
italic_in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
italic_in classSinkAdapter- See Also:
-
bold
public void bold()- Specified by:
boldin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
boldin classSinkAdapter- See Also:
-
bold_
public void bold_()- Specified by:
bold_in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
bold_in classSinkAdapter- See Also:
-
monospaced
public void monospaced()- Specified by:
monospacedin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
monospacedin classSinkAdapter- See Also:
-
monospaced_
public void monospaced_()- Specified by:
monospaced_in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
monospaced_in classSinkAdapter- See Also:
-
lineBreak
public void lineBreak(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
lineBreakin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
lineBreakin classSinkAdapter- See Also:
-
lineBreakOpportunity
public void lineBreakOpportunity(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
lineBreakOpportunityin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
lineBreakOpportunityin classSinkAdapter
-
pageBreak
public void pageBreak()- Specified by:
pageBreakin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
pageBreakin classSinkAdapter
-
nonBreakingSpace
public void nonBreakingSpace()- Specified by:
nonBreakingSpacein interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
nonBreakingSpacein classSinkAdapter
-
text
- Specified by:
textin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
textin classSinkAdapter
-
rawText
- Specified by:
rawTextin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
rawTextin classSinkAdapter
-
comment
- Specified by:
commentin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
commentin classSinkAdapter
-
unknown
public void unknown(String name, 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);- Specified by:
unknownin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
unknownin classSinkAdapter- Parameters:
name- the name of the event. If this is not a valid xhtml tag name as defined inHtmlMarkupthen 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 ofTAG_TYPE_START,TAG_TYPE_END,TAG_TYPE_SIMPLE,ENTITY_TYPE, orCDATA_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:
flushin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
flushin classSinkAdapter
-
close
public void close()- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
closein classSinkAdapter
-
content
Write HTML escaped text to output.- Parameters:
text- The text to write.
-
verbatimContent
Write HTML escaped text to output.- Parameters:
text- The text to write.
-
escapeHTML
Forward to HtmlTools.escapeHTML(text).- Parameters:
text- the String to escape, may be null- Returns:
- the text escaped, "" if null String input
- See Also:
-
encodeURL
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:
-
write
Write a text to the sink.- Specified by:
writein classAbstractXmlSink- Parameters:
text- the given text to write
-
writeStartTag
Starts a Tag with attributes. For instance:<tag attName="attValue">
- Overrides:
writeStartTagin classAbstractXmlSink- Parameters:
t- a non null tag.att- a set of attributes. May be null.isSimpleTag- boolean to write as a simple tag.
-
writeEndTag
Ends a Tag without writing an EOL. For instance:</tag>
.- Overrides:
writeEndTagin classAbstractXmlSink- Parameters:
t- a tag.
-