org.apache.maven.doxia.module.xdoc

Class XdocSink

public class XdocSink extends AbstractXmlSink implements XdocMarkup

A doxia Sink which produces an xdoc model.

Since: 1.0

Version: $Id: XdocSink.java 568134 2007-08-21 14:08:46Z ltheussl $

Author: James Taylor

UNKNOWN: role="org.apache.maven.doxia.sink.Sink" role-hint="xdoc"

Field Summary
protected StringBufferbuffer
Used to collect text events.
protected booleanheadFlag
An indication on if we're inside a head.
protected LineBreakerout
The LineBreaker to write the result.
protected booleantitleFlag
An indication on if we're inside a title.
Constructor Summary
XdocSink(Writer writer)
Constructor, initialize the LineBreaker.
Method Summary
voidanchor(String name)
voidanchor_()
voidauthor_()
voidbody()
voidbody_()
voidbold()
voidbold_()
voidclose()
protected voidcontent(String text)
Write HTML escaped text to output, not preserving white space.
voiddate_()
voiddefinedTerm()
voiddefinedTerm_()
voiddefinition()
voiddefinitionList()
voiddefinitionList_()
voiddefinition_()
static StringencodeURL(String text)
Forward to HtmlTools.encodeURL( text ).
static StringescapeHTML(String text)
Forward to HtmlTools.escapeHTML( text ).
voidfigure()
voidfigureCaption()
voidfigureCaption_()
voidfigureGraphics(String s)
voidfigure_()
voidflush()
voidhead()
voidhead_()
voidhorizontalRule()
voiditalic()
voiditalic_()
voidlineBreak()
voidlink(String name)
voidlink_()
voidlist()
voidlistItem()
voidlistItem_()
voidlist_()
protected voidmarkup(String text)
Write text to output, preserving white space.
voidmonospaced()
voidmonospaced_()
voidnonBreakingSpace()
voidnumberedList(int numbering)
The default list style depends on the numbering.
voidnumberedListItem()
voidnumberedListItem_()
voidnumberedList_()
voidparagraph()
voidparagraph_()
protected voidresetState()
Reset all variables.
voidsection1()
voidsection1_()
voidsection2()
voidsection2_()
voidsection3()
voidsection3_()
voidsection4()
voidsection4_()
voidsection5()
voidsection5_()
voidsectionTitle1()
voidsectionTitle1_()
voidsectionTitle2()
voidsectionTitle2_()
voidsectionTitle3()
voidsectionTitle3_()
voidsectionTitle4()
voidsectionTitle4_()
voidsectionTitle5()
voidsectionTitle5_()
voidtable()
The default align is center.
voidtableCaption()
voidtableCaption_()
voidtableCell()
voidtableCell(boolean headerRow)
Starts a table cell.
voidtableCell_()
voidtableCell_(boolean headerRow)
Ends a table cell.
voidtableHeaderCell()
voidtableHeaderCell_()
voidtableRow()
The default valign is top.
voidtableRows(int[] justification, boolean grid)
The default align is center.
voidtableRows_()
voidtableRow_()
voidtable_()
voidtext(String text)
voidtitle_()
voidverbatim(boolean boxed)
protected voidverbatimContent(String text)
Write HTML escaped text to output, preserving white space.
voidverbatim_()
protected voidwrite(String text)

Field Detail

buffer

protected StringBuffer buffer
Used to collect text events.

headFlag

protected boolean headFlag
An indication on if we're inside a head.

out

protected LineBreaker out
The LineBreaker to write the result.

titleFlag

protected boolean titleFlag
An indication on if we're inside a title. This will prevent the styling of titles.

Constructor Detail

XdocSink

public XdocSink(Writer writer)
Constructor, initialize the LineBreaker.

Parameters: writer The writer to write the result.

Method Detail

anchor

public void anchor(String name)
{@inheritDoc }

See Also: javax.swing.text.html.HTML.Tag#A

anchor_

public void anchor_()
{@inheritDoc }

See Also: javax.swing.text.html.HTML.Tag#A

author_

public void author_()
{@inheritDoc }

See Also: AUTHOR_TAG

body

public void body()
{@inheritDoc }

See Also: javax.swing.text.html.HTML.Tag#BODY

body_

public void body_()
{@inheritDoc }

See Also: javax.swing.text.html.HTML.Tag#BODY DOCUMENT_TAG

bold

public void bold()
{@inheritDoc }

See Also: javax.swing.text.html.HTML.Tag#B

bold_

public void bold_()
{@inheritDoc }

See Also: javax.swing.text.html.HTML.Tag#B

close

public void close()
{@inheritDoc }

content

protected void content(String text)
Write HTML escaped text to output, not preserving white space.

Parameters: text The text to write.

date_

public void date_()
{@inheritDoc }

See Also: DATE_TAG

definedTerm

public void definedTerm()
{@inheritDoc }

See Also: javax.swing.text.html.HTML.Tag#DT

definedTerm_

public void definedTerm_()
{@inheritDoc }

See Also: javax.swing.text.html.HTML.Tag#DT

definition

public void definition()
{@inheritDoc }

See Also: javax.swing.text.html.HTML.Tag#DD

definitionList

public void definitionList()
{@inheritDoc }

See Also: javax.swing.text.html.HTML.Tag#DL

definitionList_

public void definitionList_()
{@inheritDoc }

See Also: javax.swing.text.html.HTML.Tag#DL

definition_

public void definition_()
{@inheritDoc }

See Also: javax.swing.text.html.HTML.Tag#DD

encodeURL

public static String encodeURL(String text)
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: encodeURL

escapeHTML

public static String escapeHTML(String text)
Forward to HtmlTools.escapeHTML( text ).

Parameters: text the String to escape, may be null

Returns: the text escaped, "" if null String input

See Also: escapeHTML

figure

public void figure()
{@inheritDoc }

See Also: javax.swing.text.html.HTML.Tag#IMG

figureCaption

public void figureCaption()
{@inheritDoc }

figureCaption_

public void figureCaption_()
{@inheritDoc }

figureGraphics

public void figureGraphics(String s)
{@inheritDoc }

figure_

public void figure_()
{@inheritDoc }

flush

public void flush()
{@inheritDoc }

head

public void head()
{@inheritDoc }

See Also: DOCUMENT_TAG PROPERTIES_TAG

head_

public void head_()
{@inheritDoc }

See Also: DOCUMENT_TAG PROPERTIES_TAG

horizontalRule

public void horizontalRule()
{@inheritDoc }

See Also: javax.swing.text.html.HTML.Tag#HR

italic

public void italic()
{@inheritDoc }

See Also: javax.swing.text.html.HTML.Tag#I

italic_

public void italic_()
{@inheritDoc }

See Also: javax.swing.text.html.HTML.Tag#I

lineBreak

public void lineBreak()
{@inheritDoc }

See Also: javax.swing.text.html.HTML.Tag#BR

link

public void link(String name)
{@inheritDoc }

See Also: javax.swing.text.html.HTML.Tag#A

link_

public void link_()
{@inheritDoc }

See Also: javax.swing.text.html.HTML.Tag#A

list

public void list()
{@inheritDoc }

See Also: javax.swing.text.html.HTML.Tag#UL

listItem

public void listItem()
{@inheritDoc }

See Also: javax.swing.text.html.HTML.Tag#LI

listItem_

public void listItem_()
{@inheritDoc }

See Also: javax.swing.text.html.HTML.Tag#LI

list_

public void list_()
{@inheritDoc }

See Also: javax.swing.text.html.HTML.Tag#UL

markup

protected void markup(String text)
Write text to output, preserving white space.

Parameters: text The text to write.

monospaced

public void monospaced()
{@inheritDoc }

See Also: javax.swing.text.html.HTML.Tag#TT

monospaced_

public void monospaced_()
{@inheritDoc }

See Also: javax.swing.text.html.HTML.Tag#TT

nonBreakingSpace

public void nonBreakingSpace()
{@inheritDoc }

numberedList

public void numberedList(int numbering)
The default list style depends on the numbering. {@inheritDoc }

See Also: javax.swing.text.html.HTML.Tag#OL

numberedListItem

public void numberedListItem()
{@inheritDoc }

See Also: javax.swing.text.html.HTML.Tag#LI

numberedListItem_

public void numberedListItem_()
{@inheritDoc }

See Also: javax.swing.text.html.HTML.Tag#LI

numberedList_

public void numberedList_()
{@inheritDoc }

See Also: javax.swing.text.html.HTML.Tag#OL

paragraph

public void paragraph()
{@inheritDoc }

See Also: javax.swing.text.html.HTML.Tag#P

paragraph_

public void paragraph_()
{@inheritDoc }

See Also: javax.swing.text.html.HTML.Tag#P

resetState

protected void resetState()
Reset all variables.

section1

public void section1()
{@inheritDoc }

section1_

public void section1_()
{@inheritDoc }

section2

public void section2()
{@inheritDoc }

section2_

public void section2_()
{@inheritDoc }

section3

public void section3()
{@inheritDoc }

section3_

public void section3_()
{@inheritDoc }

section4

public void section4()
{@inheritDoc }

section4_

public void section4_()
{@inheritDoc }

section5

public void section5()
{@inheritDoc }

section5_

public void section5_()
{@inheritDoc }

sectionTitle1

public void sectionTitle1()
{@inheritDoc }

sectionTitle1_

public void sectionTitle1_()
{@inheritDoc }

sectionTitle2

public void sectionTitle2()
{@inheritDoc }

sectionTitle2_

public void sectionTitle2_()
{@inheritDoc }

sectionTitle3

public void sectionTitle3()
{@inheritDoc }

sectionTitle3_

public void sectionTitle3_()
{@inheritDoc }

sectionTitle4

public void sectionTitle4()
{@inheritDoc }

sectionTitle4_

public void sectionTitle4_()
{@inheritDoc }

sectionTitle5

public void sectionTitle5()
{@inheritDoc }

sectionTitle5_

public void sectionTitle5_()
{@inheritDoc }

table

public void table()
The default align is center. {@inheritDoc }

See Also: javax.swing.text.html.HTML.Tag#TABLE

tableCaption

public void tableCaption()
{@inheritDoc }

See Also: javax.swing.text.html.HTML.Tag#P javax.swing.text.html.HTML.Tag#I

tableCaption_

public void tableCaption_()
{@inheritDoc }

See Also: javax.swing.text.html.HTML.Tag#P javax.swing.text.html.HTML.Tag#I

tableCell

public void tableCell()
{@inheritDoc }

tableCell

public void tableCell(boolean headerRow)
Starts a table cell.

Parameters: headerRow true if it is an header row

See Also: javax.swing.text.html.HTML.Tag#TH javax.swing.text.html.HTML.Tag#TD

tableCell_

public void tableCell_()
{@inheritDoc }

tableCell_

public void tableCell_(boolean headerRow)
Ends a table cell.

Parameters: headerRow true if it is an header row

See Also: javax.swing.text.html.HTML.Tag#TH javax.swing.text.html.HTML.Tag#TD

tableHeaderCell

public void tableHeaderCell()
{@inheritDoc }

tableHeaderCell_

public void tableHeaderCell_()
{@inheritDoc }

tableRow

public void tableRow()
The default valign is top. {@inheritDoc }

See Also: javax.swing.text.html.HTML.Tag#TR

tableRows

public void tableRows(int[] justification, boolean grid)
The default align is center. {@inheritDoc }

See Also: javax.swing.text.html.HTML.Tag#TABLE

tableRows_

public void tableRows_()
{@inheritDoc }

See Also: javax.swing.text.html.HTML.Tag#TABLE

tableRow_

public void tableRow_()
{@inheritDoc }

See Also: javax.swing.text.html.HTML.Tag#TR

table_

public void table_()
{@inheritDoc }

See Also: javax.swing.text.html.HTML.Tag#TABLE

text

public void text(String text)
{@inheritDoc }

title_

public void title_()
{@inheritDoc }

See Also: javax.swing.text.html.HTML.Tag#TITLE

verbatim

public void verbatim(boolean boxed)
{@inheritDoc }

See Also: SOURCE_TAG javax.swing.text.html.HTML.Tag#PRE

verbatimContent

protected void verbatimContent(String text)
Write HTML escaped text to output, preserving white space.

Parameters: text The text to write.

verbatim_

public void verbatim_()
{@inheritDoc }

See Also: SOURCE_TAG javax.swing.text.html.HTML.Tag#PRE

write

protected void write(String text)
{@inheritDoc }
Copyright © 2002-2011 Apache Software Foundation. All Rights Reserved.