Class RtfSink
java.lang.Object
org.apache.maven.doxia.sink.impl.AbstractSink
org.apache.maven.doxia.sink.impl.SinkAdapter
org.apache.maven.doxia.sink.impl.AbstractTextSink
org.apache.maven.doxia.module.rtf.RtfSink
- All Implemented Interfaces:
LogEnabled,Markup,TextMarkup,Sink
RTF Sink implementation.
- Since:
- 1.0
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescription(package private) static class(package private) class(package private) static class(package private) static class(package private) static class(package private) static class(package private) static class(package private) class(package private) static class(package private) class(package private) static class -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final intprivate doubleprivate RtfSink.Cellprivate static final intprivate static final intprivate intprivate intprivate RtfSink.Contextprivate static final intprivate static final intprivate static final intstatic final doublePaper bottom margin, 2 cmstatic final intConstantDEFAULT_CHAR_SET=0static final intCodepage, 1252static final StringData format, asciistatic final intFont size, 10 ptsstatic final StringImage format, bmpstatic final StringImage type, palettestatic final doublePaper left margin, 2 cmstatic final doublePaper height, 29.7 cmstatic final doublePaper width, 21 cmstatic final intResolution, 72 dpistatic final doublePaper right margin, 2 cmstatic final intSpacing, 10 ptsstatic final doublePaper top margin, 2 cmprivate static final intprivate booleanprotected intprivate booleanprivate booleanprivate Stringprivate Stringprivate Stringstatic final StringConstantIMG_DATA_ASCII="ascii"static final StringConstantIMG_DATA_RAW="raw"static final StringConstantIMG_FORMAT_BMP="bmp"static final StringConstantIMG_FORMAT_WMF="wmf"static final StringConstantIMG_TYPE_PALETTE="palette"static final StringConstantIMG_TYPE_RGB="rgb"protected RtfSink.IndentationKeep track of the closing tags for inline events.private final Vector<RtfSink.Counter> private doubleprivate RtfSink.Lineprivate static final intprivate static final Stringprivate intprivate doubleprivate doubleprivate RtfSink.Paragraphprivate intprivate doubleprivate RtfSink.Rowprivate intprotected RtfSink.Spaceprotected OutputStreamprivate intstatic final intConstantSTYLE_BOLD=2static final intConstantSTYLE_ITALIC=1static final intConstantSTYLE_ROMAN=0static final intConstantSTYLE_TYPEWRITER=3private RtfSink.Tableprivate doubleprivate static final intprivate static final intprivate static final intprivate static final intprivate StringBuilderMap of warn messages with a String as key to describe the error type and a Set as value.protected PrintWriterFields 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, STARFields 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_6Fields inherited from interface org.apache.maven.doxia.markup.TextMarkup
PIPE -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedRtfSink()Constructor for RtfSink.protectedRtfSink(OutputStream output) Constructor for RtfSink.protectedRtfSink(OutputStream output, String encoding) Constructor for RtfSink. -
Method Summary
Modifier and TypeMethodDescriptionvoidStarts an element which defines an anchor.voidanchor_()Ends an anchor element.voidauthor()Starts an author element.voidauthor_()Ends an author element.private voidprivate voidbeginStyle(int style) 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.voidStarts a definition term element within a definition list.voidEnds a definition term element within a definition list.voidStarts a definition element within a definition list.voidEnds a definition element within a definition list.voidStarts a definition list element.voidEnds a definition list element.voidStarts a list item element within a definition list.voidEnds a list item element within a definition list.private voidprivate voidendStyle()private static Stringvoidfigure()Starts a basic image embedding element.voidfigure_()Ends a basic image embedding element.voidStarts a caption of an image element.voidEnds a caption of an image.voidfigureGraphics(String name) Adding a source of a graphic.voidflush()Flush the writer or the stream, if needed.protected FontgetFont(int style, int size) getFont.private Stringvoidhead()Starts the head element.voidhead_()Ends the head element.voidAdding 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.voidinline()Starts an inline element.voidinline(SinkEventAttributes attributes) Starts an inline element.voidinline_()Ends an inline element.voiditalic()Starts an italic element.voiditalic_()Ends an italic element.voidAdds a line break.voidStarts 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.voidEnds a list item element within an unordered list.private voidlogMessage(String key, String msg) If debug mode is enabled, log themsgas is, otherwise add unique msg inwarnMessages.voidStarts a monospaced element.voidEnds a monospaced element.voidAdding a non breaking space, ie a space without any special formatting operations.private static StringvoidnumberedList(int numbering) Starts an ordered list element.voidEnds an ordered list element.voidStarts a list item element within an ordered list.voidEnds a list item element within an ordered list.voidAdding a new page separator.private intvoidStarts an element which represents a paragraph.voidEnds a paragraph element.voidsection1()Starts a first heading element which contains the topic of the section.voidEnds a first heading element.voidsection2()Starts a second heading element which contains the topic of the section.voidEnds a second heading element.voidsection3()Starts a third heading element which contains the topic of the section.voidEnds a third heading element.voidsection4()Starts a 4th heading element which contains the topic of the section.voidEnds a 4th heading element.voidsection5()Starts a 5th heading element which contains the topic of the section.voidEnds a 5th heading element.voidStarts a title heading element.voidEnds a title heading element.private voidsetBorder(boolean bt, boolean bb, boolean bl, boolean br) voidsetBottomMargin(double margin) Setter for the fieldbottomMargin.voidsetCharSet(int cs) Setter for the fieldcharSet.voidsetCodePage(int cp) Setter for the fieldcodePage.voidsetFontSize(int size) Setter for the fieldfontSize.voidsetImageCompression(boolean compression) Setter for the fieldimageCompression.voidsetImageDataFormat(String format) Setter for the fieldimageDataFormat.voidsetImageFormat(String format) Setter for the fieldimageFormat.voidsetImageType(String type) Setter for the fieldimageType.private voidsetJustification(int justification) voidsetLeftMargin(double margin) Setter for the fieldleftMargin.voidsetPaperSize(double width, double height) setPaperSize.voidsetResolution(int resolution) Setter for the fieldresolution.voidsetRightMargin(double margin) Setter for the fieldrightMargin.voidsetSpacing(int spacing) setSpacing.private voidsetStyle(int style) voidsetTopMargin(double margin) Setter for the fieldtopMargin.private intstyleNumber(int level) voidtable()Starts a table element for marking up tabular information in a document.voidtable_()Ends a table element.voidStarts a caption element of a table.voidEnds a caption element of a table.voidStarts a cell element which defines a cell that contains data.voidEnds a cell element.voidStarts a cell element which defines a cell that contains header information.voidEnds a cell header element.voidtableRow()Starts a row element which acts as a container for a row of table cells.voidEnds a row element.voidtableRows(int[] justification, boolean grid) Starts an element that contains rows of table data.voidEnds an element that contains rows of table data.voidAdding a text.private static intvoidtitle()Starts the title element.voidtitle_()Ends the title element.protected inttoTwips(double length, int unit) toTwips.voidunknown(String name, 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.voidEnds a verbatim element.private voidwriteImage(String source) Methods inherited from class org.apache.maven.doxia.sink.impl.SinkAdapter
address, address, address_, anchor, article, article, article_, author, blockquote, blockquote, blockquote_, body, comment, content, content, content_, data, data, data_, date, definedTerm, definition, definitionList, definitionListItem, division, division, division_, figure, figureCaption, figureGraphics, footer, footer, footer_, head, header, header, header_, horizontalRule, lineBreak, lineBreakOpportunity, lineBreakOpportunity, link, list, listItem, navigation, navigation, navigation_, numberedList, numberedListItem, paragraph, rawText, section, section_, section6, section6_, sectionTitle, sectionTitle_, sectionTitle1, sectionTitle1_, sectionTitle2, sectionTitle2_, sectionTitle3, sectionTitle3_, sectionTitle4, sectionTitle4_, sectionTitle5, sectionTitle5_, sectionTitle6, sectionTitle6_, sidebar, sidebar, sidebar_, table, tableCaption, tableCell, tableCell, tableHeaderCell, tableHeaderCell, tableRow, text, time, time, time_, title, verbatimMethods inherited from class org.apache.maven.doxia.sink.impl.AbstractSink
enableLogging, getLog, unifyEOLs
-
Field Details
-
DEFAULT_PAPER_WIDTH
public static final double DEFAULT_PAPER_WIDTHPaper width, 21 cm- See Also:
-
DEFAULT_PAPER_HEIGHT
public static final double DEFAULT_PAPER_HEIGHTPaper height, 29.7 cm- See Also:
-
DEFAULT_TOP_MARGIN
public static final double DEFAULT_TOP_MARGINPaper top margin, 2 cm- See Also:
-
DEFAULT_BOTTOM_MARGIN
public static final double DEFAULT_BOTTOM_MARGINPaper bottom margin, 2 cm- See Also:
-
DEFAULT_LEFT_MARGIN
public static final double DEFAULT_LEFT_MARGINPaper left margin, 2 cm- See Also:
-
DEFAULT_RIGHT_MARGIN
public static final double DEFAULT_RIGHT_MARGINPaper right margin, 2 cm- See Also:
-
DEFAULT_FONT_SIZE
public static final int DEFAULT_FONT_SIZEFont size, 10 pts- See Also:
-
DEFAULT_SPACING
public static final int DEFAULT_SPACINGSpacing, 10 pts- See Also:
-
DEFAULT_RESOLUTION
public static final int DEFAULT_RESOLUTIONResolution, 72 dpi- See Also:
-
DEFAULT_IMAGE_FORMAT
Image format, bmp- See Also:
-
DEFAULT_IMAGE_TYPE
Image type, palette- See Also:
-
DEFAULT_DATA_FORMAT
Data format, ascii- See Also:
-
DEFAULT_CODE_PAGE
public static final int DEFAULT_CODE_PAGECodepage, 1252- See Also:
-
DEFAULT_CHAR_SET
public static final int DEFAULT_CHAR_SETConstantDEFAULT_CHAR_SET=0- See Also:
-
IMG_FORMAT_BMP
ConstantIMG_FORMAT_BMP="bmp"- See Also:
-
IMG_FORMAT_WMF
ConstantIMG_FORMAT_WMF="wmf"- See Also:
-
IMG_TYPE_PALETTE
ConstantIMG_TYPE_PALETTE="palette"- See Also:
-
IMG_TYPE_RGB
ConstantIMG_TYPE_RGB="rgb"- See Also:
-
IMG_DATA_ASCII
ConstantIMG_DATA_ASCII="ascii"- See Also:
-
IMG_DATA_RAW
ConstantIMG_DATA_RAW="raw"- See Also:
-
STYLE_ROMAN
public static final int STYLE_ROMANConstantSTYLE_ROMAN=0- See Also:
-
STYLE_ITALIC
public static final int STYLE_ITALICConstantSTYLE_ITALIC=1- See Also:
-
STYLE_BOLD
public static final int STYLE_BOLDConstantSTYLE_BOLD=2- See Also:
-
STYLE_TYPEWRITER
public static final int STYLE_TYPEWRITERConstantSTYLE_TYPEWRITER=3- See Also:
-
CONTEXT_UNDEFINED
private static final int CONTEXT_UNDEFINED- See Also:
-
CONTEXT_VERBATIM
private static final int CONTEXT_VERBATIM- See Also:
-
CONTEXT_TABLE
private static final int CONTEXT_TABLE- See Also:
-
UNIT_MILLIMETER
private static final int UNIT_MILLIMETER- See Also:
-
UNIT_CENTIMETER
private static final int UNIT_CENTIMETER- See Also:
-
UNIT_INCH
private static final int UNIT_INCH- See Also:
-
UNIT_PIXEL
private static final int UNIT_PIXEL- See Also:
-
LIST_INDENT
private static final int LIST_INDENT- See Also:
-
LIST_ITEM_HEADER
- See Also:
-
DEFINITION_INDENT
private static final int DEFINITION_INDENT- See Also:
-
CELL_HORIZONTAL_PAD
private static final int CELL_HORIZONTAL_PAD- See Also:
-
CELL_VERTICAL_PAD
private static final int CELL_VERTICAL_PAD- See Also:
-
BORDER_WIDTH
private static final int BORDER_WIDTH- See Also:
-
paperWidth
private double paperWidth -
paperHeight
private double paperHeight -
topMargin
private double topMargin -
bottomMargin
private double bottomMargin -
leftMargin
private double leftMargin -
rightMargin
private double rightMargin -
fontSize
protected int fontSize -
resolution
private int resolution -
imageFormat
-
imageType
-
imageDataFormat
-
imageCompression
private boolean imageCompression -
codePage
private int codePage -
charSet
private int charSet -
fontTable
-
context
-
paragraph
-
indentation
-
space
-
listItemIndent
private int listItemIndent -
numbering
-
itemNumber
-
style
private int style -
sectionLevel
private int sectionLevel -
emptyHeader
private boolean emptyHeader -
verbatim
-
frame
private boolean frame -
table
-
row
-
cell
-
line
-
writer
-
stream
-
inlineStack
Keep track of the closing tags for inline events. -
warnMessages
Map of warn messages with a String as key to describe the error type and a Set as value. Using to reduce warn messages.
-
-
Constructor Details
-
RtfSink
Constructor for RtfSink.
- Throws:
IOException- if any.
-
RtfSink
Constructor for RtfSink.
- Parameters:
output- not null- Throws:
IOException- if any.
-
RtfSink
Constructor for RtfSink.
- Parameters:
output- not nullencoding- a valid charset- Throws:
IOException- if any
-
-
Method Details
-
setPaperSize
public void setPaperSize(double width, double height) setPaperSize.- Parameters:
width- in cm.height- in cm.
-
setTopMargin
public void setTopMargin(double margin) Setter for the field
topMargin.- Parameters:
margin- margin.
-
setBottomMargin
public void setBottomMargin(double margin) Setter for the field
bottomMargin.- Parameters:
margin- margin.
-
setLeftMargin
public void setLeftMargin(double margin) Setter for the field
leftMargin.- Parameters:
margin- margin
-
setRightMargin
public void setRightMargin(double margin) Setter for the field
rightMargin.- Parameters:
margin- margin
-
setFontSize
public void setFontSize(int size) Setter for the field
fontSize.- Parameters:
size- in pts
-
setSpacing
public void setSpacing(int spacing) setSpacing.
- Parameters:
spacing- in pts.
-
setResolution
public void setResolution(int resolution) Setter for the field
resolution.- Parameters:
resolution- in dpi
-
setImageFormat
Setter for the field
imageFormat.- Parameters:
format- aStringobject.
-
setImageType
Setter for the field
imageType.- Parameters:
type- aStringobject.
-
setImageDataFormat
Setter for the field
imageDataFormat.- Parameters:
format- aStringobject.
-
setImageCompression
public void setImageCompression(boolean compression) Setter for the field
imageCompression.- Parameters:
compression- a boolean.
-
setCodePage
public void setCodePage(int cp) Setter for the field
codePage.- Parameters:
cp- a int.
-
setCharSet
public void setCharSet(int cs) Setter for the field
charSet.- Parameters:
cs- a int.
-
head
public void head()Starts the head element.- Specified by:
headin interfaceSink- Overrides:
headin classSinkAdapter- See Also:
-
head_
public void head_()Ends the head element.- Specified by:
head_in interfaceSink- Overrides:
head_in classSinkAdapter
-
toTwips
protected int toTwips(double length, int unit) toTwips.
- Parameters:
length- a double.unit- a int.- Returns:
- a int.
-
title
public void title()Starts the title element.- Specified by:
titlein interfaceSink- Overrides:
titlein classSinkAdapter- See Also:
-
title_
public void title_()Ends the title element.- Specified by:
title_in interfaceSink- Overrides:
title_in classSinkAdapter
-
author
public void author()Starts an author element.- Specified by:
authorin interfaceSink- Overrides:
authorin classSinkAdapter- See Also:
-
author_
public void author_()Ends an author element.- Specified by:
author_in interfaceSink- Overrides:
author_in classSinkAdapter
-
date
public void date()Starts the date element.- Specified by:
datein interfaceSink- Overrides:
datein classSinkAdapter- See Also:
-
date_
public void date_()Ends the date element.- Specified by:
date_in interfaceSink- Overrides:
date_in classSinkAdapter
-
body
public void body()Starts the body of a document.- Specified by:
bodyin interfaceSink- Overrides:
bodyin classSinkAdapter- See Also:
-
body_
public void body_()Ends the body element.- Specified by:
body_in interfaceSink- Overrides:
body_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:
-
section1_
public void section1_()Ends a first heading element.- Specified by:
section1_in interfaceSink- Overrides:
section1_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:
-
section2_
public void section2_()Ends a second heading element.- Specified by:
section2_in interfaceSink- Overrides:
section2_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:
-
section3_
public void section3_()Ends a third heading element.- Specified by:
section3_in interfaceSink- Overrides:
section3_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:
-
section4_
public void section4_()Ends a 4th heading element.- Specified by:
section4_in interfaceSink- Overrides:
section4_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:
-
section5_
public void section5_()Ends a 5th heading element.- Specified by:
section5_in interfaceSink- Overrides:
section5_in classSinkAdapter
-
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
-
styleNumber
private int styleNumber(int level) -
list
public void list()Starts an unordered list element.- Specified by:
listin interfaceSink- Overrides:
listin classSinkAdapter- See Also:
-
list_
public void list_()Ends an unordered list element.- Specified by:
list_in interfaceSink- Overrides:
list_in classSinkAdapter
-
listItem
public void listItem()Starts a list item element within an unordered list.- Specified by:
listItemin interfaceSink- Overrides:
listItemin classSinkAdapter- See Also:
-
listItem_
public void listItem_()Ends a list item element within an unordered list.- Specified by:
listItem_in interfaceSink- Overrides:
listItem_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:
-
numberedList_
public void numberedList_()Ends an ordered list element.- Specified by:
numberedList_in interfaceSink- Overrides:
numberedList_in classSinkAdapter
-
numberedListItem
public void numberedListItem()Starts a list item element within an ordered list.- Specified by:
numberedListItemin interfaceSink- Overrides:
numberedListItemin classSinkAdapter- See Also:
-
numberedListItem_
public void numberedListItem_()Ends a list item element within an ordered list.- Specified by:
numberedListItem_in interfaceSink- Overrides:
numberedListItem_in classSinkAdapter
-
getItemHeader
-
definitionList
public void definitionList()Starts a definition list element.- Specified by:
definitionListin interfaceSink- Overrides:
definitionListin classSinkAdapter- See Also:
-
definitionList_
public void definitionList_()Ends a definition list element.- Specified by:
definitionList_in interfaceSink- Overrides:
definitionList_in classSinkAdapter
-
definitionListItem
public void definitionListItem()Starts a list item element within a definition list.- Specified by:
definitionListItemin interfaceSink- Overrides:
definitionListItemin classSinkAdapter- See Also:
-
definitionListItem_
public void definitionListItem_()Ends a list item element within a definition list.- Specified by:
definitionListItem_in interfaceSink- Overrides:
definitionListItem_in classSinkAdapter
-
definedTerm
public void definedTerm()Starts a definition term element within a definition list.- Specified by:
definedTermin interfaceSink- Overrides:
definedTermin classSinkAdapter- See Also:
-
definedTerm_
public void definedTerm_()Ends a definition term element within a definition list.- Specified by:
definedTerm_in interfaceSink- Overrides:
definedTerm_in classSinkAdapter
-
definition
public void definition()Starts a definition element within a definition list.- Specified by:
definitionin interfaceSink- Overrides:
definitionin classSinkAdapter- See Also:
-
definition_
public void definition_()Ends a definition element within a definition list.- Specified by:
definition_in interfaceSink- Overrides:
definition_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:
-
table_
public void table_()Ends a table element.- Specified by:
table_in interfaceSink- Overrides:
table_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:
-
tableRows_
public void tableRows_()Ends an element that contains rows of table data.- Specified by:
tableRows_in interfaceSink- Overrides:
tableRows_in classSinkAdapter
-
pageWidth
private int pageWidth() -
setBorder
private void setBorder(boolean bt, boolean bb, boolean bl, boolean br) -
setJustification
private void setJustification(int justification) -
setStyle
private void setStyle(int style) -
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:
-
tableRow_
public void tableRow_()Ends a row element.- Specified by:
tableRow_in interfaceSink- Overrides:
tableRow_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:
-
tableHeaderCell_
public void tableHeaderCell_()Ends a cell header element.- Specified by:
tableHeaderCell_in interfaceSink- Overrides:
tableHeaderCell_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:
-
tableCell_
public void tableCell_()Ends a cell element.- Specified by:
tableCell_in interfaceSink- Overrides:
tableCell_in classSinkAdapter
-
tableCaption
public void tableCaption()Starts a caption element of a table.- Specified by:
tableCaptionin interfaceSink- Overrides:
tableCaptionin classSinkAdapter- See Also:
-
tableCaption_
public void tableCaption_()Ends a caption element of a table.- Specified by:
tableCaption_in interfaceSink- Overrides:
tableCaption_in classSinkAdapter
-
paragraph
public void paragraph()Starts an element which represents a paragraph.- Specified by:
paragraphin interfaceSink- Overrides:
paragraphin classSinkAdapter- See Also:
-
paragraph_
public void paragraph_()Ends a paragraph element.- Specified by:
paragraph_in interfaceSink- Overrides:
paragraph_in classSinkAdapter
-
beginParagraph
-
endParagraph
private void endParagraph() -
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
-
verbatim_
public void verbatim_()Ends a verbatim element.- Specified by:
verbatim_in interfaceSink- Overrides:
verbatim_in classSinkAdapter
-
figure
public void figure()Starts a basic image embedding element.- Specified by:
figurein interfaceSink- Overrides:
figurein classSinkAdapter- See Also:
-
figure_
public void figure_()Ends a basic image embedding element.- Specified by:
figure_in interfaceSink- Overrides:
figure_in classSinkAdapter
-
figureGraphics
Adding a source of a graphic.- Specified by:
figureGraphicsin interfaceSink- Overrides:
figureGraphicsin classSinkAdapter- Parameters:
name- the source
-
writeImage
- Throws:
Exception
-
figureCaption
public void figureCaption()Starts a caption of an image element.- Specified by:
figureCaptionin interfaceSink- Overrides:
figureCaptionin classSinkAdapter- See Also:
-
figureCaption_
public void figureCaption_()Ends a caption of an image.- Specified by:
figureCaption_in interfaceSink- Overrides:
figureCaption_in 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:
-
pageBreak
public void pageBreak()Adding a new page separator.- Specified by:
pageBreakin interfaceSink- Overrides:
pageBreakin classSinkAdapter
-
anchor
Starts an element which defines an anchor.- Specified by:
anchorin interfaceSink- Overrides:
anchorin classSinkAdapter- Parameters:
name- the name of the anchor.- See Also:
-
anchor_
public void anchor_()Ends an anchor element.- Specified by:
anchor_in interfaceSink- Overrides:
anchor_in classSinkAdapter
-
link
Starts an element which defines a link.- Specified by:
linkin interfaceSink- Overrides:
linkin classSinkAdapter- Parameters:
name- the name of the link.- See Also:
-
link_
public void link_()Ends a link element.- Specified by:
link_in interfaceSink- Overrides:
link_in classSinkAdapter
-
inline
public void inline()Starts an inline element.- Specified by:
inlinein interfaceSink- Overrides:
inlinein classSinkAdapter- See Also:
-
inline
Starts an inline element.The inline method is similar to
Sink.text(String,SinkEventAttributes), but allows you to wrap arbitrary elements in addition to text.Supported attributes are the
base attributesplusSEMANTICS(values "emphasis", "strong", "small", "line-through", "citation", "quote", "definition", "abbreviation", "italic", "bold", "monospaced", "variable", "sample", "keyboard", "superscript", "subscript", "annotation", "highlight", "ruby", "rubyBase", "rubyText", "rubyTextContainer", "rubyParentheses", "bidirectionalIsolation", "bidirectionalOverride", "phrase", "insert", "delete").- Specified by:
inlinein interfaceSink- Overrides:
inlinein classSinkAdapter- Parameters:
attributes- A set ofSinkEventAttributes, may benull.
-
inline_
public void inline_()Ends an inline element.- Specified by:
inline_in interfaceSink- Overrides:
inline_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
-
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
-
bold
public void bold()Starts a bold element. Alternatively one may useSink.text(String,SinkEventAttributes)withSTYLEinstead.- Specified by:
boldin interfaceSink- Overrides:
boldin classSinkAdapter
-
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
-
monospaced
public void monospaced()Starts a monospaced element. Alternatively one may useSink.text(String,SinkEventAttributes)withSTYLEinstead.- Specified by:
monospacedin interfaceSink- Overrides:
monospacedin 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
-
beginStyle
private void beginStyle(int style) -
endStyle
private void endStyle() -
lineBreak
public void lineBreak()Adds a line break.- Specified by:
lineBreakin interfaceSink- Overrides:
lineBreakin classSinkAdapter- See Also:
-
nonBreakingSpace
public void nonBreakingSpace()Adding a non breaking space, ie a space without any special formatting operations.- Specified by:
nonBreakingSpacein interfaceSink- Overrides:
nonBreakingSpacein classSinkAdapter
-
text
Adding a text.- Specified by:
textin interfaceSink- Overrides:
textin classSinkAdapter- Parameters:
text- The text to write.- See Also:
-
unknown
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:
-
normalize
-
escape
-
getFont
getFont.
- Parameters:
style- a int.size- a int.- Returns:
- a
Fontobject.
-
textWidth
-
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
-
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
-
logMessage
If debug mode is enabled, log themsgas is, otherwise add unique msg inwarnMessages.- Parameters:
key- not nullmsg- not null- Since:
- 1.1.1
- See Also:
-
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
-