|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.maven.doxia.sink.AbstractSink
org.apache.maven.doxia.sink.SinkAdapter
org.apache.maven.doxia.sink.AbstractTextSink
org.apache.maven.doxia.module.latex.LatexSink
public class LatexSink
Latex Sink implementation.
Note: The encoding used is UTF-8.
Field Summary |
---|
Fields inherited from interface org.apache.maven.doxia.markup.TextMarkup |
---|
PIPE |
Fields inherited from interface org.apache.maven.doxia.markup.Markup |
---|
COLON, EOL, EQUAL, GREATER_THAN, LEFT_CURLY_BRACKET, LEFT_SQUARE_BRACKET, LESS_THAN, MINUS, PLUS, QUOTE, RIGHT_CURLY_BRACKET, RIGHT_SQUARE_BRACKET, SEMICOLON, SLASH, SPACE, STAR |
Fields inherited from interface org.apache.maven.doxia.sink.Sink |
---|
JUSTIFY_CENTER, JUSTIFY_LEFT, JUSTIFY_RIGHT, 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 | |
---|---|
protected |
LatexSink(java.io.Writer out)
Constructor, initialize the Writer and the variables. |
protected |
LatexSink(java.io.Writer out,
java.lang.String sinkCommands,
java.lang.String preamble)
Constructor, initialize the Writer and the variables. |
protected |
LatexSink(java.io.Writer out,
java.lang.String sinkCommands,
java.lang.String preamble,
boolean fragmentDocument)
Constructor, initialize the Writer and the variables. |
Method Summary | |
---|---|
void |
anchor_()
Ends an anchor element. |
void |
anchor(java.lang.String name)
Starts an element which defines an anchor. |
void |
author_()
Ends an author element. |
void |
author()
Starts an author element. |
void |
body_()
Ends the body element. |
void |
body()
Starts the body of a document. |
void |
bold_()
Ends a bold element. |
void |
bold()
Starts a bold element. |
void |
close()
Close the writer or the stream, if needed. |
protected void |
content(java.lang.String text)
Writes the text, without preserving whitespace. |
void |
date_()
Ends the date element. |
void |
date()
Starts the date element. |
protected java.lang.String |
defaultPreamble()
Returns the default preamble. |
protected java.lang.String |
defaultSinkCommands()
Returns the default sink commands. |
void |
definedTerm_()
Starts a definition term element within a definition list. |
void |
definedTerm()
Starts a definition term element within a definition list. |
void |
definitionList_()
Ends a definition list element. |
void |
definitionList()
Starts a definition list element. |
static java.lang.String |
escaped(java.lang.String text)
Escapes special characters. |
void |
figure_()
Ends a basic image embedding element. |
void |
figure()
Starts a basic image embedding element. |
void |
figureCaption_()
Ends a caption of an image. |
void |
figureCaption()
Starts a caption of an image element. |
void |
figureGraphics(java.lang.String name)
Adding a source of a graphic. |
void |
flush()
Flush the writer or the stream, if needed. |
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()
Starts the head element. |
void |
horizontalRule()
Adding a separator of sections from a text to each other. |
void |
italic_()
Ends an italic element. |
void |
italic()
Starts an italic element. |
void |
lineBreak()
Adds a line break. |
void |
link_()
Ends a link element. |
void |
link(java.lang.String name)
Starts an element which defines a link. |
void |
list_()
Ends an unordered list element. |
void |
list()
Starts an unordered list element. |
void |
listItem()
Starts a list item element within an unordered list. |
protected void |
markup(java.lang.String text)
Writes the text, preserving whitespace. |
void |
monospaced_()
Ends a monospaced element. |
void |
monospaced()
Starts a monospaced element. |
void |
nonBreakingSpace()
Adding a non breaking space, ie a space without any special formatting operations. |
void |
numberedList_()
Ends an ordered list element. |
void |
numberedList(int numbering)
Starts an ordered list element. |
void |
numberedListItem()
Starts a list item element within an ordered list. |
void |
pageBreak()
Adding a new page separator. |
void |
paragraph_()
Ends a paragraph element. |
void |
paragraph()
Starts an element which represents a paragraph. |
void |
sectionTitle1_()
Ends a first title heading element. |
void |
sectionTitle1()
Starts a first title heading element. |
void |
sectionTitle2_()
Ends a second title heading element. |
void |
sectionTitle2()
Starts a second title heading element. |
void |
sectionTitle3_()
Ends a third title heading element. |
void |
sectionTitle3()
Starts a third title heading element. |
void |
sectionTitle4_()
Ends a 4th title heading element. |
void |
sectionTitle4()
Starts a 4th title heading element. |
void |
sectionTitle5_()
Ends a 5th title heading element. |
void |
sectionTitle5()
Starts a 5th title heading element. |
void |
table_()
Ends a table element. |
void |
table()
Starts a table element for marking up tabular information in a document. |
void |
tableCaption_()
Ends a caption element of a table. |
void |
tableCaption()
Starts a caption element of a table. |
void |
tableCell_()
Ends a cell element. |
void |
tableCell()
Starts a cell element which defines a cell that contains data. |
void |
tableHeaderCell_()
Ends a cell header element. |
void |
tableHeaderCell()
Starts a cell element which defines a cell that contains header information. |
void |
tableRow_()
Ends a row element. |
void |
tableRow()
Starts a row element which acts as a container for a row of table cells. |
void |
tableRows_()
Ends an element that contains rows of table data. |
void |
tableRows(int[] justification,
boolean grid)
Starts an element that contains rows of table data. |
void |
text(java.lang.String text)
Adding a text. |
void |
title_()
Ends the title element. |
void |
title()
Starts the title element. |
void |
unknown(java.lang.String name,
java.lang.Object[] requiredParams,
SinkEventAttributes attributes)
Add an unkown event. |
void |
verbatim_()
Ends a verbatim element. |
void |
verbatim(boolean boxed)
Starts an element which indicates that whitespace in the enclosed text has semantic relevance. |
protected void |
verbatimContent(java.lang.String text)
Writes the text, preserving whitespace. |
Methods inherited from class org.apache.maven.doxia.sink.SinkAdapter |
---|
anchor, author, body, comment, date, definedTerm, definition_, definition, definition, definitionList, definitionListItem_, definitionListItem, definitionListItem, figure, figureCaption, figureGraphics, head_, head, horizontalRule, lineBreak, link, list, listItem_, listItem, numberedList, numberedListItem_, numberedListItem, paragraph, rawText, section_, section, section1_, section1, section2_, section2, section3_, section3, section4_, section4, section5_, section5, sectionTitle_, sectionTitle_, sectionTitle, sectionTitle, table, tableCaption, tableCell, tableCell, tableHeaderCell, tableHeaderCell, tableRow, text, title, verbatim |
Methods inherited from class org.apache.maven.doxia.sink.AbstractSink |
---|
enableLogging, getLog, unifyEOLs |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
protected LatexSink(java.io.Writer out)
out
- not null writer to write the result. Should be an UTF-8 Writer.
You could use newWriter
methods from org.codehaus.plexus.util.WriterFactory
.protected LatexSink(java.io.Writer out, java.lang.String sinkCommands, java.lang.String preamble)
out
- not null writer to write the result. Should be an UTF-8 Writer.
You could use newWriter
methods from org.codehaus.plexus.util.WriterFactory
.sinkCommands
- A String representation of commands that go before \documentclass.preamble
- A String representation of commands that go between \documentclass and \begin{document}.protected LatexSink(java.io.Writer out, java.lang.String sinkCommands, java.lang.String preamble, boolean fragmentDocument)
out
- not null writer to write the result. Should be an UTF-8 Writer.
You could use newWriter
methods from org.codehaus.plexus.util.WriterFactory
.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 Sink
head
in class SinkAdapter
Sink.head(SinkEventAttributes)
public void body()
body
in interface Sink
body
in class SinkAdapter
Sink.body(SinkEventAttributes)
public void body_()
body_
in interface Sink
body_
in class SinkAdapter
public void title()
title
in interface Sink
title
in class SinkAdapter
Sink.title(SinkEventAttributes)
public void title_()
title_
in interface Sink
title_
in class SinkAdapter
public void author()
author
in interface Sink
author
in class SinkAdapter
Sink.author(SinkEventAttributes)
public void author_()
author_
in interface Sink
author_
in class SinkAdapter
public void date()
YYYY-MM-DDwhere
date
in interface Sink
date
in class SinkAdapter
Sink.date(SinkEventAttributes)
public void date_()
date_
in interface Sink
date_
in class SinkAdapter
public void sectionTitle1()
Sink.section1()
element.
sectionTitle1
in interface Sink
sectionTitle1
in class SinkAdapter
Sink.sectionTitle(int,SinkEventAttributes)
public void sectionTitle1_()
sectionTitle1_
in interface Sink
sectionTitle1_
in class SinkAdapter
public void sectionTitle2()
Sink.section2()
element.
sectionTitle2
in interface Sink
sectionTitle2
in class SinkAdapter
Sink.sectionTitle(int,SinkEventAttributes)
public void sectionTitle2_()
sectionTitle2_
in interface Sink
sectionTitle2_
in class SinkAdapter
public void sectionTitle3()
Sink.section3()
element.
sectionTitle3
in interface Sink
sectionTitle3
in class SinkAdapter
Sink.sectionTitle(int,SinkEventAttributes)
public void sectionTitle3_()
sectionTitle3_
in interface Sink
sectionTitle3_
in class SinkAdapter
public void sectionTitle4()
Sink.section4()
element.
sectionTitle4
in interface Sink
sectionTitle4
in class SinkAdapter
Sink.sectionTitle(int,SinkEventAttributes)
public void sectionTitle4_()
sectionTitle4_
in interface Sink
sectionTitle4_
in class SinkAdapter
public void sectionTitle5()
Sink.section5()
element.
sectionTitle5
in interface Sink
sectionTitle5
in class SinkAdapter
Sink.sectionTitle(int,SinkEventAttributes)
public void sectionTitle5_()
sectionTitle5_
in interface Sink
sectionTitle5_
in class SinkAdapter
public void list()
list
in interface Sink
list
in class SinkAdapter
Sink.list(SinkEventAttributes)
public void list_()
list_
in interface Sink
list_
in class SinkAdapter
public void listItem()
listItem
in interface Sink
listItem
in class SinkAdapter
Sink.listItem(SinkEventAttributes)
public void numberedList(int numbering)
numberedList
in interface Sink
numberedList
in class SinkAdapter
numbering
- the numbering style.Sink.numberedList(int,SinkEventAttributes)
public void numberedList_()
numberedList_
in interface Sink
numberedList_
in class SinkAdapter
public void numberedListItem()
numberedListItem
in interface Sink
numberedListItem
in class SinkAdapter
Sink.numberedListItem(SinkEventAttributes)
public void definitionList()
definitionList
in interface Sink
definitionList
in class SinkAdapter
Sink.definitionList(SinkEventAttributes)
public void definitionList_()
definitionList_
in interface Sink
definitionList_
in class SinkAdapter
public void definedTerm()
definedTerm
in interface Sink
definedTerm
in class SinkAdapter
Sink.definedTerm(SinkEventAttributes)
public void definedTerm_()
definedTerm_
in interface Sink
definedTerm_
in class SinkAdapter
public void figure()
figure
in interface Sink
figure
in class SinkAdapter
Sink.figure(SinkEventAttributes)
public void figure_()
figure_
in interface Sink
figure_
in class SinkAdapter
public void figureGraphics(java.lang.String name)
figureGraphics
in interface Sink
figureGraphics
in class SinkAdapter
name
- the sourcepublic void figureCaption()
figureCaption
in interface Sink
figureCaption
in class SinkAdapter
Sink.figureCaption(SinkEventAttributes)
public void figureCaption_()
figureCaption_
in interface Sink
figureCaption_
in class SinkAdapter
public void table()
table
in interface Sink
table
in class SinkAdapter
Sink.table(SinkEventAttributes)
public void table_()
table_
in interface Sink
table_
in class SinkAdapter
public void tableRows(int[] justification, boolean grid)
tableRows
in interface Sink
tableRows
in class SinkAdapter
justification
- the default justification of columns.
This can be overridden by individual table rows or table cells.
If null a left alignment is assumed by default. If this array
has less elements than there are columns in the table then the value of
the last array element will be taken as default for the remaining table cells.grid
- true to provide a grid, false otherwise.Sink.table(SinkEventAttributes)
,
Sink.JUSTIFY_CENTER
,
Sink.JUSTIFY_LEFT
,
Sink.JUSTIFY_RIGHT
public void tableRows_()
tableRows_
in interface Sink
tableRows_
in class SinkAdapter
public void tableRow()
tableRow
in interface Sink
tableRow
in class SinkAdapter
Sink.tableRow(SinkEventAttributes)
public void tableRow_()
tableRow_
in interface Sink
tableRow_
in class SinkAdapter
public void tableCell()
tableCell
in interface Sink
tableCell
in class SinkAdapter
Sink.tableCell(SinkEventAttributes)
public void tableCell_()
tableCell_
in interface Sink
tableCell_
in class SinkAdapter
public void tableHeaderCell()
tableHeaderCell
in interface Sink
tableHeaderCell
in class SinkAdapter
Sink.tableHeaderCell(SinkEventAttributes)
public void tableHeaderCell_()
tableHeaderCell_
in interface Sink
tableHeaderCell_
in class SinkAdapter
public void tableCaption()
tableCaption
in interface Sink
tableCaption
in class SinkAdapter
Sink.tableCaption(SinkEventAttributes)
public void tableCaption_()
tableCaption_
in interface Sink
tableCaption_
in class SinkAdapter
public void paragraph()
paragraph
in interface Sink
paragraph
in class SinkAdapter
Sink.paragraph(SinkEventAttributes)
public void paragraph_()
paragraph_
in interface Sink
paragraph_
in class SinkAdapter
public void verbatim(boolean boxed)
verbatim
in interface Sink
verbatim
in class SinkAdapter
boxed
- true to add a box, false otherwisepublic void verbatim_()
verbatim_
in interface Sink
verbatim_
in class SinkAdapter
public void horizontalRule()
horizontalRule
in interface Sink
horizontalRule
in class SinkAdapter
Sink.horizontalRule(SinkEventAttributes)
public void pageBreak()
pageBreak
in interface Sink
pageBreak
in class SinkAdapter
public void anchor(java.lang.String name)
anchor
in interface Sink
anchor
in class SinkAdapter
name
- the name of the anchor.Sink.anchor(String,SinkEventAttributes)
public void anchor_()
anchor_
in interface Sink
anchor_
in class SinkAdapter
public void link(java.lang.String name)
link
in interface Sink
link
in class SinkAdapter
name
- the name of the link.Sink.link(String,SinkEventAttributes)
public void link_()
link_
in interface Sink
link_
in class SinkAdapter
public void italic()
Sink.text(String,SinkEventAttributes)
with
STYLE
instead.
italic
in interface Sink
italic
in class SinkAdapter
public void italic_()
Sink.text(String,SinkEventAttributes)
with
STYLE
instead.
italic_
in interface Sink
italic_
in class SinkAdapter
public void bold()
Sink.text(String,SinkEventAttributes)
with
STYLE
instead.
bold
in interface Sink
bold
in class SinkAdapter
public void bold_()
Sink.text(String,SinkEventAttributes)
with
STYLE
instead.
bold_
in interface Sink
bold_
in class SinkAdapter
public void monospaced()
Sink.text(String,SinkEventAttributes)
with
STYLE
instead.
monospaced
in interface Sink
monospaced
in class SinkAdapter
public void monospaced_()
Sink.text(String,SinkEventAttributes)
with
STYLE
instead.
monospaced_
in interface Sink
monospaced_
in class SinkAdapter
public void lineBreak()
lineBreak
in interface Sink
lineBreak
in class SinkAdapter
Sink.lineBreak(SinkEventAttributes)
public void nonBreakingSpace()
nonBreakingSpace
in interface Sink
nonBreakingSpace
in class SinkAdapter
public void text(java.lang.String text)
text
in interface Sink
text
in class SinkAdapter
text
- The text to write.Sink.text(String,SinkEventAttributes)
public void unknown(java.lang.String name, java.lang.Object[] requiredParams, SinkEventAttributes attributes)
unknown
in interface Sink
unknown
in class SinkAdapter
name
- The name of the event.requiredParams
- An optional array of required parameters to the event.
May be null
.attributes
- A set of SinkEventAttributes
, may be null
.Sink.unknown(String,Object[],SinkEventAttributes)
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.public static java.lang.String escaped(java.lang.String text)
text
- The text to escape.
public void flush()
flush
in interface Sink
flush
in class SinkAdapter
public void close()
close
in interface Sink
close
in class SinkAdapter
protected java.lang.String defaultSinkCommands()
protected java.lang.String defaultPreamble()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |