XhtmlSink (Doxia :: XHTML Module 1.0 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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

java.lang.Object
  org.apache.maven.doxia.sink.SinkAdapter
      org.apache.maven.doxia.sink.AbstractXmlSink
          org.apache.maven.doxia.module.xhtml.XhtmlSink

All Implemented Interfaces:: Markup, Sink, XhtmlMarkup, XmlMarkup

public class XhtmlSink
extends AbstractXmlSink
implements XhtmlMarkup

Xhtml sink implementation.

Since:

1.0

Version:

$Id: XhtmlSink.java 599638 2007-11-29 23:54:47Z hboutemy $

Author:

Jason van Zyl

Plexus component:

role:: "org.apache.maven.doxia.sink.Sink"
role-hint:: "xhtml"

Field Summary

Fields inherited from interface org.apache.maven.doxia.module.xhtml.XhtmlMarkup

TBODY_TAG

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

BANG, CDATA

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

EOL, EQUAL, GREATER_THAN, LEFT_CURLY_BRACKET, LEFT_SQUARE_BRACKET, LESS_THAN, MINUS, PLUS, QUOTE, RIGHT_CURLY_BRACKET, RIGHT_SQUARE_BRACKET, SLASH, SPACE, STAR

Fields inherited from interface org.apache.maven.doxia.sink.Sink

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
`XhtmlSink(Writer writer)`
`XhtmlSink(Writer writer, RenderingContext renderingContext)`
`XhtmlSink(Writer writer, RenderingContext renderingContext, Map directives)`

Method Summary
`void`	`anchor_()`
`void`	`anchor(String name)`
`void`	`author_()`
`void`	`body_()`
`void`	`body()`
`void`	`bold_()`
`void`	`bold()`
`void`	`close()`
`protected void`	`content(String text)`
`void`	`date_()`
`void`	`definedTerm_()`
`void`	`definedTerm()`
`void`	`definition_()`
`void`	`definition()`
`void`	`definitionList_()`
`void`	`definitionList()`
`static String`	`encodeFragment(String text)`
`static String`	`encodeURL(String text)` Forward to HtmlTools.encodeURL( text ).
`static String`	`escapeHTML(String text)` Forward to HtmlTools.escapeHTML( text ).
`void`	`figure_()`
`void`	`figure()`
`void`	`figureCaption_()`
`void`	`figureCaption()`
`void`	`figureGraphics(String name)`
`void`	`flush()`
`protected StringBuffer`	`getBuffer()`
`RenderingContext`	`getRenderingContext()`
`void`	`head_()`
`void`	`head()`
`void`	`horizontalRule()`
`void`	`italic_()`
`void`	`italic()`
`void`	`lineBreak()`
`void`	`link_()`
`void`	`link(String name)`
`void`	`link(String name, String target)` The default style class for external link is `externalLink`.
`void`	`list_()`
`void`	`list()`
`void`	`listItem_()`
`void`	`listItem()`
`void`	`monospaced_()`
`void`	`monospaced()`
`void`	`nonBreakingSpace()`
`void`	`numberedList_()`
`void`	`numberedList(int numbering)`
`void`	`numberedListItem_()`
`void`	`numberedListItem()`
`void`	`paragraph_()`
`void`	`paragraph()`
`void`	`rawText(String text)`
`protected void`	`resetBuffer()` Reset the buffer.
`protected void`	`resetState()` Reset all the Sink state.
`void`	`section1_()`
`void`	`section1()` The default class style is `section`.
`void`	`section2_()`
`void`	`section2()` The default class style is `section`.
`void`	`section3_()`
`void`	`section3()` The default class style is `section`.
`void`	`section4_()`
`void`	`section4()` The default class style is `section`.
`void`	`section5_()`
`void`	`section5()` The default class style is `section`.
`void`	`sectionTitle1_()`
`void`	`sectionTitle1()`
`void`	`sectionTitle2_()`
`void`	`sectionTitle2()`
`void`	`sectionTitle3_()`
`void`	`sectionTitle3()`
`void`	`sectionTitle4_()`
`void`	`sectionTitle4()`
`void`	`sectionTitle5_()`
`void`	`sectionTitle5()`
`protected void`	`setHeadFlag(boolean headFlag)`
`void`	`table_()`
`void`	`table()` The default class style is `bodyTable`.
`void`	`tableCaption_()`
`void`	`tableCaption()`
`void`	`tableCell_()`
`void`	`tableCell_(boolean headerRow)`
`void`	`tableCell()`
`void`	`tableCell(boolean headerRow)`
`void`	`tableCell(boolean headerRow, String width)`
`void`	`tableCell(String width)`
`void`	`tableHeaderCell_()`
`void`	`tableHeaderCell()`
`void`	`tableHeaderCell(String width)`
`void`	`tableRow_()`
`void`	`tableRow()` The default class style is `a` or `b` depending the row id.
`void`	`tableRows_()`
`void`	`tableRows(int[] justification, boolean grid)`
`void`	`text(String text)`
`void`	`title_()`
`void`	`title()`
`void`	`verbatim_()`
`void`	`verbatim(boolean boxed)` The default class style is `source`.
`protected void`	`verbatimContent(String text)`
`protected void`	`write(String text)`

Methods inherited from class org.apache.maven.doxia.sink.AbstractXmlSink

writeEndTag, writeEndTagWithoutEOL, writeSimpleTag, writeSimpleTag, writeStartTag, writeStartTag, writeStartTag

Methods inherited from class org.apache.maven.doxia.sink.SinkAdapter

author, date, definitionListItem_, definitionListItem, pageBreak, sectionTitle_, sectionTitle

Methods inherited from class java.lang.Object

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

Constructor Detail

XhtmlSink

public XhtmlSink(Writer writer)

Parameters:: writer -

XhtmlSink

public XhtmlSink(Writer writer,
                 RenderingContext renderingContext)

Parameters:: writer -; renderingContext -

XhtmlSink

public XhtmlSink(Writer writer,
                 RenderingContext renderingContext,
                 Map directives)

Parameters:: writer -; renderingContext -; directives -

Method Detail

getBuffer

protected StringBuffer getBuffer()

Returns:: the current buffer

setHeadFlag

protected void setHeadFlag(boolean headFlag)

Parameters:: headFlag - an header flag

resetState

protected void resetState()

Reset all the Sink state.

resetBuffer

protected void resetBuffer()

Reset the buffer.

head

public void head()

Specified by:: head in interface Sink

head_

public void head_()

Specified by:: head_ in interface Sink

title

public void title()

Specified by:: title in interface Sink

See Also:: HTML.Tag.TITLE

title_

public void title_()

Specified by:: title_ in interface Sink

See Also:: HTML.Tag.TITLE

author_

public void author_()

Specified by:: author_ in interface Sink

See Also:: HTML.Tag.META

date_

public void date_()

Specified by:: date_ in interface Sink

See Also:: HTML.Tag.META

body

public void body()

Specified by:: body in interface Sink

body_

public void body_()

Specified by:: body_ in interface Sink