Package org.apache.maven.doxia.sink.impl
Class 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:
org.apache.maven.doxia.logging.LogEnabled
,HtmlMarkup
,Markup
,XmlMarkup
,org.apache.maven.doxia.sink.Sink
Abstract base xhtml sink implementation.
- Since:
- 1.1
- Author:
- Jason van Zyl, ltheussl
-
Field Summary
FieldsModifier and TypeFieldDescriptionKeep track of the closing tags for inline events.protected MutableAttributeSet
used to store attributes passed to table().protected boolean
Flag to know iftableRows(int[], boolean)
is called or not.Fields inherited from interface org.apache.maven.doxia.markup.HtmlMarkup
A, ABBR, ACRONYM, ADDRESS, APPLET, AREA, ARTICLE, ASIDE, AUDIO, B, BASE, BASEFONT, BDI, BDO, BIG, BLOCKQUOTE, BODY, BR, BUTTON, CANVAS, CAPTION, CDATA_TYPE, CENTER, CITE, CODE, COL, COLGROUP, COMMAND, DATA, DATALIST, DD, DEL, DETAILS, DFN, DIALOG, DIR, DIV, DL, DT, EM, EMBED, ENTITY_TYPE, FIELDSET, FIGCAPTION, FIGURE, FONT, FOOTER, FORM, FRAME, FRAMESET, H1, H2, H3, H4, H5, H6, HEAD, HEADER, HGROUP, HR, HTML, I, IFRAME, IMG, INPUT, INS, ISINDEX, KBD, KEYGEN, LABEL, LEGEND, LI, LINK, MAIN, MAP, MARK, MENU, META, METER, NAV, NOFRAMES, NOSCRIPT, OBJECT, OL, OPTGROUP, OPTION, OUTPUT, P, PARAM, PICTURE, PRE, PROGRESS, Q, RB, RP, RT, RTC, RUBY, S, SAMP, SCRIPT, SECTION, SELECT, SMALL, SOURCE, SPAN, STRIKE, STRONG, STYLE, SUB, SUMMARY, SUP, TABLE, TAG_TYPE_END, TAG_TYPE_SIMPLE, TAG_TYPE_START, TBODY, TD, TEMPLATE, TEXTAREA, TFOOT, TH, THEAD, TIME, TITLE, TR, TRACK, TT, U, UL, VAR, VIDEO, WBR
Fields inherited from interface org.apache.maven.doxia.markup.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 -
Method Summary
Modifier and TypeMethodDescriptionvoid
address()
void
address
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
address_()
void
void
void
anchor_()
void
void
blockquote
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
void
bold()
void
bold_()
void
close()
void
protected void
Write HTML escaped text to output.void
void
definedTerm
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
void
void
definition
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
void
void
definitionList
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
void
division()
void
division
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
protected static String
Forward to HtmlTools.encodeURL( text ).protected static String
escapeHTML
(String text) Forward to HtmlTools.escapeHTML( text ).void
figure()
Deprecated.void
figure
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
figure_()
void
Deprecated.UsefigureCaption(SinkEventAttributes)
, this method is only kept for backward compatibility.void
figureCaption
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
void
figureGraphics
(String name) Deprecated.UsefigureGraphics(String,SinkEventAttributes)
, this method is only kept for backward compatibility.void
figureGraphics
(String src, org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
flush()
protected int
Getter for the fieldcellCount
.protected int[]
Getter for the fieldcellJustif
.protected StringBuffer
To use mainly when playing with the head events.void
void
horizontalRule
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) protected void
init()
This is called inSink.head()
or inSink.close()
, and can be used to set the sink into a clear state so it can be re-used.void
inline()
void
inline
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
inline_()
protected boolean
isHeadFlag.protected boolean
isVerbatimFlag.void
italic()
void
italic_()
void
void
lineBreak
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
void
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
void
void
void
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
void
void
numberedListItem
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
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
void
void
paragraph
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
void
protected void
Deprecated.since 1.1.2, useinit()
instead of.protected void
Reset the text buffer.void
section
(int level, org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
section_
(int level) void
section1()
void
void
section2()
void
void
section3()
void
void
section4()
void
void
section5()
void
void
sectionTitle
(int level, org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
sectionTitle_
(int level) void
void
void
void
void
void
void
void
void
void
protected void
setCellCount
(int count) Setter for the fieldcellCount
.protected void
setCellJustif
(int[] justif) Setter for the fieldcellJustif
.protected void
setHeadFlag
(boolean headFlag) Setter for the fieldheadFlag
.protected void
setVerbatimFlag
(boolean verb) Setter for the fieldverbatimFlag
.void
table()
void
table
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
table_()
void
void
tableCaption
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
void
void
void
tableCell
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
void
void
tableHeaderCell
(String width) void
tableHeaderCell
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
void
tableRow()
The default class style isa
orb
depending the row id.void
tableRow
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) The default class style isa
orb
depending the row id.void
void
tableRows
(int[] justification, boolean grid) The default class style isbodyTable
.void
void
void
void
unknown
(String name, Object[] requiredParams, org.apache.maven.doxia.sink.SinkEventAttributes attributes) Add an unknown event.void
verbatim
(boolean boxed) The default class style for boxed issource
.void
verbatim
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) The default class style for boxed issource
.void
protected void
verbatimContent
(String text) Write HTML escaped text to output.protected void
Write a text to the sink.protected void
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
article, article, article_, author, author, author_, body, body, body_, content, content, content_, data, data, data_, date, date, date_, definitionListItem, definitionListItem, definitionListItem_, footer, footer, footer_, head, head, head_, header, header, header_, lineBreakOpportunity, lineBreakOpportunity, navigation, navigation, navigation_, section6, section6_, sectionTitle, sectionTitle_, sectionTitle6, sectionTitle6_, sidebar, sidebar, sidebar_, time, time, time_, title, title, title_
Methods inherited from class org.apache.maven.doxia.sink.impl.AbstractSink
enableLogging, getLog, unifyEOLs
-
Field Details
-
tableAttributes
used to store attributes passed to table(). -
tableRows
protected boolean tableRowsFlag to know iftableRows(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 ofsink.table(); sink.tableRows( justify, true ); sink.tableRow();
-
inlineStack
Keep track of the closing tags for inline events.
-
-
Constructor Details
-
XhtmlBaseSink
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.
-
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, useinit()
instead of.Reset all variables. -
init
protected void init()This is called inSink.head()
or inSink.close()
, and can be used to set the sink into a clear state so it can be re-used.- Overrides:
init
in classAbstractSink
-
resetTextBuffer
protected void resetTextBuffer()Reset the text buffer. -
section
public void section(int level, org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
section
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
section
in classSinkAdapter
-
sectionTitle
public void sectionTitle(int level, org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
sectionTitle
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
sectionTitle
in 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
-
section1
public void section1()- Specified by:
section1
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
section1
in classSinkAdapter
-
sectionTitle1
public void sectionTitle1()- Specified by:
sectionTitle1
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
sectionTitle1
in classSinkAdapter
-
sectionTitle1_
public void sectionTitle1_()- Specified by:
sectionTitle1_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
sectionTitle1_
in classSinkAdapter
-
section1_
public void section1_()- Specified by:
section1_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
section1_
in classSinkAdapter
-
section2
public void section2()- Specified by:
section2
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
section2
in classSinkAdapter
-
sectionTitle2
public void sectionTitle2()- Specified by:
sectionTitle2
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
sectionTitle2
in classSinkAdapter
-
sectionTitle2_
public void sectionTitle2_()- Specified by:
sectionTitle2_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
sectionTitle2_
in classSinkAdapter
-
section2_
public void section2_()- Specified by:
section2_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
section2_
in classSinkAdapter
-
section3
public void section3()- Specified by:
section3
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
section3
in classSinkAdapter
-
sectionTitle3
public void sectionTitle3()- Specified by:
sectionTitle3
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
sectionTitle3
in classSinkAdapter
-
sectionTitle3_
public void sectionTitle3_()- Specified by:
sectionTitle3_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
sectionTitle3_
in classSinkAdapter
-
section3_
public void section3_()- Specified by:
section3_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
section3_
in classSinkAdapter
-
section4
public void section4()- Specified by:
section4
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
section4
in classSinkAdapter
-
sectionTitle4
public void sectionTitle4()- Specified by:
sectionTitle4
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
sectionTitle4
in classSinkAdapter
-
sectionTitle4_
public void sectionTitle4_()- Specified by:
sectionTitle4_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
sectionTitle4_
in classSinkAdapter
-
section4_
public void section4_()- Specified by:
section4_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
section4_
in classSinkAdapter
-
section5
public void section5()- Specified by:
section5
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
section5
in classSinkAdapter
-
sectionTitle5
public void sectionTitle5()- Specified by:
sectionTitle5
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
sectionTitle5
in classSinkAdapter
-
sectionTitle5_
public void sectionTitle5_()- Specified by:
sectionTitle5_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
sectionTitle5_
in classSinkAdapter
-
section5_
public void section5_()- Specified by:
section5_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
section5_
in classSinkAdapter
-
onSection
protected void onSection(int depth, org.apache.maven.doxia.sink.SinkEventAttributes attributes) Starts a section. The default class style issection
.- Parameters:
depth
- The level of the section.attributes
- some attributes. May be null.- See Also:
-
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:
-
list
public void list()- Specified by:
list
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
list
in classSinkAdapter
- See Also:
-
list
public void list(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
list
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
list
in 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()- Specified by:
listItem
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
listItem
in classSinkAdapter
- See Also:
-
listItem
public void listItem(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
listItem
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
listItem
in 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) The default list style depends on the numbering.- Specified by:
numberedList
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
numberedList
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:
numberedList
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
numberedList
in 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()- Specified by:
numberedListItem
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
numberedListItem
in classSinkAdapter
- See Also:
-
numberedListItem
public void numberedListItem(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
numberedListItem
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
numberedListItem
in 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()- Specified by:
definitionList
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
definitionList
in classSinkAdapter
- See Also:
-
definitionList
public void definitionList(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
definitionList
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
definitionList
in 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:
definedTerm
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
definedTerm
in classSinkAdapter
- See Also:
-
definedTerm
public void definedTerm()- Specified by:
definedTerm
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
definedTerm
in 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()- Specified by:
definition
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
definition
in classSinkAdapter
- See Also:
-
definition
public void definition(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
definition
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
definition
in 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()Deprecated.Usefigure(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().- Specified by:
figure
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
figure
in classSinkAdapter
- See Also:
-
figure
public void figure(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
figure
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
figure
in classSinkAdapter
- See Also:
-
figure_
public void figure_()- Specified by:
figure_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
figure_
in classSinkAdapter
-
figureGraphics
Deprecated.UsefigureGraphics(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.- Specified by:
figureGraphics
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
figureGraphics
in classSinkAdapter
-
figureGraphics
- Specified by:
figureGraphics
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
figureGraphics
in classSinkAdapter
-
figureCaption
public void figureCaption()Deprecated.UsefigureCaption(SinkEventAttributes)
, this method is only kept for backward compatibility. Note that the behavior is different though, as this method only writes an alt attribute.- Specified by:
figureCaption
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
figureCaption
in classSinkAdapter
-
figureCaption
public void figureCaption(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
figureCaption
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
figureCaption
in classSinkAdapter
-
figureCaption_
public void figureCaption_()- Specified by:
figureCaption_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
figureCaption_
in classSinkAdapter
-
paragraph
public void paragraph()- Specified by:
paragraph
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
paragraph
in classSinkAdapter
- See Also:
-
paragraph
public void paragraph(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
paragraph
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
paragraph
in classSinkAdapter
- See Also:
-
paragraph_
public void paragraph_()- Specified by:
paragraph_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
paragraph_
in classSinkAdapter
- See Also:
-
address
public void address()- Specified by:
address
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
address
in classSinkAdapter
- See Also:
-
address
public void address(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
address
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
address
in 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()- Specified by:
blockquote
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
blockquote
in classSinkAdapter
- See Also:
-
blockquote
public void blockquote(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
blockquote
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
blockquote
in 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()- Specified by:
division
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
division
in classSinkAdapter
- See Also:
-
division
public void division(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
division
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
division
in 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(boolean boxed) The default class style for boxed issource
.- Specified by:
verbatim
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
verbatim
in classSinkAdapter
- See Also:
-
verbatim
public void verbatim(org.apache.maven.doxia.sink.SinkEventAttributes attributes) The default class style for boxed issource
.- Specified by:
verbatim
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
verbatim
in 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()- Specified by:
horizontalRule
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
horizontalRule
in classSinkAdapter
- See Also:
-
horizontalRule
public void horizontalRule(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
horizontalRule
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
horizontalRule
in classSinkAdapter
- See Also:
-
table
public void table()- Specified by:
table
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
table
in classSinkAdapter
-
table
public void table(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
table
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
table
in 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 class style isbodyTable
. The default align iscenter
.- Specified by:
tableRows
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
tableRows
in classSinkAdapter
- See Also:
-
tableRows_
public void tableRows_()- Specified by:
tableRows_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
tableRows_
in classSinkAdapter
-
tableRow
public void tableRow()The default class style isa
orb
depending the row id.- Specified by:
tableRow
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
tableRow
in classSinkAdapter
- See Also:
-
tableRow
public void tableRow(org.apache.maven.doxia.sink.SinkEventAttributes attributes) The default class style isa
orb
depending the row id.- Specified by:
tableRow
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
tableRow
in 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()- 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
-
tableCell
- Specified by:
tableCell
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
tableCell
in classSinkAdapter
-
tableHeaderCell
- Specified by:
tableHeaderCell
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
tableHeaderCell
in classSinkAdapter
-
tableCell
public void tableCell(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
tableCell
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
tableCell
in classSinkAdapter
-
tableHeaderCell
public void tableHeaderCell(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
tableHeaderCell
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
tableHeaderCell
in 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()- Specified by:
tableCaption
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
tableCaption
in classSinkAdapter
- See Also:
-
tableCaption
public void tableCaption(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
tableCaption
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
tableCaption
in 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:
anchor
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
anchor
in classSinkAdapter
- See Also:
-
anchor
- Specified by:
anchor
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
anchor
in classSinkAdapter
- See Also:
-
anchor_
public void anchor_()- Specified by:
anchor_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
anchor_
in classSinkAdapter
- See Also:
-
link
- Specified by:
link
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
link
in classSinkAdapter
-
link
- Specified by:
link
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
link
in classSinkAdapter
-
link_
public void link_()- Specified by:
link_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
link_
in classSinkAdapter
- See Also:
-
inline
public void inline()- Specified by:
inline
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
inline
in classSinkAdapter
-
inline
public void inline(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
inline
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
inline
in 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:
italic
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
italic
in 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:
bold
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
bold
in 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:
monospaced
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
monospaced
in 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()- Specified by:
lineBreak
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
lineBreak
in classSinkAdapter
- See Also:
-
lineBreak
public void lineBreak(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
lineBreak
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
lineBreak
in classSinkAdapter
- See Also:
-
pageBreak
public void pageBreak()- Specified by:
pageBreak
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
pageBreak
in classSinkAdapter
-
nonBreakingSpace
public void nonBreakingSpace()- Specified by:
nonBreakingSpace
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
nonBreakingSpace
in classSinkAdapter
-
text
- Specified by:
text
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
text
in classSinkAdapter
-
text
- Specified by:
text
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
text
in classSinkAdapter
-
rawText
- Specified by:
rawText
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
rawText
in classSinkAdapter
-
comment
- Specified by:
comment
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
comment
in 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:
unknown
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
unknown
in classSinkAdapter
- Parameters:
name
- the name of the event. If this is not a valid xhtml tag name as defined inHtmlMarkup
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 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:
flush
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
flush
in classSinkAdapter
-
close
public void close()- Specified by:
close
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
close
in 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:
write
in classAbstractXmlSink
- Parameters:
text
- the given text to write
-
writeStartTag
Starts a Tag with attributes. For instance:<tag attName="attValue">
- Overrides:
writeStartTag
in 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:
writeEndTag
in classAbstractXmlSink
- Parameters:
t
- a tag.
-
figure(SinkEventAttributes)
, this method is only kept for backward compatibility.