org.apache.maven.doxia.module.xhtml
Class XhtmlSink

java.lang.Object
  extended by org.apache.maven.doxia.sink.AbstractSink
      extended by org.apache.maven.doxia.sink.SinkAdapter
          extended by org.apache.maven.doxia.sink.AbstractXmlSink
              extended by org.apache.maven.doxia.sink.XhtmlBaseSink
                  extended by org.apache.maven.doxia.module.xhtml.XhtmlSink
All Implemented Interfaces:
LogEnabled, HtmlMarkup, Markup, XmlMarkup, XhtmlMarkup, Sink

public class XhtmlSink
extends 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
Version:
$Id: XhtmlSink.java 807186 2009-08-24 12:29:12Z vsiveton $
Author:
Jason van Zyl, ltheussl

Field Summary
 
Fields inherited from class org.apache.maven.doxia.sink.XhtmlBaseSink
tableAttributes, tableRows
 
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.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.XmlMarkup
BANG, CDATA, DOCTYPE_START, ENTITY_START, XML_NAMESPACE
 
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
 
Constructor Summary
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
 void author_()
          Ends an author element.
 void body_()
          Ends the body element.
 void body()
          Starts the body of a document.
 void date_()
          Ends the date element.
 void head_()
          Ends the head element.
 void head()
          Starts the head element.
protected  boolean isHeadTitleFlag()
          isHeadTitleFlag.
protected  void setHeadTitleFlag(boolean headTitleFlag)
          Setter for the field headTitleFlag.
 void title_()
          Ends the title element.
 void title()
          Starts the title element.
 
Methods inherited from class org.apache.maven.doxia.sink.XhtmlBaseSink
anchor_, anchor, anchor, bold_, bold, close, comment, content, definedTerm_, definedTerm, definedTerm, definition_, definition, definition, definitionList_, definitionList, definitionList, encodeURL, escapeHTML, figure_, figure, figure, figureCaption_, figureCaption, figureCaption, figureGraphics, figureGraphics, flush, getCellCount, getCellJustif, getTextBuffer, horizontalRule, horizontalRule, init, 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.AbstractXmlSink
getNameSpace, setNameSpace, writeEOL, writeSimpleTag, writeSimpleTag, writeStartTag, writeStartTag
 
Methods inherited from class org.apache.maven.doxia.sink.SinkAdapter
author, author, body, date, date, definitionListItem_, definitionListItem, definitionListItem, head, sectionTitle_, sectionTitle, title
 
Methods inherited from class org.apache.maven.doxia.sink.AbstractSink
enableLogging, getLog, unifyEOLs
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

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 Detail

head

public void head()
Starts the head element.

Specified by:
head in interface Sink
Overrides:
head in class SinkAdapter
See Also:
Sink.head(SinkEventAttributes)

head_

public void head_()
Ends the head element.

Specified by:
head_ in interface Sink
Overrides:
head_ in class SinkAdapter

title

public void title()
Starts the title element.

Specified by:
title in interface Sink
Overrides:
title in class SinkAdapter
See Also:
HTML.Tag.TITLE

title_

public void title_()
Ends the title element.

Specified by:
title_ in interface Sink
Overrides:
title_ in class SinkAdapter
See Also:
HTML.Tag.TITLE

author_

public void author_()
Ends an author element.

Specified by:
author_ in interface Sink
Overrides:
author_ in class SinkAdapter
See Also:
HTML.Tag.META

date_

public void date_()
Ends the date element.

Specified by:
date_ in interface Sink
Overrides:
date_ in class SinkAdapter
See Also:
HTML.Tag.META

body

public void body()
Starts the body of a document.

Specified by:
body in interface Sink
Overrides:
body in class SinkAdapter
See Also:
HTML.Tag.BODY

body_

public void body_()
Ends the body element.

Specified by:
body_ in interface Sink
Overrides:
body_ in class SinkAdapter
See Also:
HTML.Tag.BODY, HTML.Tag.HTML

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


Copyright © 2005-2012 The Apache Software Foundation. All Rights Reserved.