Class Xhtml5Sink
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
org.apache.maven.doxia.module.xhtml5.Xhtml5Sink
- All Implemented Interfaces:
LogEnabled,HtmlMarkup,Markup,XmlMarkup,Xhtml5Markup,Sink
XHTML 5.2 sink implementation.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate Stringprivate booleanAn indication on if we're inside a head title.private StringFields inherited from class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
contentStack, inlineStack, tableAttributes, tableRowsFields 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, 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, ROLE, 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.module.xhtml5.Xhtml5Markup
XHTML5_NAMESPACEFields inherited from interface org.apache.maven.doxia.markup.XmlMarkup
BANG, CDATA, DOCTYPE_START, ENTITY_START, XML_NAMESPACE -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedXhtml5Sink(Writer writer) Constructor, initialize the Writer.protectedXhtml5Sink(Writer writer, String encoding) Constructor, initialize the Writer and tells which encoding is used.protectedXhtml5Sink(Writer writer, String encoding, String languageId) Constructor, initialize the Writer and tells which encoding and languageId are used. -
Method Summary
Modifier and TypeMethodDescriptionvoidauthor_()Ends an author element.voidbody()Starts the body of a document.voidbody_()Ends the body element.voiddate_()Ends the date element.voidhead()Starts the head element.voidhead_()Ends the head element.protected booleanisHeadTitleFlag.protected voidonSection(int depth, SinkEventAttributes attributes) Starts a section.protected voidonSection_(int depth) Ends a section.protected voidonSectionTitle(int depth, SinkEventAttributes attributes) Starts a section title.protected voidonSectionTitle_(int depth) Ends a section title.protected voidsetHeadTitleFlag(boolean headTitleFlag) Setter for the fieldheadTitleFlag.voidtitle()Starts the title element.voidtitle_()Ends the title element.Methods inherited from class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
address, address, address_, anchor, anchor, anchor_, article, article, article_, blockquote, blockquote, blockquote_, bold, bold_, close, comment, content, content, content, content_, data, data, data_, definedTerm, definedTerm, definedTerm_, definition, definition, definition_, definitionList, definitionList, definitionList_, division, division, division_, encodeURL, escapeHTML, figure, figure, figure_, figureCaption, figureCaption, figureCaption_, figureGraphics, figureGraphics, flush, footer, footer, footer_, getCellCount, getCellJustif, getTextBuffer, header, header, header_, horizontalRule, horizontalRule, init, inline, inline, inline_, isHeadFlag, isVerbatimFlag, italic, italic_, lineBreak, lineBreak, lineBreakOpportunity, lineBreakOpportunity, link, link, link_, list, list, list_, listItem, listItem, listItem_, monospaced, monospaced_, navigation, navigation, navigation_, nonBreakingSpace, numberedList, numberedList, numberedList_, numberedListItem, numberedListItem, numberedListItem_, pageBreak, paragraph, paragraph, paragraph_, rawText, resetState, resetTextBuffer, section, section_, section1, section1_, section2, section2_, section3, section3_, section4, section4_, section5, section5_, sectionTitle, sectionTitle_, sectionTitle1, sectionTitle1_, sectionTitle2, sectionTitle2_, sectionTitle3, sectionTitle3_, sectionTitle4, sectionTitle4_, sectionTitle5, sectionTitle5_, setCellCount, setCellJustif, setHeadFlag, setVerbatimFlag, sidebar, sidebar, sidebar_, table, table, table_, tableCaption, tableCaption, tableCaption_, tableCell, tableCell, tableCell, tableCell_, tableHeaderCell, tableHeaderCell, tableHeaderCell, tableHeaderCell_, tableRow, tableRow, tableRow_, tableRows, tableRows_, text, text, time, time, time_, unknown, verbatim, verbatim, verbatim_, verbatimContent, write, writeEndTag, writeStartTagMethods 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, date, date, definitionListItem, definitionListItem, definitionListItem_, head, section6, section6_, sectionTitle, sectionTitle_, sectionTitle6, sectionTitle6_, titleMethods inherited from class org.apache.maven.doxia.sink.impl.AbstractSink
enableLogging, getLog, unifyEOLs
-
Field Details
-
encoding
-
languageId
-
headTitleFlag
private boolean headTitleFlagAn indication on if we're inside a head title.
-
-
Constructor Details
-
Xhtml5Sink
Constructor, initialize the Writer.- Parameters:
writer- not null writer to write the result.
-
Xhtml5Sink
Constructor, initialize the Writer and tells which encoding is used.- Parameters:
writer- not null writer to write the result.encoding- the encoding used, that should be written to the generated HTML content if notnull.
-
Xhtml5Sink
Constructor, initialize the Writer and tells which encoding and languageId are used.- Parameters:
writer- not null writer to write the result.encoding- the encoding used, that should be written to the generated HTML content if notnull.languageId- language identifier for the root element as defined by IETF BCP 47, Tags for the Identification of Languages; in addition, the empty string may be specified.
-
-
Method Details
-
head
public void head()Starts the head element.- Specified by:
headin interfaceSink- Overrides:
headin classSinkAdapter- See Also:
-
head_
public void head_()Ends the head element.- Specified by:
head_in interfaceSink- Overrides:
head_in classSinkAdapter
-
title
public void title()Starts the title element.- Specified by:
titlein interfaceSink- Overrides:
titlein classSinkAdapter- See Also:
-
title_
public void title_()Ends the title element.- Specified by:
title_in interfaceSink- Overrides:
title_in classSinkAdapter- See Also:
-
author_
public void author_()Ends an author element.- Specified by:
author_in interfaceSink- Overrides:
author_in classSinkAdapter- See Also:
-
date_
public void date_()Ends the date element.- Specified by:
date_in interfaceSink- Overrides:
date_in classSinkAdapter- See Also:
-
body
public void body()Starts the body of a document.- Specified by:
bodyin interfaceSink- Overrides:
bodyin classSinkAdapter- See Also:
-
body_
public void body_()Ends the body element.- Specified by:
body_in interfaceSink- Overrides:
body_in classSinkAdapter- See Also:
-
onSection
Starts a section. The default class style issection. Starts a section..- Overrides:
onSectionin classXhtml5BaseSink- Parameters:
depth- The level of the section.attributes- some attributes. May be null.- See Also:
-
onSection_
protected void onSection_(int depth) Ends a section. Ends a section.- Overrides:
onSection_in classXhtml5BaseSink- Parameters:
depth- The level of the section.- See Also:
-
onSectionTitle
Starts a section title. Starts a section title.- Overrides:
onSectionTitlein classXhtml5BaseSink- 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. Ends a section title.- Overrides:
onSectionTitle_in classXhtml5BaseSink- Parameters:
depth- The level of the section title.- See Also:
-
setHeadTitleFlag
protected void setHeadTitleFlag(boolean headTitleFlag) Setter for the field
headTitleFlag.- Parameters:
headTitleFlag- an header title flag.- Since:
- 1.1
-
isHeadTitleFlag
protected boolean isHeadTitleFlag()isHeadTitleFlag.
- Returns:
- the current headTitleFlag.
- Since:
- 1.1
-