Overview Package Class Use Tree Deprecated Index Help

Prev Class Next Class Frames NoFrames All Classes

Summary: Nested Field Constr Method Detail: Field Constr Method

Doxia 1.0-alpha-10 API

org.apache.maven.doxia.module.xhtml

Class XhtmlSink

public class XhtmlSink extends AbstractXmlSink implements XhtmlMarkup

Xhtml sink implementation.

Since: 1.0

Version: $Id: XhtmlSink.java 586736 2007-10-20 14:50:01Z dennisl $

Author: Jason van Zyl

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

Constructor Summary
XhtmlSink(Writer writer)
XhtmlSink(Writer writer, RenderingContext renderingContext)
XhtmlSink(Writer writer, RenderingContext renderingContext, Map directives)
Method Summary
voidanchor(String name)
voidanchor_()
voidauthor_()
voidbody()
voidbody_()
voidbold()
voidbold_()
voidclose()
protected voidcontent(String text)
voiddate_()
voiddefinedTerm()
voiddefinedTerm_()
voiddefinition()
voiddefinitionList()
voiddefinitionList_()
voiddefinition_()
static StringencodeFragment(String text)
static StringencodeURL(String text)
Forward to HtmlTools.encodeURL( text ).
static StringescapeHTML(String text)
Forward to HtmlTools.escapeHTML( text ).
voidfigure()
voidfigureCaption()
voidfigureCaption_()
voidfigureGraphics(String name)
voidfigure_()
voidflush()
protected StringBuffergetBuffer()
RenderingContextgetRenderingContext()
voidhead()
voidhead_()
voidhorizontalRule()
voiditalic()
voiditalic_()
voidlineBreak()
voidlink(String name)
voidlink(String name, String target)
The default style class for external link is externalLink.
voidlink_()
voidlist()
voidlistItem()
voidlistItem_()
voidlist_()
voidmonospaced()
voidmonospaced_()
voidnonBreakingSpace()
voidnumberedList(int numbering)
voidnumberedListItem()
voidnumberedListItem_()
voidnumberedList_()
voidparagraph()
voidparagraph_()
voidrawText(String text)
protected voidresetBuffer()
Reset the buffer.
protected voidresetState()
Reset all the Sink state.
voidsection1()
The default class style is section.
voidsection1_()
voidsection2()
The default class style is section.
voidsection2_()
voidsection3()
The default class style is section.
voidsection3_()
voidsection4()
The default class style is section.
voidsection4_()
voidsection5()
The default class style is section.
voidsection5_()
voidsectionTitle1()
voidsectionTitle1_()
voidsectionTitle2()
voidsectionTitle2_()
voidsectionTitle3()
voidsectionTitle3_()
voidsectionTitle4()
voidsectionTitle4_()
voidsectionTitle5()
voidsectionTitle5_()
protected voidsetHeadFlag(boolean headFlag)
voidtable()
The default class style is bodyTable.
voidtableCaption()
voidtableCaption_()
voidtableCell()
voidtableCell(boolean headerRow)
voidtableCell(String width)
voidtableCell(boolean headerRow, String width)
voidtableCell_()
voidtableCell_(boolean headerRow)
voidtableHeaderCell()
voidtableHeaderCell(String width)
voidtableHeaderCell_()
voidtableRow()
The default class style is a or b depending the row id.
voidtableRows(int[] justification, boolean grid)
voidtableRows_()
voidtableRow_()
voidtable_()
voidtext(String text)
voidtitle()
voidtitle_()
voidverbatim(boolean boxed)
The default class style is source.
protected voidverbatimContent(String text)
voidverbatim_()
protected voidwrite(String text)

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

UNKNOWN: directives Map is not used

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: javax.swing.text.html.HTML.Tag#META

body

public void body()
{@inheritDoc }

body_

public void body_()
{@inheritDoc }

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)

date_

public void date_()
{@inheritDoc }

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

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

encodeFragment

public static String encodeFragment(String text)

Parameters: text

Returns: a fragment encoded

See Also: encodeURL

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 name)
{@inheritDoc }

figure_

public void figure_()
{@inheritDoc }

flush

public void flush()
{@inheritDoc }

getBuffer

protected StringBuffer getBuffer()

Returns: the current buffer

getRenderingContext

public RenderingContext getRenderingContext()

Returns: the current rendering context

head

public void head()
{@inheritDoc }

head_

public void head_()
{@inheritDoc }

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 }

link

public void link(String name, String target)
The default style class for external link is externalLink.

Parameters: name target

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

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)
{@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

rawText

public void rawText(String text)
{@inheritDoc }

resetBuffer

protected void resetBuffer()
Reset the buffer.

resetState

protected void resetState()
Reset all the Sink state.

section1

public void section1()
The default class style is section. {@inheritDoc }

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

section1_

public void section1_()
{@inheritDoc }

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

section2

public void section2()
The default class style is section. {@inheritDoc }

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

section2_

public void section2_()
{@inheritDoc }

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

section3

public void section3()
The default class style is section. {@inheritDoc }

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

section3_

public void section3_()
{@inheritDoc }

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

section4

public void section4()
The default class style is section. {@inheritDoc }

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

section4_

public void section4_()
{@inheritDoc }

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

section5

public void section5()
The default class style is section. {@inheritDoc }

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

section5_

public void section5_()
{@inheritDoc }

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

sectionTitle1

public void sectionTitle1()
{@inheritDoc }

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

sectionTitle1_

public void sectionTitle1_()
{@inheritDoc }

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

sectionTitle2

public void sectionTitle2()
{@inheritDoc }

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

sectionTitle2_

public void sectionTitle2_()
{@inheritDoc }

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

sectionTitle3

public void sectionTitle3()
{@inheritDoc }

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

sectionTitle3_

public void sectionTitle3_()
{@inheritDoc }

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

sectionTitle4

public void sectionTitle4()
{@inheritDoc }

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

sectionTitle4_

public void sectionTitle4_()
{@inheritDoc }

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

sectionTitle5

public void sectionTitle5()
{@inheritDoc }

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

sectionTitle5_

public void sectionTitle5_()
{@inheritDoc }

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

setHeadFlag

protected void setHeadFlag(boolean headFlag)

Parameters: headFlag an header flag

table

public void table()
The default class style is bodyTable. {@inheritDoc }

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

tableCaption

public void tableCaption()
{@inheritDoc }

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

tableCaption_

public void tableCaption_()
{@inheritDoc }

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

tableCell

public void tableCell()
{@inheritDoc }

tableCell

public void tableCell(boolean headerRow)

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(String width)
{@inheritDoc }

tableCell

public void tableCell(boolean headerRow, String width)

Parameters: headerRow true if it is an header row width the cell size

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)

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(String width)
{@inheritDoc }

tableHeaderCell_

public void tableHeaderCell_()
{@inheritDoc }

tableRow

public void tableRow()
The default class style is a or b depending the row id. {@inheritDoc }

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

tableRows

public void tableRows(int[] justification, boolean grid)
{@inheritDoc }

See Also: TBODY_TAG

tableRows_

public void tableRows_()
{@inheritDoc }

See Also: TBODY_TAG

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

title_

public void title_()
{@inheritDoc }

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

verbatim

public void verbatim(boolean boxed)
The default class style is source. {@inheritDoc }

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

verbatimContent

protected void verbatimContent(String text)

verbatim_

public void verbatim_()
{@inheritDoc }

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

write

protected void write(String text)
{@inheritDoc }

Overview Package Class Use Tree Deprecated Index Help

Prev Class Next Class Frames NoFrames All Classes

Summary: Nested Field Constr Method Detail: Field Constr Method

Doxia 1.0-alpha-10 API

Copyright © 2002-2011 Apache Software Foundation. All Rights Reserved.