org.apache.maven.doxia.module.apt

Class AptSink

public class AptSink extends AbstractTextSink implements AptMarkup

APT Sink implementation.

Since: 1.0

Version: $Id: AptSink.java 572813 2007-09-04 20:46:47Z ltheussl $

Author: eredmond

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

Constructor Summary
AptSink(Writer writer)
Constructor, initialize the variables.
Method Summary
voidanchor(String name)
voidanchor_()
voidauthor_()
voidbold()
voidbold_()
voidclose()
protected voidcontent(String text)
Write Apt escaped text to output.
voiddate_()
voiddefinedTerm()
voiddefinedTerm_()
voiddefinition()
voiddefinitionList()
voiddefinitionList_()
voiddefinition_()
static StringencodeFragment(String text)
Forward to HtmlTools.encodeFragment( text ).
static StringencodeURL(String text)
Forward to HtmlTools.encodeURL( text ).
voidfigureCaption_()
voidfigureGraphics(String name)
voidflush()
protected StringBuffergetBuffer()
Returns the buffer that holds the current text.
voidhead()
voidhead_()
voidhorizontalRule()
voiditalic()
voiditalic_()
voidlineBreak()
voidlink(String name)
voidlink(String name, String target)
A link with a target.
voidlink_()
voidlist()
voidlistItem()
voidlistItem_()
voidlist_()
voidmonospaced()
voidmonospaced_()
voidnonBreakingSpace()
voidnumberedList(int numbering)
voidnumberedListItem()
voidnumberedListItem_()
voidnumberedList_()
voidpageBreak()
voidparagraph()
voidparagraph_()
voidrawText(String text)
protected voidresetBuffer()
Reset the StringBuffer.
protected voidresetState()
Reset all variables.
protected voidresetTableCaptionBuffer()
Reset the TableCaptionBuffer.
voidsection1_()
voidsection2_()
voidsection3_()
voidsection4_()
voidsection5_()
voidsectionTitle1()
voidsectionTitle1_()
voidsectionTitle2()
voidsectionTitle2_()
voidsectionTitle3()
voidsectionTitle3_()
voidsectionTitle4()
voidsectionTitle4_()
voidsectionTitle5()
voidsectionTitle5_()
protected voidsetHeadFlag(boolean headFlag)
Used to determine whether we are in head mode.
voidtable()
voidtableCaption()
voidtableCaption_()
voidtableCell()
voidtableCell(boolean headerRow)
Starts a table cell.
voidtableCell_()
voidtableHeaderCell()
voidtableHeaderCell_()
voidtableRow()
voidtableRows(int[] justification, boolean grid)
voidtableRows_()
voidtableRow_()
voidtable_()
voidtext(String text)
voidtitle_()
voidverbatim(boolean boxed)
protected voidverbatimContent(String text)
Write Apt escaped text to output.
voidverbatim_()
protected voidwrite(String text)
Write text to output.

Constructor Detail

AptSink

public AptSink(Writer writer)
Constructor, initialize the variables.

Parameters: writer The writer to write the result.

Method Detail

anchor

public void anchor(String name)
{@inheritDoc }

anchor_

public void anchor_()
{@inheritDoc }

author_

public void author_()
{@inheritDoc }

bold

public void bold()
{@inheritDoc }

bold_

public void bold_()
{@inheritDoc }

close

public void close()
{@inheritDoc }

content

protected void content(String text)
Write Apt escaped text to output.

Parameters: text The text to write.

date_

public void date_()
{@inheritDoc }

definedTerm

public void definedTerm()
{@inheritDoc }

definedTerm_

public void definedTerm_()
{@inheritDoc }

definition

public void definition()
{@inheritDoc }

definitionList

public void definitionList()
{@inheritDoc }

definitionList_

public void definitionList_()
{@inheritDoc }

definition_

public void definition_()
{@inheritDoc }

encodeFragment

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

Parameters: text the String to fragment, may be null.

Returns: the fragmented text, null if null String input.

See Also: .

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: .

figureCaption_

public void figureCaption_()
{@inheritDoc }

figureGraphics

public void figureGraphics(String name)
{@inheritDoc }

flush

public void flush()
{@inheritDoc }

getBuffer

protected StringBuffer getBuffer()
Returns the buffer that holds the current text.

Returns: A StringBuffer.

head

public void head()
{@inheritDoc }

head_

public void head_()
{@inheritDoc }

horizontalRule

public void horizontalRule()
{@inheritDoc }

italic

public void italic()
{@inheritDoc }

italic_

public void italic_()
{@inheritDoc }

lineBreak

public void lineBreak()
{@inheritDoc }

link

public void link(String name)
{@inheritDoc }

link

public void link(String name, String target)
A link with a target.

Parameters: name The name of the link. target The link target.

link_

public void link_()
{@inheritDoc }

list

public void list()
{@inheritDoc }

listItem

public void listItem()
{@inheritDoc }

listItem_

public void listItem_()
{@inheritDoc }

list_

public void list_()
{@inheritDoc }

monospaced

public void monospaced()
{@inheritDoc }

monospaced_

public void monospaced_()
{@inheritDoc }

nonBreakingSpace

public void nonBreakingSpace()
{@inheritDoc }

numberedList

public void numberedList(int numbering)
{@inheritDoc }

numberedListItem

public void numberedListItem()
{@inheritDoc }

numberedListItem_

public void numberedListItem_()
{@inheritDoc }

numberedList_

public void numberedList_()
{@inheritDoc }

pageBreak

public void pageBreak()
{@inheritDoc }

paragraph

public void paragraph()
{@inheritDoc }

paragraph_

public void paragraph_()
{@inheritDoc }

rawText

public void rawText(String text)
{@inheritDoc }

resetBuffer

protected void resetBuffer()
Reset the StringBuffer.

resetState

protected void resetState()
Reset all variables.

resetTableCaptionBuffer

protected void resetTableCaptionBuffer()
Reset the TableCaptionBuffer.

section1_

public void section1_()
{@inheritDoc }

section2_

public void section2_()
{@inheritDoc }

section3_

public void section3_()
{@inheritDoc }

section4_

public void section4_()
{@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 }

setHeadFlag

protected void setHeadFlag(boolean headFlag)
Used to determine whether we are in head mode.

Parameters: headFlag True for head mode.

table

public void table()
{@inheritDoc }

tableCaption

public void tableCaption()
{@inheritDoc }

tableCaption_

public void tableCaption_()
{@inheritDoc }

tableCell

public void tableCell()
{@inheritDoc }

tableCell

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

Parameters: headerRow If this cell is part of a header row.

tableCell_

public void tableCell_()
{@inheritDoc }

tableHeaderCell

public void tableHeaderCell()
{@inheritDoc }

tableHeaderCell_

public void tableHeaderCell_()
{@inheritDoc }

tableRow

public void tableRow()
{@inheritDoc }

tableRows

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

tableRows_

public void tableRows_()
{@inheritDoc }

tableRow_

public void tableRow_()
{@inheritDoc }

table_

public void table_()
{@inheritDoc }

text

public void text(String text)
{@inheritDoc }

title_

public void title_()
{@inheritDoc }

verbatim

public void verbatim(boolean boxed)
{@inheritDoc }

verbatimContent

protected void verbatimContent(String text)
Write Apt escaped text to output.

Parameters: text The text to write.

verbatim_

public void verbatim_()
{@inheritDoc }

write

protected void write(String text)
Write text to output.

Parameters: text The text to write.

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