org.apache.maven.doxia.module.latex

Class LatexSink

public class LatexSink extends AbstractTextSink

Latex Sink implementation.

Since: 1.0

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

Constructor Summary
LatexSink(Writer out)
Constructor.
LatexSink(Writer out, String sinkCommands, String preamble)
Constructor.
LatexSink(Writer out, String sinkCommands, String preamble, boolean fragmentDocument)
Constructor.
Method Summary
voidanchor(String name)
voidanchor_()
voidauthor()
voidauthor_()
voidbody()
voidbody_()
voidbold()
voidbold_()
voidclose()
protected voidcontent(String text)
Writes the text, without preserving whitespace.
voiddate()
voiddate_()
static StringdefaultPreamble()
Returns the default preamble.
static StringdefaultSinkCommands()
Returns the default sink commands.
voiddefinedTerm()
voiddefinedTerm_()
voiddefinitionList()
voiddefinitionList_()
protected static Stringescaped(String text)
Escapes special characters.
voidfigure()
voidfigureCaption()
voidfigureCaption_()
voidfigureGraphics(String name)
voidfigure_()
voidflush()
static InputStreamgetDefaultPreamble()
Returns the default preamble from a resource.
static InputStreamgetDefaultSinkCommands()
Returns the default sink commands from a resource.
protected StringgetDocumentBegin()
Returns a default \begin{document} declaration.
protected StringgetDocumentEnd()
Returns a default \end{document} declaration.
protected StringgetDocumentStart()
Returns a default \documentclass declaration.
voidhead()
voidhorizontalRule()
voiditalic()
voiditalic_()
voidlineBreak()
voidlink(String name)
voidlink_()
voidlist()
voidlistItem()
voidlist_()
protected voidmarkup(String text)
Writes the text, preserving whitespace.
voidmonospaced()
voidmonospaced_()
voidnonBreakingSpace()
voidnumberedList(int numbering)
voidnumberedListItem()
voidnumberedList_()
voidpageBreak()
voidparagraph_()
voidsectionTitle1()
voidsectionTitle1_()
voidsectionTitle2()
voidsectionTitle2_()
voidsectionTitle3()
voidsectionTitle3_()
voidsectionTitle4()
voidsectionTitle4_()
voidsectionTitle5()
voidsectionTitle5_()
voidsectionTitle_()
voidtable()
voidtableCaption()
voidtableCaption_()
voidtableCell()
voidtableCell(boolean header)
Starts a table cell.
voidtableCell_()
voidtableCell_(boolean header)
Ends a table cell.
voidtableHeaderCell()
voidtableHeaderCell_()
voidtableRow()
voidtableRows(int[] justification, boolean grid)
voidtableRows_()
voidtableRow_()
voidtable_()
voidtext(String text)
voidtitle()
voidtitle_()
voidverbatim(boolean boxed)
protected voidverbatimContent(String text)
Writes the text, preserving whitespace.
voidverbatim_()

Constructor Detail

LatexSink

public LatexSink(Writer out)
Constructor.

Parameters: out The writer to use.

LatexSink

public LatexSink(Writer out, String sinkCommands, String preamble)
Constructor.

Parameters: out The writer to use. sinkCommands A String representation of commands that go before \documentclass. preamble A String representation of commands that go between \documentclass and \begin{document}.

LatexSink

public LatexSink(Writer out, String sinkCommands, String preamble, boolean fragmentDocument)
Constructor.

Parameters: out The writer to use. sinkCommands A String representation of commands that go before \documentclass. preamble A String representation of commands that go between \documentclass and \begin{document}. fragmentDocument If this receives events that that are only part of a document. Typically, headers are omitted if this is true.

Method Detail

anchor

public void anchor(String name)
{@inheritDoc }

anchor_

public void anchor_()
{@inheritDoc }

author

public void author()
{@inheritDoc }

author_

public void author_()
{@inheritDoc }

body

public void body()
{@inheritDoc }

body_

public void body_()
{@inheritDoc }

bold

public void bold()
{@inheritDoc }

bold_

public void bold_()
{@inheritDoc }

close

public void close()
{@inheritDoc }

content

protected void content(String text)
Writes the text, without preserving whitespace.

Parameters: text the text to write.

date

public void date()
{@inheritDoc }

date_

public void date_()
{@inheritDoc }

defaultPreamble

public static String defaultPreamble()
Returns the default preamble.

Returns: String.

defaultSinkCommands

public static String defaultSinkCommands()
Returns the default sink commands.

Returns: String.

definedTerm

public void definedTerm()
{@inheritDoc }

definedTerm_

public void definedTerm_()
{@inheritDoc }

definitionList

public void definitionList()
{@inheritDoc }

definitionList_

public void definitionList_()
{@inheritDoc }

escaped

protected static String escaped(String text)
Escapes special characters.

Parameters: text The text to escape.

Returns: The text with special characters replaced.

figure

public void figure()
{@inheritDoc }

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 }

getDefaultPreamble

public static InputStream getDefaultPreamble()
Returns the default preamble from a resource.

Returns: InputStream

Throws: java.io.IOException if the resource file cannot be read.

getDefaultSinkCommands

public static InputStream getDefaultSinkCommands()
Returns the default sink commands from a resource.

Returns: InputStream

Throws: java.io.IOException if the resource file cannot be read.

getDocumentBegin

protected String getDocumentBegin()
Returns a default \begin{document} declaration.

Returns: String.

getDocumentEnd

protected String getDocumentEnd()
Returns a default \end{document} declaration.

Returns: String.

getDocumentStart

protected String getDocumentStart()
Returns a default \documentclass declaration.

Returns: String.

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

list

public void list()
{@inheritDoc }

listItem

public void listItem()
{@inheritDoc }

list_

public void list_()
{@inheritDoc }

markup

protected void markup(String text)
Writes the text, preserving whitespace.

Parameters: text the text to write.

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 }

numberedList_

public void numberedList_()
{@inheritDoc }

pageBreak

public void pageBreak()
{@inheritDoc }

paragraph_

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

sectionTitle_

public void sectionTitle_()
{@inheritDoc }

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 header)
Starts a table cell.

Parameters: header True if this is a header cell.

tableCell_

public void tableCell_()
{@inheritDoc }

tableCell_

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

Parameters: header True if this is a header cell.

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 }

title_

public void title_()
{@inheritDoc }

verbatim

public void verbatim(boolean boxed)
{@inheritDoc }

verbatimContent

protected void verbatimContent(String text)
Writes the text, preserving whitespace.

Parameters: text the text to write.

verbatim_

public void verbatim_()
{@inheritDoc }
Copyright © 2002-2010 Apache Software Foundation. All Rights Reserved.