Class ITextSink
- java.lang.Object
-
- org.apache.maven.doxia.sink.impl.AbstractSink
-
- org.apache.maven.doxia.sink.impl.SinkAdapter
-
- org.apache.maven.doxia.sink.impl.AbstractXmlSink
-
- org.apache.maven.doxia.module.itext.ITextSink
-
- All Implemented Interfaces:
LogEnabled,Markup,XmlMarkup,Sink
public class ITextSink extends AbstractXmlSink
A doxia Sink which produces an XML Front End document for
Known limitations:iTextframework.- Roman lists are not supported.
- Horizontal rule is not supported with 1.3. See http://www.mail-archive.com/itext-questions@lists.sourceforge.net/msg10323.html
- iText has some problems with
ElementTags.TABLEandElementTags.TABLEFITSPAGE. See http://sourceforge.net/tracker/index.php?func=detail&aid=786427&group_id=15255&atid=115255. - Images could be on another page and next text on the last one.
- Version:
- $Id: ITextSink.java 1726411 2016-01-23 16:34:09Z hboutemy $
- Author:
- Vincent Siveton
- See Also:
- http://www.lowagie.com/iText/tutorial/ch07.html
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.StringDEFAULT_CHAPTER_TITLE_LEADINGThis is the default leading for chapter titlestatic java.lang.StringDEFAULT_SECTION_TITLE_LEADINGThis is the default leading for section titlestatic java.lang.StringDOCTYPEThis is the reference to the DTD.static java.lang.StringDTDThis is the place where the iText DTD is located.-
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, SECTION_LEVEL_6
-
Fields inherited from interface org.apache.maven.doxia.markup.XmlMarkup
BANG, CDATA, DOCTYPE_START, ENTITY_START, XML_NAMESPACE
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedITextSink(java.io.Writer writer)Constructor for ITextSink.protectedITextSink(java.io.Writer writer, java.lang.String encoding)Constructor for ITextSink.protectedITextSink(org.codehaus.plexus.util.xml.PrettyPrintXMLWriter xmlWriter)Constructor for ITextSink.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidanchor(java.lang.String name)Starts an element which defines an anchor.voidanchor_()Ends an anchor element.voidauthor()Starts an author element.voidauthor_()Ends an author element.voidbody()Starts the body of a document.voidbody_()Ends the body element.voidbold()Starts a bold element.voidbold_()Ends a bold element.voidclose()Close the writer or the stream, if needed.voiddate()Starts the date element.voiddate_()Ends the date element.voiddefinedTerm()Starts a definition term element within a definition list.voiddefinedTerm_()Starts a definition term element within a definition list.voiddefinition()Starts a definition element within a definition list.voiddefinition_()Ends a definition element within a definition list.voiddefinitionList()Starts a definition list element.voiddefinitionList_()Ends a definition list element.voiddefinitionListItem()Starts a list item element within a definition list.voiddefinitionListItem_()Ends a list item element within a definition list.voidfigure()Starts a basic image embedding element.voidfigure_()Ends a basic image embedding element.voidfigureCaption()Starts a caption of an image element.voidfigureCaption_()Ends a caption of an image.voidfigureGraphics(java.lang.String name)If thenameis a relative link, the internal link will used a System propertyitext.basedir, or the class loader.voidflush()Flush the writer or the stream, if needed.java.lang.ClassLoadergetClassLoader()Get the current classLoadervoidhead()Starts the head element.voidhead_()Ends the head element.voidhorizontalRule()Adding a separator of sections from a text to each other.protected voidinit()This is called inSink.head()or inSink.close(), and can be used to set the sink into a clear state so it can be re-used.voiditalic()Starts an italic element.voiditalic_()Ends an italic element.voidlineBreak()Adds a line break.voidlink(java.lang.String name)Starts an element which defines a link.voidlink_()Ends a link element.voidlist()Starts an unordered list element.voidlist_()Ends an unordered list element.voidlistItem()Starts a list item element within an unordered list.voidlistItem_()Ends a list item element within an unordered list.voidmonospaced()Starts a monospaced element.voidmonospaced_()Ends a monospaced element.voidnonBreakingSpace()Adding a non breaking space, ie a space without any special formatting operations.voidnumberedList(int numbering)Starts an ordered list element.voidnumberedList_()Ends an ordered list element.voidnumberedListItem()Starts a list item element within an ordered list.voidnumberedListItem_()Ends a list item element within an ordered list.voidpageBreak()Adding a new page separator.voidparagraph()Starts an element which represents a paragraph.voidparagraph_()Ends a paragraph element.voidrawText(java.lang.String text)Adding a raw text, ie a text without any special formatting operations.voidsection1()Starts a first heading element which contains the topic of the section.voidsection1_()Ends a first heading element.voidsection2()Starts a second heading element which contains the topic of the section.voidsection2_()Ends a second heading element.voidsection3()Starts a third heading element which contains the topic of the section.voidsection3_()Ends a third heading element.voidsection4()Starts a 4th heading element which contains the topic of the section.voidsection4_()Ends a 4th heading element.voidsection5()Starts a 5th heading element which contains the topic of the section.voidsection5_()Ends a 5th heading element.voidsectionTitle()Starts a title heading element.voidsectionTitle_()Ends a title heading element.voidsectionTitle1()Starts a first title heading element.voidsectionTitle1_()Ends a first title heading element.voidsectionTitle2()Starts a second title heading element.voidsectionTitle2_()Ends a second title heading element.voidsectionTitle3()Starts a third title heading element.voidsectionTitle3_()Ends a third title heading element.voidsectionTitle4()Starts a 4th title heading element.voidsectionTitle4_()Ends a 4th title heading element.voidsectionTitle5()Starts a 5th title heading element.voidsectionTitle5_()Ends a 5th title heading element.voidsetClassLoader(java.lang.ClassLoader cl)Set a new class loadervoidtable()Starts a table element for marking up tabular information in a document.voidtable_()Ends a table element.voidtableCaption()Starts a caption element of a table.voidtableCaption_()Ends a caption element of a table.voidtableCell()Starts a cell element which defines a cell that contains data.voidtableCell(java.lang.String width)Starts a cell element which defines a cell that contains data.voidtableCell_()Ends a cell element.voidtableHeaderCell()Starts a cell element which defines a cell that contains header information.voidtableHeaderCell(java.lang.String width)Starts a cell element which defines a cell that contains header information.voidtableHeaderCell_()Ends a cell header element.voidtableRow()Starts a row element which acts as a container for a row of table cells.voidtableRow_()Ends a row element.voidtableRows(int[] justification, boolean grid)Starts an element that contains rows of table data.voidtableRows_()Ends an element that contains rows of table data.voidtext(java.lang.String text)Adding a text.voidtitle()Starts the title element.voidtitle_()Ends the title element.voidunknown(java.lang.String name, java.lang.Object[] requiredParams, SinkEventAttributes attributes)Add an unknown event.voidverbatim(boolean boxed)Starts an element which indicates that whitespace in the enclosed text has semantic relevance.voidverbatim_()Ends a verbatim element.protected voidwrite(java.lang.String aString)Convenience method to write a String-
Methods inherited from class org.apache.maven.doxia.sink.impl.AbstractXmlSink
getNameSpace, setInsertNewline, setNameSpace, writeEndTag, writeEOL, writeSimpleTag, writeSimpleTag, writeStartTag, writeStartTag, writeStartTag
-
Methods inherited from class org.apache.maven.doxia.sink.impl.SinkAdapter
anchor, author, body, comment, date, definedTerm, definition, definitionList, definitionListItem, figure, figureCaption, figureGraphics, head, horizontalRule, lineBreak, link, list, listItem, numberedList, numberedListItem, paragraph, section, section_, section6, section6_, sectionTitle, sectionTitle_, sectionTitle6, sectionTitle6_, table, tableCaption, tableCell, tableHeaderCell, tableRow, text, title, verbatim
-
Methods inherited from class org.apache.maven.doxia.sink.impl.AbstractSink
enableLogging, getLog, unifyEOLs
-
-
-
-
Field Detail
-
DTD
public static final java.lang.String DTD
This is the place where the iText DTD is located. IMPORTANT: this DTD is not uptodate!- See Also:
- Constant Field Values
-
DOCTYPE
public static final java.lang.String DOCTYPE
This is the reference to the DTD.- See Also:
- Constant Field Values
-
DEFAULT_CHAPTER_TITLE_LEADING
public static final java.lang.String DEFAULT_CHAPTER_TITLE_LEADING
This is the default leading for chapter title- See Also:
- Constant Field Values
-
DEFAULT_SECTION_TITLE_LEADING
public static final java.lang.String DEFAULT_SECTION_TITLE_LEADING
This is the default leading for section title- See Also:
- Constant Field Values
-
-
Constructor Detail
-
ITextSink
protected ITextSink(java.io.Writer writer)
Constructor for ITextSink.
- Parameters:
writer- the writer.
-
ITextSink
protected ITextSink(java.io.Writer writer, java.lang.String encoding)Constructor for ITextSink.
- Parameters:
writer- the writer.encoding- the encoding.- Since:
- 1.1
-
ITextSink
protected ITextSink(org.codehaus.plexus.util.xml.PrettyPrintXMLWriter xmlWriter)
Constructor for ITextSink.
- Parameters:
xmlWriter- a pretty-printing xml writer.
-
-
Method Detail
-
getClassLoader
public java.lang.ClassLoader getClassLoader()
Get the current classLoader- Returns:
- the current class loader
-
setClassLoader
public void setClassLoader(java.lang.ClassLoader cl)
Set a new class loader- Parameters:
cl- the class loader.
-
close
public void close()
Close the writer or the stream, if needed. Closing a previously-closed Sink has no effect.- Specified by:
closein interfaceSink- Overrides:
closein classSinkAdapter
-
flush
public void flush()
Flush the writer or the stream, if needed. Flushing a previously-flushed Sink has no effect.- Specified by:
flushin interfaceSink- Overrides:
flushin classSinkAdapter
-
head_
public void head_()
Ends the head element.- Specified by:
head_in interfaceSink- Overrides:
head_in classSinkAdapter
-
head
public void head()
Starts the head element.- Specified by:
headin interfaceSink- Overrides:
headin classSinkAdapter- See Also:
Sink.head(SinkEventAttributes)
-
author_
public void author_()
Ends an author element.- Specified by:
author_in interfaceSink- Overrides:
author_in classSinkAdapter
-
author
public void author()
Starts an author element.- Specified by:
authorin interfaceSink- Overrides:
authorin classSinkAdapter- See Also:
Sink.author(SinkEventAttributes)
-
date_
public void date_()
Ends the date element.- Specified by:
date_in interfaceSink- Overrides:
date_in classSinkAdapter
-
date
public void date()
Starts the date element.
The date is recommended (but it is not a requirement) to be align to the ISO-8601 standard, i.e.:YYYY-MM-DD
where- YYYY is the year in the Gregorian calendar
- MM is the month of the year between 01 (January) and 12 (December)
- and DD is the day of the month between 01 and 31
- Specified by:
datein interfaceSink- Overrides:
datein classSinkAdapter- See Also:
Sink.date(SinkEventAttributes)
-
title_
public void title_()
Ends the title element.- Specified by:
title_in interfaceSink- Overrides:
title_in classSinkAdapter
-
title
public void title()
Starts the title element.- Specified by:
titlein interfaceSink- Overrides:
titlein classSinkAdapter- See Also:
Sink.title(SinkEventAttributes)
-
body_
public void body_()
Ends the body element.- Specified by:
body_in interfaceSink- Overrides:
body_in classSinkAdapter
-
body
public void body()
Starts the body of a document.- Specified by:
bodyin interfaceSink- Overrides:
bodyin classSinkAdapter- See Also:
Sink.body(SinkEventAttributes)
-
sectionTitle
public void sectionTitle()
Starts a title heading element.- Specified by:
sectionTitlein interfaceSink- Overrides:
sectionTitlein classSinkAdapter
-
sectionTitle_
public void sectionTitle_()
Ends a title heading element.- Specified by:
sectionTitle_in interfaceSink- Overrides:
sectionTitle_in classSinkAdapter
-
section1_
public void section1_()
Ends a first heading element.- Specified by:
section1_in interfaceSink- Overrides:
section1_in classSinkAdapter
-
section1
public void section1()
Starts a first heading element which contains the topic of the section.- Specified by:
section1in interfaceSink- Overrides:
section1in classSinkAdapter- See Also:
Sink.section(int,SinkEventAttributes)
-
sectionTitle1_
public void sectionTitle1_()
Ends a first title heading element.- Specified by:
sectionTitle1_in interfaceSink- Overrides:
sectionTitle1_in classSinkAdapter
-
sectionTitle1
public void sectionTitle1()
Starts a first title heading element. This element is optional, but if it exists, it has to be contained, and be the first element, within aSink.section1()element.- Specified by:
sectionTitle1in interfaceSink- Overrides:
sectionTitle1in classSinkAdapter- See Also:
Sink.sectionTitle(int,SinkEventAttributes)
-
section2_
public void section2_()
Ends a second heading element.- Specified by:
section2_in interfaceSink- Overrides:
section2_in classSinkAdapter
-
section2
public void section2()
Starts a second heading element which contains the topic of the section. This has to be contained within aSink.section1()element.- Specified by:
section2in interfaceSink- Overrides:
section2in classSinkAdapter- See Also:
Sink.section(int,SinkEventAttributes)
-
sectionTitle2_
public void sectionTitle2_()
Ends a second title heading element.- Specified by:
sectionTitle2_in interfaceSink- Overrides:
sectionTitle2_in classSinkAdapter
-
sectionTitle2
public void sectionTitle2()
Starts a second title heading element. This element is optional, but if it exists, it has to be contained, and be the first element, within aSink.section2()element.- Specified by:
sectionTitle2in interfaceSink- Overrides:
sectionTitle2in classSinkAdapter- See Also:
Sink.sectionTitle(int,SinkEventAttributes)
-
section3_
public void section3_()
Ends a third heading element.- Specified by:
section3_in interfaceSink- Overrides:
section3_in classSinkAdapter
-
section3
public void section3()
Starts a third heading element which contains the topic of the section. This has to be contained within aSink.section2()element.- Specified by:
section3in interfaceSink- Overrides:
section3in classSinkAdapter- See Also:
Sink.section(int,SinkEventAttributes)
-
sectionTitle3_
public void sectionTitle3_()
Ends a third title heading element.- Specified by:
sectionTitle3_in interfaceSink- Overrides:
sectionTitle3_in classSinkAdapter
-
sectionTitle3
public void sectionTitle3()
Starts a third title heading element. This element is optional, but if it exists, it has to be contained, and be the first element, within aSink.section3()element.- Specified by:
sectionTitle3in interfaceSink- Overrides:
sectionTitle3in classSinkAdapter- See Also:
Sink.sectionTitle(int,SinkEventAttributes)
-
section4_
public void section4_()
Ends a 4th heading element.- Specified by:
section4_in interfaceSink- Overrides:
section4_in classSinkAdapter
-
section4
public void section4()
Starts a 4th heading element which contains the topic of the section. This has to be contained within aSink.section3()element.- Specified by:
section4in interfaceSink- Overrides:
section4in classSinkAdapter- See Also:
Sink.section(int,SinkEventAttributes)
-
sectionTitle4_
public void sectionTitle4_()
Ends a 4th title heading element.- Specified by:
sectionTitle4_in interfaceSink- Overrides:
sectionTitle4_in classSinkAdapter
-
sectionTitle4
public void sectionTitle4()
Starts a 4th title heading element. This element is optional, but if it exists, it has to be contained, and be the first element, within aSink.section4()element.- Specified by:
sectionTitle4in interfaceSink- Overrides:
sectionTitle4in classSinkAdapter- See Also:
Sink.sectionTitle(int,SinkEventAttributes)
-
section5_
public void section5_()
Ends a 5th heading element.- Specified by:
section5_in interfaceSink- Overrides:
section5_in classSinkAdapter
-
section5
public void section5()
Starts a 5th heading element which contains the topic of the section. This has to be contained within aSink.section4()element.- Specified by:
section5in interfaceSink- Overrides:
section5in classSinkAdapter- See Also:
Sink.section(int,SinkEventAttributes)
-
sectionTitle5_
public void sectionTitle5_()
Ends a 5th title heading element.- Specified by:
sectionTitle5_in interfaceSink- Overrides:
sectionTitle5_in classSinkAdapter
-
sectionTitle5
public void sectionTitle5()
Starts a 5th title heading element. This element is optional, but if it exists, it has to be contained, and be the first element, within aSink.section5()element.- Specified by:
sectionTitle5in interfaceSink- Overrides:
sectionTitle5in classSinkAdapter- See Also:
Sink.sectionTitle(int,SinkEventAttributes)
-
paragraph_
public void paragraph_()
Ends a paragraph element.- Specified by:
paragraph_in interfaceSink- Overrides:
paragraph_in classSinkAdapter
-
paragraph
public void paragraph()
Starts an element which represents a paragraph.- Specified by:
paragraphin interfaceSink- Overrides:
paragraphin classSinkAdapter- See Also:
Sink.paragraph(SinkEventAttributes)
-
list_
public void list_()
Ends an unordered list element.- Specified by:
list_in interfaceSink- Overrides:
list_in classSinkAdapter
-
list
public void list()
Starts an unordered list element.- Specified by:
listin interfaceSink- Overrides:
listin classSinkAdapter- See Also:
Sink.list(SinkEventAttributes)
-
listItem_
public void listItem_()
Ends a list item element within an unordered list.- Specified by:
listItem_in interfaceSink- Overrides:
listItem_in classSinkAdapter
-
listItem
public void listItem()
Starts a list item element within an unordered list.- Specified by:
listItemin interfaceSink- Overrides:
listItemin classSinkAdapter- See Also:
Sink.listItem(SinkEventAttributes)
-
numberedList_
public void numberedList_()
Ends an ordered list element.- Specified by:
numberedList_in interfaceSink- Overrides:
numberedList_in classSinkAdapter
-
numberedList
public void numberedList(int numbering)
Starts an ordered list element.- Specified by:
numberedListin interfaceSink- Overrides:
numberedListin classSinkAdapter- Parameters:
numbering- the numbering style.- See Also:
Sink.numberedList(int,SinkEventAttributes)
-
numberedListItem_
public void numberedListItem_()
Ends a list item element within an ordered list.- Specified by:
numberedListItem_in interfaceSink- Overrides:
numberedListItem_in classSinkAdapter
-
numberedListItem
public void numberedListItem()
Starts a list item element within an ordered list.- Specified by:
numberedListItemin interfaceSink- Overrides:
numberedListItemin classSinkAdapter- See Also:
Sink.numberedListItem(SinkEventAttributes)
-
definitionList_
public void definitionList_()
Ends a definition list element.- Specified by:
definitionList_in interfaceSink- Overrides:
definitionList_in classSinkAdapter
-
definitionList
public void definitionList()
Starts a definition list element.- Specified by:
definitionListin interfaceSink- Overrides:
definitionListin classSinkAdapter- See Also:
Sink.definitionList(SinkEventAttributes)
-
definedTerm_
public void definedTerm_()
Starts a definition term element within a definition list.- Specified by:
definedTerm_in interfaceSink- Overrides:
definedTerm_in classSinkAdapter
-
definedTerm
public void definedTerm()
Starts a definition term element within a definition list.- Specified by:
definedTermin interfaceSink- Overrides:
definedTermin classSinkAdapter- See Also:
Sink.definedTerm(SinkEventAttributes)
-
definition_
public void definition_()
Ends a definition element within a definition list.- Specified by:
definition_in interfaceSink- Overrides:
definition_in classSinkAdapter
-
definition
public void definition()
Starts a definition element within a definition list.- Specified by:
definitionin interfaceSink- Overrides:
definitionin classSinkAdapter- See Also:
Sink.definition(SinkEventAttributes)
-
definitionListItem_
public void definitionListItem_()
Ends a list item element within a definition list.- Specified by:
definitionListItem_in interfaceSink- Overrides:
definitionListItem_in classSinkAdapter
-
definitionListItem
public void definitionListItem()
Starts a list item element within a definition list.- Specified by:
definitionListItemin interfaceSink- Overrides:
definitionListItemin classSinkAdapter- See Also:
Sink.definitionListItem(SinkEventAttributes)
-
table_
public void table_()
Ends a table element.- Specified by:
table_in interfaceSink- Overrides:
table_in classSinkAdapter
-
table
public void table()
Starts a table element for marking up tabular information in a document.- Specified by:
tablein interfaceSink- Overrides:
tablein classSinkAdapter- See Also:
Sink.table(SinkEventAttributes)
-
tableCaption_
public void tableCaption_()
Ends a caption element of a table.- Specified by:
tableCaption_in interfaceSink- Overrides:
tableCaption_in classSinkAdapter
-
tableCaption
public void tableCaption()
Starts a caption element of a table.- Specified by:
tableCaptionin interfaceSink- Overrides:
tableCaptionin classSinkAdapter- See Also:
Sink.tableCaption(SinkEventAttributes)
-
tableCell_
public void tableCell_()
Ends a cell element.- Specified by:
tableCell_in interfaceSink- Overrides:
tableCell_in classSinkAdapter
-
tableCell
public void tableCell()
Starts a cell element which defines a cell that contains data.- Specified by:
tableCellin interfaceSink- Overrides:
tableCellin classSinkAdapter- See Also:
Sink.tableCell(SinkEventAttributes)
-
tableCell
public void tableCell(java.lang.String width)
Starts a cell element which defines a cell that contains data.- Specified by:
tableCellin interfaceSink- Overrides:
tableCellin classSinkAdapter- Parameters:
width- the size of the cell.
-
tableHeaderCell_
public void tableHeaderCell_()
Ends a cell header element.- Specified by:
tableHeaderCell_in interfaceSink- Overrides:
tableHeaderCell_in classSinkAdapter
-
tableHeaderCell
public void tableHeaderCell()
Starts a cell element which defines a cell that contains header information.- Specified by:
tableHeaderCellin interfaceSink- Overrides:
tableHeaderCellin classSinkAdapter- See Also:
Sink.tableHeaderCell(SinkEventAttributes)
-
tableHeaderCell
public void tableHeaderCell(java.lang.String width)
Starts a cell element which defines a cell that contains header information.- Specified by:
tableHeaderCellin interfaceSink- Overrides:
tableHeaderCellin classSinkAdapter- Parameters:
width- the size of the header cell.
-
tableRow_
public void tableRow_()
Ends a row element.- Specified by:
tableRow_in interfaceSink- Overrides:
tableRow_in classSinkAdapter
-
tableRow
public void tableRow()
Starts a row element which acts as a container for a row of table cells.- Specified by:
tableRowin interfaceSink- Overrides:
tableRowin classSinkAdapter- See Also:
Sink.tableRow(SinkEventAttributes)
-
tableRows_
public void tableRows_()
Ends an element that contains rows of table data.- Specified by:
tableRows_in interfaceSink- Overrides:
tableRows_in classSinkAdapter
-
tableRows
public void tableRows(int[] justification, boolean grid)Starts an element that contains rows of table data.- Specified by:
tableRowsin interfaceSink- Overrides:
tableRowsin classSinkAdapter- Parameters:
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.- See Also:
Sink.table(SinkEventAttributes),Sink.JUSTIFY_CENTER,Sink.JUSTIFY_LEFT,Sink.JUSTIFY_RIGHT
-
verbatim_
public void verbatim_()
Ends a verbatim element.- Specified by:
verbatim_in interfaceSink- Overrides:
verbatim_in classSinkAdapter
-
verbatim
public void verbatim(boolean boxed)
Starts an element which indicates that whitespace in the enclosed text has semantic relevance.- Specified by:
verbatimin interfaceSink- Overrides:
verbatimin classSinkAdapter- Parameters:
boxed- true to add a box, false otherwise
-
figure_
public void figure_()
Ends a basic image embedding element.- Specified by:
figure_in interfaceSink- Overrides:
figure_in classSinkAdapter
-
figure
public void figure()
Starts a basic image embedding element.- Specified by:
figurein interfaceSink- Overrides:
figurein classSinkAdapter- See Also:
Sink.figure(SinkEventAttributes)
-
figureCaption_
public void figureCaption_()
Ends a caption of an image.- Specified by:
figureCaption_in interfaceSink- Overrides:
figureCaption_in classSinkAdapter
-
figureCaption
public void figureCaption()
Starts a caption of an image element.- Specified by:
figureCaptionin interfaceSink- Overrides:
figureCaptionin classSinkAdapter- See Also:
Sink.figureCaption(SinkEventAttributes)
-
figureGraphics
public void figureGraphics(java.lang.String name)
If thenameis a relative link, the internal link will used a System propertyitext.basedir, or the class loader. Adding a source of a graphic.- Specified by:
figureGraphicsin interfaceSink- Overrides:
figureGraphicsin classSinkAdapter- Parameters:
name- the source
-
bold_
public void bold_()
Ends a bold element. Alternatively one may useSink.text(String,SinkEventAttributes)withSTYLEinstead.- Specified by:
bold_in interfaceSink- Overrides:
bold_in classSinkAdapter
-
bold
public void bold()
Starts a bold element. Alternatively one may useSink.text(String,SinkEventAttributes)withSTYLEinstead.- Specified by:
boldin interfaceSink- Overrides:
boldin classSinkAdapter
-
italic_
public void italic_()
Ends an italic element. Alternatively one may useSink.text(String,SinkEventAttributes)withSTYLEinstead.- Specified by:
italic_in interfaceSink- Overrides:
italic_in classSinkAdapter
-
italic
public void italic()
Starts an italic element. Alternatively one may useSink.text(String,SinkEventAttributes)withSTYLEinstead.- Specified by:
italicin interfaceSink- Overrides:
italicin classSinkAdapter
-
monospaced_
public void monospaced_()
Ends a monospaced element. Alternatively one may useSink.text(String,SinkEventAttributes)withSTYLEinstead.- Specified by:
monospaced_in interfaceSink- Overrides:
monospaced_in classSinkAdapter
-
monospaced
public void monospaced()
Starts a monospaced element. Alternatively one may useSink.text(String,SinkEventAttributes)withSTYLEinstead.- Specified by:
monospacedin interfaceSink- Overrides:
monospacedin classSinkAdapter
-
link_
public void link_()
Ends a link element.- Specified by:
link_in interfaceSink- Overrides:
link_in classSinkAdapter
-
link
public void link(java.lang.String name)
Starts an element which defines a link.- Specified by:
linkin interfaceSink- Overrides:
linkin classSinkAdapter- Parameters:
name- the name of the link.- See Also:
Sink.link(String,SinkEventAttributes)
-
anchor_
public void anchor_()
Ends an anchor element.- Specified by:
anchor_in interfaceSink- Overrides:
anchor_in classSinkAdapter
-
anchor
public void anchor(java.lang.String name)
Starts an element which defines an anchor.- Specified by:
anchorin interfaceSink- Overrides:
anchorin classSinkAdapter- Parameters:
name- the name of the anchor.- See Also:
Sink.anchor(String,SinkEventAttributes)
-
lineBreak
public void lineBreak()
Adds a line break.- Specified by:
lineBreakin interfaceSink- Overrides:
lineBreakin classSinkAdapter- See Also:
Sink.lineBreak(SinkEventAttributes)
-
nonBreakingSpace
public void nonBreakingSpace()
Adding a non breaking space, ie a space without any special formatting operations.- Specified by:
nonBreakingSpacein interfaceSink- Overrides:
nonBreakingSpacein classSinkAdapter
-
pageBreak
public void pageBreak()
Adding a new page separator.- Specified by:
pageBreakin interfaceSink- Overrides:
pageBreakin classSinkAdapter
-
horizontalRule
public void horizontalRule()
Adding a separator of sections from a text to each other.- Specified by:
horizontalRulein interfaceSink- Overrides:
horizontalRulein classSinkAdapter- See Also:
Sink.horizontalRule(SinkEventAttributes)
-
rawText
public void rawText(java.lang.String text)
Adding a raw text, ie a text without any special formatting operations.- Specified by:
rawTextin interfaceSink- Overrides:
rawTextin classSinkAdapter- Parameters:
text- The text to write.
-
text
public void text(java.lang.String text)
Adding a text.- Specified by:
textin interfaceSink- Overrides:
textin classSinkAdapter- Parameters:
text- The text to write.- See Also:
Sink.text(String,SinkEventAttributes)
-
unknown
public void unknown(java.lang.String name, java.lang.Object[] requiredParams, SinkEventAttributes attributes)Add an unknown event. This may be used by parsers to notify a general Sink about an event that doesn't fit into any event defined by the Sink API. Depending on the parameters, a Sink may decide whether or not to process the event, emit it as raw text, as a comment, log it, etc. Unkown events just log a warning message but are ignored otherwise.- Specified by:
unknownin interfaceSink- Overrides:
unknownin classSinkAdapter- Parameters:
name- The name of the event.requiredParams- An optional array of required parameters to the event. May benull.attributes- A set ofSinkEventAttributes, may benull.- See Also:
Sink.unknown(String,Object[],SinkEventAttributes)
-
init
protected void init()
This is called inSink.head()or inSink.close(), and can be used to set the sink into a clear state so it can be re-used.- Overrides:
initin classAbstractSink
-
write
protected void write(java.lang.String aString)
Convenience method to write a String- Specified by:
writein classAbstractXmlSink- Parameters:
aString-
-
-