Package org.apache.maven.doxia.module.xhtml

Class XhtmlSink

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
org.apache.maven.doxia.module.xhtml.XhtmlSink
All Implemented Interfaces:
org.apache.maven.doxia.logging.LogEnabled, org.apache.maven.doxia.markup.HtmlMarkup, org.apache.maven.doxia.markup.Markup, org.apache.maven.doxia.markup.XmlMarkup, XhtmlMarkup, org.apache.maven.doxia.sink.Sink
public class XhtmlSink extends org.apache.maven.doxia.sink.impl.XhtmlBaseSink implements XhtmlMarkup
Xhtml 1.0 Transitional sink implementation.
It uses the DTD/xhtml1-transitional http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd.
Since:
1.0
Author:
Jason van Zyl, ltheussl

  • Field Summary

    Fields inherited from class org.apache.maven.doxia.sink.impl.XhtmlBaseSink

    inlineStack, tableAttributes, tableRows

    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.module.xhtml.XhtmlMarkup

    XHTML_NAMESPACE, XHTML_TRANSITIONAL_PUBLIC_ID, XHTML_TRANSITIONAL_SYSTEM_ID

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

    BANG, CDATA, DOCTYPE_START, ENTITY_START, XML_NAMESPACE

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    XhtmlSink(Writer writer)
    Constructor, initialize the Writer.
    protected
    XhtmlSink(Writer writer, String encoding)
    Constructor, initialize the Writer and tells which encoding is used.
    protected
    XhtmlSink(Writer writer, String encoding, String languageId)
    Constructor, initialize the Writer and tells which encoding and languageId are used.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    author_()
    void
    body()
    void
    body_()
    void
    date_()
    void
    head()
    void
    head_()
    protected boolean
    isHeadTitleFlag()
    isHeadTitleFlag.
    protected void
    setHeadTitleFlag(boolean headTitleFlag)
    Setter for the field headTitleFlag.
    void
    title()
    void
    title_()

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

    address, address, address_, anchor, anchor, anchor_, blockquote, blockquote, blockquote_, bold, bold_, close, comment, content, definedTerm, definedTerm, definedTerm_, definition, definition, definition_, definitionList, definitionList, definitionList_, division, division, division_, encodeURL, escapeHTML, figure, figure, figure_, figureCaption, figureCaption, figureCaption_, figureGraphics, figureGraphics, flush, getCellCount, getCellJustif, getTextBuffer, horizontalRule, horizontalRule, init, inline, inline, inline_, isHeadFlag, isVerbatimFlag, italic, italic_, lineBreak, lineBreak, link, link, link_, list, list, list_, listItem, listItem, listItem_, monospaced, monospaced_, nonBreakingSpace, numberedList, numberedList, numberedList_, numberedListItem, numberedListItem, numberedListItem_, onSection, onSection_, onSectionTitle, onSectionTitle_, 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, table, table, table_, tableCaption, tableCaption, tableCaption_, tableCell, tableCell, tableCell, tableCell_, tableHeaderCell, tableHeaderCell, tableHeaderCell, tableHeaderCell_, tableRow, tableRow, tableRow_, tableRows, tableRows_, text, text, unknown, verbatim, verbatim, verbatim_, verbatimContent, write, writeEndTag, writeStartTag

    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, body, content, content, content_, data, data, data_, date, date, definitionListItem, definitionListItem, definitionListItem_, footer, footer, footer_, head, header, header, header_, lineBreakOpportunity, lineBreakOpportunity, navigation, navigation, navigation_, section6, section6_, sectionTitle, sectionTitle_, sectionTitle6, sectionTitle6_, sidebar, sidebar, sidebar_, time, time, time_, title

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

    enableLogging, getLog, unifyEOLs

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • XhtmlSink

      protected XhtmlSink(Writer writer)
      Constructor, initialize the Writer.
      Parameters:
      writer - not null writer to write the result.

    • XhtmlSink

      protected XhtmlSink(Writer writer, String encoding)
      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 not null.

    • XhtmlSink

      protected XhtmlSink(Writer writer, String encoding, String languageId)
      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 not null.
      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()
      Specified by:
      head in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      head in class org.apache.maven.doxia.sink.impl.SinkAdapter

    • head_

      public void head_()
      Specified by:
      head_ in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      head_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

    • title

      public void title()
      Specified by:
      title in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      title in class org.apache.maven.doxia.sink.impl.SinkAdapter
      See Also:

    • title_

      public void title_()
      Specified by:
      title_ in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      title_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
      See Also:

    • author_

      public void author_()
      Specified by:
      author_ in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      author_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
      See Also:

    • date_

      public void date_()
      Specified by:
      date_ in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      date_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
      See Also:

    • body

      public void body()
      Specified by:
      body in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      body in class org.apache.maven.doxia.sink.impl.SinkAdapter
      See Also:

    • body_

      public void body_()
      Specified by:
      body_ in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      body_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
      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