org.apache.maven.doxia.book.services.renderer.latex
Class LatexBookSink

java.lang.Object
  extended by org.apache.maven.doxia.sink.AbstractSink
      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
                  extended by org.apache.maven.doxia.book.services.renderer.latex.LatexBookSink
All Implemented Interfaces:
LogEnabled, Markup, TextMarkup, Sink

public class LatexBookSink
extends LatexSink

LatexBookSink class.

Version:
$Id: LatexBookSink.java 769433 2009-04-28 15:26:55Z ltheussl $
Author:
Trygve Laugstøl

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
LatexBookSink(java.io.Writer out)
          Construct a new LatexBookSink which is a LatexSink with the given writer, null sinkCommands, null preamble and fragmentDocument = true.
 
Method Summary
 void defaultBookPreamble()
          Writes the default LaTeX commands and preamble in the main book file.
protected  java.lang.String getDocumentBegin()
          Returns a default \begin{document} declaration.
protected  java.lang.String getDocumentStart()
          Returns a default \documentclass declaration.
 java.lang.String getTitle()
          Return the title.
 void text(java.lang.String text)
          Adding a text.
 void title_()
          Ends the title element.
 
Methods inherited from class org.apache.maven.doxia.module.latex.LatexSink
anchor_, anchor, anchor, author_, author, author, body_, body, body, bold_, bold, close, comment, content, date_, date, date, defaultPreamble, defaultSinkCommands, definedTerm_, definedTerm, definedTerm, definition_, definition, definition, definitionList_, definitionList, definitionList, definitionListItem_, definitionListItem, definitionListItem, escaped, figure_, figure, figure, figureCaption_, figureCaption, figureCaption, figureGraphics, figureGraphics, flush, getDocumentEnd, head, head, horizontalRule, horizontalRule, init, italic_, italic, lineBreak, lineBreak, link_, link, link, list_, list, list, listItem, listItem, markup, monospaced_, monospaced, nonBreakingSpace, numberedList_, numberedList, numberedList, numberedListItem, numberedListItem, pageBreak, paragraph_, paragraph, paragraph, rawText, sectionTitle_, sectionTitle, sectionTitle1_, sectionTitle1, sectionTitle2_, sectionTitle2, sectionTitle3_, sectionTitle3, sectionTitle4_, sectionTitle4, sectionTitle5_, sectionTitle5, table_, table, table, tableCaption_, tableCaption, tableCaption, tableCell_, tableCell, tableCell, tableCell, tableHeaderCell_, tableHeaderCell, tableHeaderCell, tableHeaderCell, tableRow_, tableRow, tableRow, tableRows_, tableRows, text, title, title, unknown, verbatim_, verbatim, verbatim, verbatimContent
 
Methods inherited from class org.apache.maven.doxia.sink.SinkAdapter
head_, listItem_, numberedListItem_, section_, section, section1_, section1, section2_, section2, section3_, section3, section4_, section4, section5_, section5, sectionTitle_, sectionTitle
 
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

LatexBookSink

public LatexBookSink(java.io.Writer out)
Construct a new LatexBookSink which is a LatexSink with the given writer, null sinkCommands, null preamble and fragmentDocument = true.

Parameters:
out - the writer for the sink.
Method Detail

getDocumentStart

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

Overrides:
getDocumentStart in class LatexSink
Returns:
String.

getDocumentBegin

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

Overrides:
getDocumentBegin in class LatexSink
Returns:
String.

text

public void text(java.lang.String text)
Adding a text.

Specified by:
text in interface Sink
Overrides:
text in class LatexSink
Parameters:
text - The text to write.
See Also:
Sink.text(String,SinkEventAttributes)

title_

public void title_()
Ends the title element.

Specified by:
title_ in interface Sink
Overrides:
title_ in class LatexSink

getTitle

public java.lang.String getTitle()
Return the title.

Returns:
String.

defaultBookPreamble

public void defaultBookPreamble()
Writes the default LaTeX commands and preamble in the main book file.

Since:
1.1


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