|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.maven.doxia.sink.SinkAdapter
org.apache.maven.doxia.sink.AbstractTextSink
org.apache.maven.doxia.module.latex.LatexSink
public class LatexSink
Latex Sink implementation.
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 |
---|
public LatexSink(java.io.Writer out)
out
- The writer to use.public LatexSink(java.io.Writer out, java.lang.String sinkCommands, java.lang.String preamble)
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}.public LatexSink(java.io.Writer out, java.lang.String sinkCommands, java.lang.String preamble, boolean fragmentDocument)
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 |
---|
protected java.lang.String getDocumentStart()
protected java.lang.String getDocumentBegin()
protected java.lang.String getDocumentEnd()
public void head()
head
in interface org.apache.maven.doxia.sink.Sink
head
in class org.apache.maven.doxia.sink.SinkAdapter
public void body()
body
in interface org.apache.maven.doxia.sink.Sink
body
in class org.apache.maven.doxia.sink.SinkAdapter
public void body_()
body_
in interface org.apache.maven.doxia.sink.Sink
body_
in class org.apache.maven.doxia.sink.SinkAdapter
public void sectionTitle1()
sectionTitle1
in interface org.apache.maven.doxia.sink.Sink
sectionTitle1
in class org.apache.maven.doxia.sink.SinkAdapter
public void sectionTitle1_()
sectionTitle1_
in interface org.apache.maven.doxia.sink.Sink
sectionTitle1_
in class org.apache.maven.doxia.sink.SinkAdapter
public void sectionTitle2()
sectionTitle2
in interface org.apache.maven.doxia.sink.Sink
sectionTitle2
in class org.apache.maven.doxia.sink.SinkAdapter
public void sectionTitle2_()
sectionTitle2_
in interface org.apache.maven.doxia.sink.Sink
sectionTitle2_
in class org.apache.maven.doxia.sink.SinkAdapter
public void sectionTitle3()
sectionTitle3
in interface org.apache.maven.doxia.sink.Sink
sectionTitle3
in class org.apache.maven.doxia.sink.SinkAdapter
public void sectionTitle3_()
sectionTitle3_
in interface org.apache.maven.doxia.sink.Sink
sectionTitle3_
in class org.apache.maven.doxia.sink.SinkAdapter
public void sectionTitle4()
sectionTitle4
in interface org.apache.maven.doxia.sink.Sink
sectionTitle4
in class org.apache.maven.doxia.sink.SinkAdapter
public void sectionTitle4_()
sectionTitle4_
in interface org.apache.maven.doxia.sink.Sink
sectionTitle4_
in class org.apache.maven.doxia.sink.SinkAdapter
public void sectionTitle5()
sectionTitle5
in interface org.apache.maven.doxia.sink.Sink
sectionTitle5
in class org.apache.maven.doxia.sink.SinkAdapter
public void sectionTitle5_()
sectionTitle5_
in interface org.apache.maven.doxia.sink.Sink
sectionTitle5_
in class org.apache.maven.doxia.sink.SinkAdapter
public void list()
list
in interface org.apache.maven.doxia.sink.Sink
list
in class org.apache.maven.doxia.sink.SinkAdapter
public void list_()
list_
in interface org.apache.maven.doxia.sink.Sink
list_
in class org.apache.maven.doxia.sink.SinkAdapter
public void listItem()
listItem
in interface org.apache.maven.doxia.sink.Sink
listItem
in class org.apache.maven.doxia.sink.SinkAdapter
public void numberedList(int numbering)
numberedList
in interface org.apache.maven.doxia.sink.Sink
numberedList
in class org.apache.maven.doxia.sink.SinkAdapter
public void numberedList_()
numberedList_
in interface org.apache.maven.doxia.sink.Sink
numberedList_
in class org.apache.maven.doxia.sink.SinkAdapter
public void numberedListItem()
numberedListItem
in interface org.apache.maven.doxia.sink.Sink
numberedListItem
in class org.apache.maven.doxia.sink.SinkAdapter
public void definitionList()
definitionList
in interface org.apache.maven.doxia.sink.Sink
definitionList
in class org.apache.maven.doxia.sink.SinkAdapter
public void definitionList_()
definitionList_
in interface org.apache.maven.doxia.sink.Sink
definitionList_
in class org.apache.maven.doxia.sink.SinkAdapter
public void figure()
figure
in interface org.apache.maven.doxia.sink.Sink
figure
in class org.apache.maven.doxia.sink.SinkAdapter
public void figure_()
figure_
in interface org.apache.maven.doxia.sink.Sink
figure_
in class org.apache.maven.doxia.sink.SinkAdapter
public void table()
table
in interface org.apache.maven.doxia.sink.Sink
table
in class org.apache.maven.doxia.sink.SinkAdapter
public void table_()
table_
in interface org.apache.maven.doxia.sink.Sink
table_
in class org.apache.maven.doxia.sink.SinkAdapter
public void tableRows(int[] justification, boolean grid)
tableRows
in interface org.apache.maven.doxia.sink.Sink
tableRows
in class org.apache.maven.doxia.sink.SinkAdapter
public void tableRows_()
tableRows_
in interface org.apache.maven.doxia.sink.Sink
tableRows_
in class org.apache.maven.doxia.sink.SinkAdapter
public void tableRow()
tableRow
in interface org.apache.maven.doxia.sink.Sink
tableRow
in class org.apache.maven.doxia.sink.SinkAdapter
public void tableRow_()
tableRow_
in interface org.apache.maven.doxia.sink.Sink
tableRow_
in class org.apache.maven.doxia.sink.SinkAdapter
public void title()
title
in interface org.apache.maven.doxia.sink.Sink
title
in class org.apache.maven.doxia.sink.SinkAdapter
public void title_()
title_
in interface org.apache.maven.doxia.sink.Sink
title_
in class org.apache.maven.doxia.sink.SinkAdapter
public void author()
author
in interface org.apache.maven.doxia.sink.Sink
author
in class org.apache.maven.doxia.sink.SinkAdapter
public void author_()
author_
in interface org.apache.maven.doxia.sink.Sink
author_
in class org.apache.maven.doxia.sink.SinkAdapter
public void date()
date
in interface org.apache.maven.doxia.sink.Sink
date
in class org.apache.maven.doxia.sink.SinkAdapter
public void date_()
date_
in interface org.apache.maven.doxia.sink.Sink
date_
in class org.apache.maven.doxia.sink.SinkAdapter
public void sectionTitle_()
sectionTitle_
in interface org.apache.maven.doxia.sink.Sink
sectionTitle_
in class org.apache.maven.doxia.sink.SinkAdapter
public void paragraph_()
paragraph_
in interface org.apache.maven.doxia.sink.Sink
paragraph_
in class org.apache.maven.doxia.sink.SinkAdapter
public void verbatim(boolean boxed)
verbatim
in interface org.apache.maven.doxia.sink.Sink
verbatim
in class org.apache.maven.doxia.sink.SinkAdapter
public void verbatim_()
verbatim_
in interface org.apache.maven.doxia.sink.Sink
verbatim_
in class org.apache.maven.doxia.sink.SinkAdapter
public void definedTerm()
definedTerm
in interface org.apache.maven.doxia.sink.Sink
definedTerm
in class org.apache.maven.doxia.sink.SinkAdapter
public void definedTerm_()
definedTerm_
in interface org.apache.maven.doxia.sink.Sink
definedTerm_
in class org.apache.maven.doxia.sink.SinkAdapter
public void figureCaption()
figureCaption
in interface org.apache.maven.doxia.sink.Sink
figureCaption
in class org.apache.maven.doxia.sink.SinkAdapter
public void figureCaption_()
figureCaption_
in interface org.apache.maven.doxia.sink.Sink
figureCaption_
in class org.apache.maven.doxia.sink.SinkAdapter
public void tableCell()
tableCell
in interface org.apache.maven.doxia.sink.Sink
tableCell
in class org.apache.maven.doxia.sink.SinkAdapter
public void tableCell_()
tableCell_
in interface org.apache.maven.doxia.sink.Sink
tableCell_
in class org.apache.maven.doxia.sink.SinkAdapter
public void tableHeaderCell()
tableHeaderCell
in interface org.apache.maven.doxia.sink.Sink
tableHeaderCell
in class org.apache.maven.doxia.sink.SinkAdapter
public void tableHeaderCell_()
tableHeaderCell_
in interface org.apache.maven.doxia.sink.Sink
tableHeaderCell_
in class org.apache.maven.doxia.sink.SinkAdapter
public void tableCell(boolean header)
header
- True if this is a header cell.public void tableCell_(boolean header)
header
- True if this is a header cell.public void tableCaption()
tableCaption
in interface org.apache.maven.doxia.sink.Sink
tableCaption
in class org.apache.maven.doxia.sink.SinkAdapter
public void tableCaption_()
tableCaption_
in interface org.apache.maven.doxia.sink.Sink
tableCaption_
in class org.apache.maven.doxia.sink.SinkAdapter
public void figureGraphics(java.lang.String name)
figureGraphics
in interface org.apache.maven.doxia.sink.Sink
figureGraphics
in class org.apache.maven.doxia.sink.SinkAdapter
public void horizontalRule()
horizontalRule
in interface org.apache.maven.doxia.sink.Sink
horizontalRule
in class org.apache.maven.doxia.sink.SinkAdapter
public void pageBreak()
pageBreak
in interface org.apache.maven.doxia.sink.Sink
pageBreak
in class org.apache.maven.doxia.sink.SinkAdapter
public void anchor(java.lang.String name)
anchor
in interface org.apache.maven.doxia.sink.Sink
anchor
in class org.apache.maven.doxia.sink.SinkAdapter
public void anchor_()
anchor_
in interface org.apache.maven.doxia.sink.Sink
anchor_
in class org.apache.maven.doxia.sink.SinkAdapter
public void link(java.lang.String name)
link
in interface org.apache.maven.doxia.sink.Sink
link
in class org.apache.maven.doxia.sink.SinkAdapter
public void link_()
link_
in interface org.apache.maven.doxia.sink.Sink
link_
in class org.apache.maven.doxia.sink.SinkAdapter
public void italic()
italic
in interface org.apache.maven.doxia.sink.Sink
italic
in class org.apache.maven.doxia.sink.SinkAdapter
public void italic_()
italic_
in interface org.apache.maven.doxia.sink.Sink
italic_
in class org.apache.maven.doxia.sink.SinkAdapter
public void bold()
bold
in interface org.apache.maven.doxia.sink.Sink
bold
in class org.apache.maven.doxia.sink.SinkAdapter
public void bold_()
bold_
in interface org.apache.maven.doxia.sink.Sink
bold_
in class org.apache.maven.doxia.sink.SinkAdapter
public void monospaced()
monospaced
in interface org.apache.maven.doxia.sink.Sink
monospaced
in class org.apache.maven.doxia.sink.SinkAdapter
public void monospaced_()
monospaced_
in interface org.apache.maven.doxia.sink.Sink
monospaced_
in class org.apache.maven.doxia.sink.SinkAdapter
public void lineBreak()
lineBreak
in interface org.apache.maven.doxia.sink.Sink
lineBreak
in class org.apache.maven.doxia.sink.SinkAdapter
public void nonBreakingSpace()
nonBreakingSpace
in interface org.apache.maven.doxia.sink.Sink
nonBreakingSpace
in class org.apache.maven.doxia.sink.SinkAdapter
public void text(java.lang.String text)
text
in interface org.apache.maven.doxia.sink.Sink
text
in class org.apache.maven.doxia.sink.SinkAdapter
protected void markup(java.lang.String text)
text
- the text to write.protected void content(java.lang.String text)
text
- the text to write.protected void verbatimContent(java.lang.String text)
text
- the text to write.protected static java.lang.String escaped(java.lang.String text)
text
- The text to escape.
public void flush()
flush
in interface org.apache.maven.doxia.sink.Sink
flush
in class org.apache.maven.doxia.sink.SinkAdapter
public void close()
close
in interface org.apache.maven.doxia.sink.Sink
close
in class org.apache.maven.doxia.sink.SinkAdapter
public static java.io.InputStream getDefaultSinkCommands() throws java.io.IOException
java.io.IOException
- if the resource file cannot be read.public static java.io.InputStream getDefaultPreamble() throws java.io.IOException
java.io.IOException
- if the resource file cannot be read.public static java.lang.String defaultSinkCommands()
public static java.lang.String defaultPreamble()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |