org.apache.maven.doxia.module.latex
Class LatexSink

java.lang.Object
  extended by org.apache.maven.doxia.sink.SinkAdapter
      extended by org.apache.maven.doxia.sink.AbstractTextSink
          extended by org.apache.maven.doxia.module.latex.LatexSink
All Implemented Interfaces:
org.apache.maven.doxia.markup.Markup, org.apache.maven.doxia.markup.TextMarkup, org.apache.maven.doxia.sink.Sink

public class LatexSink
extends org.apache.maven.doxia.sink.AbstractTextSink

Latex Sink implementation.

Since:
1.0

Field Summary
 
Fields inherited from interface org.apache.maven.doxia.markup.TextMarkup
PIPE
 
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
LatexSink(java.io.Writer out)
          Constructor.
LatexSink(java.io.Writer out, java.lang.String sinkCommands, java.lang.String preamble)
          Constructor.
LatexSink(java.io.Writer out, java.lang.String sinkCommands, java.lang.String preamble, boolean fragmentDocument)
          Constructor.
 
Method Summary
 void anchor_()
          
 void anchor(java.lang.String name)
          
 void author_()
          
 void author()
          
 void body_()
          
 void body()
          
 void bold_()
          
 void bold()
          
 void close()
          
protected  void content(java.lang.String text)
          Writes the text, without preserving whitespace.
 void date_()
          
 void date()
          
static java.lang.String defaultPreamble()
          Returns the default preamble.
static java.lang.String defaultSinkCommands()
          Returns the default sink commands.
 void definedTerm_()
          
 void definedTerm()
          
 void definitionList_()
          
 void definitionList()
          
protected static java.lang.String escaped(java.lang.String text)
          Escapes special characters.
 void figure_()
          
 void figure()
          
 void figureCaption_()
          
 void figureCaption()
          
 void figureGraphics(java.lang.String name)
          
 void flush()
          
static java.io.InputStream getDefaultPreamble()
          Returns the default preamble from a resource.
static java.io.InputStream getDefaultSinkCommands()
          Returns the default sink commands from a resource.
protected  java.lang.String getDocumentBegin()
          Returns a default \begin{document} declaration.
protected  java.lang.String getDocumentEnd()
          Returns a default \end{document} declaration.
protected  java.lang.String getDocumentStart()
          Returns a default \documentclass declaration.
 void head()
          
 void horizontalRule()
          
 void italic_()
          
 void italic()
          
 void lineBreak()
          
 void link_()
          
 void link(java.lang.String name)
          
 void list_()
          
 void list()
          
 void listItem()
          
protected  void markup(java.lang.String text)
          Writes the text, preserving whitespace.
 void monospaced_()
          
 void monospaced()
          
 void nonBreakingSpace()
          
 void numberedList_()
          
 void numberedList(int numbering)
          
 void numberedListItem()
          
 void pageBreak()
          
 void paragraph_()
          
 void sectionTitle_()
          
 void sectionTitle1_()
          
 void sectionTitle1()
          
 void sectionTitle2_()
          
 void sectionTitle2()
          
 void sectionTitle3_()
          
 void sectionTitle3()
          
 void sectionTitle4_()
          
 void sectionTitle4()
          
 void sectionTitle5_()
          
 void sectionTitle5()
          
 void table_()
          
 void table()
          
 void tableCaption_()
          
 void tableCaption()
          
 void tableCell_()
          
 void tableCell_(boolean header)
          Ends a table cell.
 void tableCell()
          
 void tableCell(boolean header)
          Starts a table cell.
 void tableHeaderCell_()
          
 void tableHeaderCell()
          
 void tableRow_()
          
 void tableRow()
          
 void tableRows_()
          
 void tableRows(int[] justification, boolean grid)
          
 void text(java.lang.String text)
          
 void title_()
          
 void title()
          
 void verbatim_()
          
 void verbatim(boolean boxed)
          
protected  void verbatimContent(java.lang.String text)
          Writes the text, preserving whitespace.
 
Methods inherited from class org.apache.maven.doxia.sink.SinkAdapter
definition_, definition, definitionListItem_, definitionListItem, head_, listItem_, numberedListItem_, paragraph, rawText, section1_, section1, section2_, section2, section3_, section3, section4_, section4, section5_, section5, sectionTitle, tableCell, tableHeaderCell
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LatexSink

public LatexSink(java.io.Writer out)
Constructor.

Parameters:
out - The writer to use.

LatexSink

public LatexSink(java.io.Writer out,
                 java.lang.String sinkCommands,
                 java.lang.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(java.io.Writer out,
                 java.lang.String sinkCommands,
                 java.lang.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

getDocumentStart

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

Returns:
String.

getDocumentBegin

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

Returns:
String.

getDocumentEnd

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

Returns:
String.

head

public void head()

Specified by:
head in interface org.apache.maven.doxia.sink.Sink
Overrides:
head in class org.apache.maven.doxia.sink.SinkAdapter

body

public void body()

Specified by:
body in interface org.apache.maven.doxia.sink.Sink
Overrides:
body in class org.apache.maven.doxia.sink.SinkAdapter

body_

public void body_()

Specified by:
body_ in interface org.apache.maven.doxia.sink.Sink
Overrides:
body_ in class org.apache.maven.doxia.sink.SinkAdapter

sectionTitle1

public void sectionTitle1()

Specified by:
sectionTitle1 in interface org.apache.maven.doxia.sink.Sink
Overrides:
sectionTitle1 in class org.apache.maven.doxia.sink.SinkAdapter

sectionTitle1_

public void sectionTitle1_()

Specified by:
sectionTitle1_ in interface org.apache.maven.doxia.sink.Sink
Overrides:
sectionTitle1_ in class org.apache.maven.doxia.sink.SinkAdapter

sectionTitle2

public void sectionTitle2()

Specified by:
sectionTitle2 in interface org.apache.maven.doxia.sink.Sink
Overrides:
sectionTitle2 in class org.apache.maven.doxia.sink.SinkAdapter

sectionTitle2_

public void sectionTitle2_()

Specified by:
sectionTitle2_ in interface org.apache.maven.doxia.sink.Sink
Overrides:
sectionTitle2_ in class org.apache.maven.doxia.sink.SinkAdapter

sectionTitle3

public void sectionTitle3()

Specified by:
sectionTitle3 in interface org.apache.maven.doxia.sink.Sink
Overrides:
sectionTitle3 in class org.apache.maven.doxia.sink.SinkAdapter

sectionTitle3_

public void sectionTitle3_()

Specified by:
sectionTitle3_ in interface org.apache.maven.doxia.sink.Sink
Overrides:
sectionTitle3_ in class org.apache.maven.doxia.sink.SinkAdapter

sectionTitle4

public void sectionTitle4()

Specified by:
sectionTitle4 in interface org.apache.maven.doxia.sink.Sink
Overrides:
sectionTitle4 in class org.apache.maven.doxia.sink.SinkAdapter

sectionTitle4_

public void sectionTitle4_()

Specified by:
sectionTitle4_ in interface org.apache.maven.doxia.sink.Sink
Overrides:
sectionTitle4_ in class org.apache.maven.doxia.sink.SinkAdapter

sectionTitle5

public void sectionTitle5()

Specified by:
sectionTitle5 in interface org.apache.maven.doxia.sink.Sink
Overrides:
sectionTitle5 in class org.apache.maven.doxia.sink.SinkAdapter

sectionTitle5_

public void sectionTitle5_()

Specified by:
sectionTitle5_ in interface org.apache.maven.doxia.sink.Sink
Overrides:
sectionTitle5_ in class org.apache.maven.doxia.sink.SinkAdapter

list

public void list()

Specified by:
list in interface org.apache.maven.doxia.sink.Sink
Overrides:
list in class org.apache.maven.doxia.sink.SinkAdapter

list_

public void list_()

Specified by:
list_ in interface org.apache.maven.doxia.sink.Sink
Overrides:
list_ in class org.apache.maven.doxia.sink.SinkAdapter

listItem

public void listItem()

Specified by:
listItem in interface org.apache.maven.doxia.sink.Sink
Overrides:
listItem in class org.apache.maven.doxia.sink.SinkAdapter

numberedList

public void numberedList(int numbering)

Specified by:
numberedList in interface org.apache.maven.doxia.sink.Sink
Overrides:
numberedList in class org.apache.maven.doxia.sink.SinkAdapter

numberedList_

public void numberedList_()

Specified by:
numberedList_ in interface org.apache.maven.doxia.sink.Sink
Overrides:
numberedList_ in class org.apache.maven.doxia.sink.SinkAdapter

numberedListItem

public void numberedListItem()

Specified by:
numberedListItem in interface org.apache.maven.doxia.sink.Sink
Overrides:
numberedListItem in class org.apache.maven.doxia.sink.SinkAdapter

definitionList

public void definitionList()

Specified by:
definitionList in interface org.apache.maven.doxia.sink.Sink
Overrides:
definitionList in class org.apache.maven.doxia.sink.SinkAdapter

definitionList_

public void definitionList_()

Specified by:
definitionList_ in interface org.apache.maven.doxia.sink.Sink
Overrides:
definitionList_ in class org.apache.maven.doxia.sink.SinkAdapter

figure

public void figure()

Specified by:
figure in interface org.apache.maven.doxia.sink.Sink
Overrides:
figure in class org.apache.maven.doxia.sink.SinkAdapter

figure_

public void figure_()

Specified by:
figure_ in interface org.apache.maven.doxia.sink.Sink
Overrides:
figure_ in class org.apache.maven.doxia.sink.SinkAdapter

table

public void table()

Specified by:
table in interface org.apache.maven.doxia.sink.Sink
Overrides:
table in class org.apache.maven.doxia.sink.SinkAdapter

table_

public void table_()

Specified by:
table_ in interface org.apache.maven.doxia.sink.Sink
Overrides:
table_ in class org.apache.maven.doxia.sink.SinkAdapter

tableRows

public void tableRows(int[] justification,
                      boolean grid)

Specified by:
tableRows in interface org.apache.maven.doxia.sink.Sink
Overrides:
tableRows in class org.apache.maven.doxia.sink.SinkAdapter

tableRows_

public void tableRows_()

Specified by:
tableRows_ in interface org.apache.maven.doxia.sink.Sink
Overrides:
tableRows_ in class org.apache.maven.doxia.sink.SinkAdapter

tableRow

public void tableRow()

Specified by:
tableRow in interface org.apache.maven.doxia.sink.Sink
Overrides:
tableRow in class org.apache.maven.doxia.sink.SinkAdapter

tableRow_

public void tableRow_()

Specified by:
tableRow_ in interface org.apache.maven.doxia.sink.Sink
Overrides:
tableRow_ in class org.apache.maven.doxia.sink.SinkAdapter

title

public void title()

Specified by:
title in interface org.apache.maven.doxia.sink.Sink
Overrides:
title in class org.apache.maven.doxia.sink.SinkAdapter

title_

public void title_()

Specified by:
title_ in interface org.apache.maven.doxia.sink.Sink
Overrides:
title_ in class org.apache.maven.doxia.sink.SinkAdapter

author

public void author()

Specified by:
author in interface org.apache.maven.doxia.sink.Sink
Overrides:
author in class org.apache.maven.doxia.sink.SinkAdapter

author_

public void author_()

Specified by:
author_ in interface org.apache.maven.doxia.sink.Sink
Overrides:
author_ in class org.apache.maven.doxia.sink.SinkAdapter

date

public void date()

Specified by:
date in interface org.apache.maven.doxia.sink.Sink
Overrides:
date in class org.apache.maven.doxia.sink.SinkAdapter

date_

public void date_()

Specified by:
date_ in interface org.apache.maven.doxia.sink.Sink
Overrides:
date_ in class org.apache.maven.doxia.sink.SinkAdapter

sectionTitle_

public void sectionTitle_()

Specified by:
sectionTitle_ in interface org.apache.maven.doxia.sink.Sink
Overrides:
sectionTitle_ in class org.apache.maven.doxia.sink.SinkAdapter

paragraph_

public void paragraph_()

Specified by:
paragraph_ in interface org.apache.maven.doxia.sink.Sink
Overrides:
paragraph_ in class org.apache.maven.doxia.sink.SinkAdapter

verbatim

public void verbatim(boolean boxed)

Specified by:
verbatim in interface org.apache.maven.doxia.sink.Sink
Overrides:
verbatim in class org.apache.maven.doxia.sink.SinkAdapter

verbatim_

public void verbatim_()

Specified by:
verbatim_ in interface org.apache.maven.doxia.sink.Sink
Overrides:
verbatim_ in class org.apache.maven.doxia.sink.SinkAdapter

definedTerm

public void definedTerm()

Specified by:
definedTerm in interface org.apache.maven.doxia.sink.Sink
Overrides:
definedTerm in class org.apache.maven.doxia.sink.SinkAdapter

definedTerm_

public void definedTerm_()

Specified by:
definedTerm_ in interface org.apache.maven.doxia.sink.Sink
Overrides:
definedTerm_ in class org.apache.maven.doxia.sink.SinkAdapter

figureCaption

public void figureCaption()

Specified by:
figureCaption in interface org.apache.maven.doxia.sink.Sink
Overrides:
figureCaption in class org.apache.maven.doxia.sink.SinkAdapter

figureCaption_

public void figureCaption_()

Specified by:
figureCaption_ in interface org.apache.maven.doxia.sink.Sink
Overrides:
figureCaption_ in class org.apache.maven.doxia.sink.SinkAdapter

tableCell

public void tableCell()

Specified by:
tableCell in interface org.apache.maven.doxia.sink.Sink
Overrides:
tableCell in class org.apache.maven.doxia.sink.SinkAdapter

tableCell_

public void tableCell_()

Specified by:
tableCell_ in interface org.apache.maven.doxia.sink.Sink
Overrides:
tableCell_ in class org.apache.maven.doxia.sink.SinkAdapter

tableHeaderCell

public void tableHeaderCell()

Specified by:
tableHeaderCell in interface org.apache.maven.doxia.sink.Sink
Overrides:
tableHeaderCell in class org.apache.maven.doxia.sink.SinkAdapter

tableHeaderCell_

public void tableHeaderCell_()

Specified by:
tableHeaderCell_ in interface org.apache.maven.doxia.sink.Sink
Overrides:
tableHeaderCell_ in class org.apache.maven.doxia.sink.SinkAdapter

tableCell

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

Parameters:
header - True if this is a header cell.

tableCell_

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

Parameters:
header - True if this is a header cell.

tableCaption

public void tableCaption()

Specified by:
tableCaption in interface org.apache.maven.doxia.sink.Sink
Overrides:
tableCaption in class org.apache.maven.doxia.sink.SinkAdapter

tableCaption_

public void tableCaption_()

Specified by:
tableCaption_ in interface org.apache.maven.doxia.sink.Sink
Overrides:
tableCaption_ in class org.apache.maven.doxia.sink.SinkAdapter

figureGraphics

public void figureGraphics(java.lang.String name)

Specified by:
figureGraphics in interface org.apache.maven.doxia.sink.Sink
Overrides:
figureGraphics in class org.apache.maven.doxia.sink.SinkAdapter

horizontalRule

public void horizontalRule()

Specified by:
horizontalRule in interface org.apache.maven.doxia.sink.Sink
Overrides:
horizontalRule in class org.apache.maven.doxia.sink.SinkAdapter

pageBreak

public void pageBreak()

Specified by:
pageBreak in interface org.apache.maven.doxia.sink.Sink
Overrides:
pageBreak in class org.apache.maven.doxia.sink.SinkAdapter

anchor

public void anchor(java.lang.String name)

Specified by:
anchor in interface org.apache.maven.doxia.sink.Sink
Overrides:
anchor in class org.apache.maven.doxia.sink.SinkAdapter

anchor_

public void anchor_()

Specified by:
anchor_ in interface org.apache.maven.doxia.sink.Sink
Overrides:
anchor_ in class org.apache.maven.doxia.sink.SinkAdapter

link

public void link(java.lang.String name)

Specified by:
link in interface org.apache.maven.doxia.sink.Sink
Overrides:
link in class org.apache.maven.doxia.sink.SinkAdapter

link_

public void link_()

Specified by:
link_ in interface org.apache.maven.doxia.sink.Sink
Overrides:
link_ in class org.apache.maven.doxia.sink.SinkAdapter

italic

public void italic()

Specified by:
italic in interface org.apache.maven.doxia.sink.Sink
Overrides:
italic in class org.apache.maven.doxia.sink.SinkAdapter

italic_

public void italic_()

Specified by:
italic_ in interface org.apache.maven.doxia.sink.Sink
Overrides:
italic_ in class org.apache.maven.doxia.sink.SinkAdapter

bold

public void bold()

Specified by:
bold in interface org.apache.maven.doxia.sink.Sink
Overrides:
bold in class org.apache.maven.doxia.sink.SinkAdapter

bold_

public void bold_()

Specified by:
bold_ in interface org.apache.maven.doxia.sink.Sink
Overrides:
bold_ in class org.apache.maven.doxia.sink.SinkAdapter

monospaced

public void monospaced()

Specified by:
monospaced in interface org.apache.maven.doxia.sink.Sink
Overrides:
monospaced in class org.apache.maven.doxia.sink.SinkAdapter

monospaced_

public void monospaced_()

Specified by:
monospaced_ in interface org.apache.maven.doxia.sink.Sink
Overrides:
monospaced_ in class org.apache.maven.doxia.sink.SinkAdapter

lineBreak

public void lineBreak()

Specified by:
lineBreak in interface org.apache.maven.doxia.sink.Sink
Overrides:
lineBreak in class org.apache.maven.doxia.sink.SinkAdapter

nonBreakingSpace

public void nonBreakingSpace()

Specified by:
nonBreakingSpace in interface org.apache.maven.doxia.sink.Sink
Overrides:
nonBreakingSpace in class org.apache.maven.doxia.sink.SinkAdapter

text

public void text(java.lang.String text)

Specified by:
text in interface org.apache.maven.doxia.sink.Sink
Overrides:
text in class org.apache.maven.doxia.sink.SinkAdapter

markup

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

Parameters:
text - the text to write.

content

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

Parameters:
text - the text to write.

verbatimContent

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

Parameters:
text - the text to write.

escaped

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

Parameters:
text - The text to escape.
Returns:
The text with special characters replaced.

flush

public void flush()

Specified by:
flush in interface org.apache.maven.doxia.sink.Sink
Overrides:
flush in class org.apache.maven.doxia.sink.SinkAdapter

close

public void close()

Specified by:
close in interface org.apache.maven.doxia.sink.Sink
Overrides:
close in class org.apache.maven.doxia.sink.SinkAdapter

getDefaultSinkCommands

public static java.io.InputStream getDefaultSinkCommands()
                                                  throws java.io.IOException
Returns the default sink commands from a resource.

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

getDefaultPreamble

public static java.io.InputStream getDefaultPreamble()
                                              throws java.io.IOException
Returns the default preamble from a resource.

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

defaultSinkCommands

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

Returns:
String.

defaultPreamble

public static java.lang.String defaultPreamble()
Returns the default preamble.

Returns:
String.


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